a39e453c1731da79ca55fde0f3c1397840efd05c
[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                 if msg.minimum_depth == 0 {
1492                         // Note that if this changes we should update the serialization minimum version to
1493                         // indicate to older clients that they don't understand some features of the current
1494                         // channel.
1495                         return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1496                 }
1497
1498                 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1499                         match &msg.shutdown_scriptpubkey {
1500                                 &OptionalField::Present(ref script) => {
1501                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1502                                         if script.len() == 0 {
1503                                                 None
1504                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1505                                         } else if is_unsupported_shutdown_script(&their_features, script) {
1506                                                 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
1507                                         } else {
1508                                                 Some(script.clone())
1509                                         }
1510                                 },
1511                                 // 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
1512                                 &OptionalField::Absent => {
1513                                         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()));
1514                                 }
1515                         }
1516                 } else { None };
1517
1518                 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1519                 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1520                 self.counterparty_selected_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1521                 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1522                 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1523                 self.minimum_depth = msg.minimum_depth;
1524
1525                 let counterparty_pubkeys = ChannelPublicKeys {
1526                         funding_pubkey: msg.funding_pubkey,
1527                         revocation_basepoint: msg.revocation_basepoint,
1528                         payment_point: msg.payment_point,
1529                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1530                         htlc_basepoint: msg.htlc_basepoint
1531                 };
1532
1533                 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1534                         selected_contest_delay: msg.to_self_delay,
1535                         pubkeys: counterparty_pubkeys,
1536                 });
1537
1538                 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1539                 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1540
1541                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1542
1543                 Ok(())
1544         }
1545
1546         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1547                 let funding_script = self.get_funding_redeemscript();
1548
1549                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1550                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1551                 {
1552                         let trusted_tx = initial_commitment_tx.trust();
1553                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1554                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1555                         // They sign the holder commitment transaction...
1556                         log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1557                                 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1558                                 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1559                                 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1560                         secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1561                 }
1562
1563                 let counterparty_keys = self.build_remote_transaction_keys()?;
1564                 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;
1565
1566                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1567                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1568                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1569                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1570
1571                 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1572                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1573
1574                 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1575                 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1576         }
1577
1578         fn counterparty_funding_pubkey(&self) -> &PublicKey {
1579                 &self.get_counterparty_pubkeys().funding_pubkey
1580         }
1581
1582         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 {
1583                 if self.is_outbound() {
1584                         return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1585                 }
1586                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1587                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1588                         // remember the channel, so it's safe to just send an error_message here and drop the
1589                         // channel.
1590                         return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1591                 }
1592                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1593                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1594                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1595                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1596                 }
1597
1598                 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1599                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1600                 // This is an externally observable change before we finish all our checks.  In particular
1601                 // funding_created_signature may fail.
1602                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1603
1604                 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1605                         Ok(res) => res,
1606                         Err(ChannelError::Close(e)) => {
1607                                 self.channel_transaction_parameters.funding_outpoint = None;
1608                                 return Err(ChannelError::Close(e));
1609                         },
1610                         Err(e) => {
1611                                 // The only error we know how to handle is ChannelError::Close, so we fall over here
1612                                 // to make sure we don't continue with an inconsistent state.
1613                                 panic!("unexpected error type from funding_created_signature {:?}", e);
1614                         }
1615                 };
1616
1617                 let holder_commitment_tx = HolderCommitmentTransaction::new(
1618                         initial_commitment_tx,
1619                         msg.signature,
1620                         Vec::new(),
1621                         &self.get_holder_pubkeys().funding_pubkey,
1622                         self.counterparty_funding_pubkey()
1623                 );
1624
1625                 // Now that we're past error-generating stuff, update our local state:
1626
1627                 let funding_redeemscript = self.get_funding_redeemscript();
1628                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1629                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1630                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1631                                                           &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1632                                                           &self.destination_script, (funding_txo, funding_txo_script.clone()),
1633                                                           &self.channel_transaction_parameters,
1634                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
1635                                                           obscure_factor,
1636                                                           holder_commitment_tx, best_block);
1637
1638                 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);
1639
1640                 self.channel_state = ChannelState::FundingSent as u32;
1641                 self.channel_id = funding_txo.to_channel_id();
1642                 self.cur_counterparty_commitment_transaction_number -= 1;
1643                 self.cur_holder_commitment_transaction_number -= 1;
1644
1645                 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1646
1647                 Ok((msgs::FundingSigned {
1648                         channel_id: self.channel_id,
1649                         signature
1650                 }, channel_monitor))
1651         }
1652
1653         /// Handles a funding_signed message from the remote end.
1654         /// If this call is successful, broadcast the funding transaction (and not before!)
1655         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 {
1656                 if !self.is_outbound() {
1657                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1658                 }
1659                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1660                         return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1661                 }
1662                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1663                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1664                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1665                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1666                 }
1667
1668                 let funding_script = self.get_funding_redeemscript();
1669
1670                 let counterparty_keys = self.build_remote_transaction_keys()?;
1671                 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;
1672                 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1673                 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1674
1675                 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1676                         log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1677
1678                 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1679                 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1680                 {
1681                         let trusted_tx = initial_commitment_tx.trust();
1682                         let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1683                         let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1684                         // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1685                         if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1686                                 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1687                         }
1688                 }
1689
1690                 let holder_commitment_tx = HolderCommitmentTransaction::new(
1691                         initial_commitment_tx,
1692                         msg.signature,
1693                         Vec::new(),
1694                         &self.get_holder_pubkeys().funding_pubkey,
1695                         self.counterparty_funding_pubkey()
1696                 );
1697
1698
1699                 let funding_redeemscript = self.get_funding_redeemscript();
1700                 let funding_txo = self.get_funding_txo().unwrap();
1701                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1702                 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1703                 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1704                                                           &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1705                                                           &self.destination_script, (funding_txo, funding_txo_script),
1706                                                           &self.channel_transaction_parameters,
1707                                                           funding_redeemscript.clone(), self.channel_value_satoshis,
1708                                                           obscure_factor,
1709                                                           holder_commitment_tx, best_block);
1710
1711                 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);
1712
1713                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1714                 self.channel_state = ChannelState::FundingSent as u32;
1715                 self.cur_holder_commitment_transaction_number -= 1;
1716                 self.cur_counterparty_commitment_transaction_number -= 1;
1717
1718                 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1719
1720                 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1721         }
1722
1723         pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1724                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1725                         self.workaround_lnd_bug_4006 = Some(msg.clone());
1726                         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()));
1727                 }
1728
1729                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1730
1731                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1732                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1733                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1734                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1735                         self.update_time_counter += 1;
1736                 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1737                                  // Note that funding_signed/funding_created will have decremented both by 1!
1738                                  self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1739                                  self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1740                                 // If we reconnected before sending our funding locked they may still resend theirs:
1741                                 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1742                                                       (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1743                         if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1744                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1745                         }
1746                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1747                         return Ok(());
1748                 } else {
1749                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1750                 }
1751
1752                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1753                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1754
1755                 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1756
1757                 Ok(())
1758         }
1759
1760         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1761         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1762                 let mut htlc_inbound_value_msat = 0;
1763                 for ref htlc in self.pending_inbound_htlcs.iter() {
1764                         htlc_inbound_value_msat += htlc.amount_msat;
1765                 }
1766                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1767         }
1768
1769         /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1770         /// holding cell.
1771         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1772                 let mut htlc_outbound_value_msat = 0;
1773                 for ref htlc in self.pending_outbound_htlcs.iter() {
1774                         htlc_outbound_value_msat += htlc.amount_msat;
1775                 }
1776
1777                 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1778                 for update in self.holding_cell_htlc_updates.iter() {
1779                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1780                                 htlc_outbound_count += 1;
1781                                 htlc_outbound_value_msat += amount_msat;
1782                         }
1783                 }
1784
1785                 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1786         }
1787
1788         /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1789         /// Doesn't bother handling the
1790         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1791         /// corner case properly.
1792         pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1793                 // Note that we have to handle overflow due to the above case.
1794                 (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,
1795                 cmp::max(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1796         }
1797
1798         // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1799         // Note that num_htlcs should not include dust HTLCs.
1800         fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1801                 // Note that we need to divide before multiplying to round properly,
1802                 // since the lowest denomination of bitcoin on-chain is the satoshi.
1803                 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1804         }
1805
1806         // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1807         // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1808         // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1809         // are excluded.
1810         fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1811                 assert!(self.is_outbound());
1812
1813                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1814                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1815
1816                 let mut addl_htlcs = 0;
1817                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1818                 match htlc.origin {
1819                         HTLCInitiator::LocalOffered => {
1820                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1821                                         addl_htlcs += 1;
1822                                 }
1823                         },
1824                         HTLCInitiator::RemoteOffered => {
1825                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1826                                         addl_htlcs += 1;
1827                                 }
1828                         }
1829                 }
1830
1831                 let mut included_htlcs = 0;
1832                 for ref htlc in self.pending_inbound_htlcs.iter() {
1833                         if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1834                                 continue
1835                         }
1836                         // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1837                         // transaction including this HTLC if it times out before they RAA.
1838                         included_htlcs += 1;
1839                 }
1840
1841                 for ref htlc in self.pending_outbound_htlcs.iter() {
1842                         if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1843                                 continue
1844                         }
1845                         match htlc.state {
1846                                 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1847                                 OutboundHTLCState::Committed => included_htlcs += 1,
1848                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1849                                 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1850                                 // transaction won't be generated until they send us their next RAA, which will mean
1851                                 // dropping any HTLCs in this state.
1852                                 _ => {},
1853                         }
1854                 }
1855
1856                 for htlc in self.holding_cell_htlc_updates.iter() {
1857                         match htlc {
1858                                 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1859                                         if amount_msat / 1000 < real_dust_limit_timeout_sat {
1860                                                 continue
1861                                         }
1862                                         included_htlcs += 1
1863                                 },
1864                                 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1865                                          // ack we're guaranteed to never include them in commitment txs anymore.
1866                         }
1867                 }
1868
1869                 let num_htlcs = included_htlcs + addl_htlcs;
1870                 let res = self.commit_tx_fee_msat(num_htlcs);
1871                 #[cfg(any(test, feature = "fuzztarget"))]
1872                 {
1873                         let mut fee = res;
1874                         if fee_spike_buffer_htlc.is_some() {
1875                                 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1876                         }
1877                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1878                                 + self.holding_cell_htlc_updates.len();
1879                         let commitment_tx_info = CommitmentTxInfoCached {
1880                                 fee,
1881                                 total_pending_htlcs,
1882                                 next_holder_htlc_id: match htlc.origin {
1883                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1884                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1885                                 },
1886                                 next_counterparty_htlc_id: match htlc.origin {
1887                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1888                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1889                                 },
1890                                 feerate: self.feerate_per_kw,
1891                         };
1892                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1893                 }
1894                 res
1895         }
1896
1897         // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1898         // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1899         // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1900         // excluded.
1901         fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1902                 assert!(!self.is_outbound());
1903
1904                 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1905                 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1906
1907                 let mut addl_htlcs = 0;
1908                 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1909                 match htlc.origin {
1910                         HTLCInitiator::LocalOffered => {
1911                                 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1912                                         addl_htlcs += 1;
1913                                 }
1914                         },
1915                         HTLCInitiator::RemoteOffered => {
1916                                 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1917                                         addl_htlcs += 1;
1918                                 }
1919                         }
1920                 }
1921
1922                 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
1923                 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
1924                 // committed outbound HTLCs, see below.
1925                 let mut included_htlcs = 0;
1926                 for ref htlc in self.pending_inbound_htlcs.iter() {
1927                         if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
1928                                 continue
1929                         }
1930                         included_htlcs += 1;
1931                 }
1932
1933                 for ref htlc in self.pending_outbound_htlcs.iter() {
1934                         if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
1935                                 continue
1936                         }
1937                         // We only include outbound HTLCs if it will not be included in their next commitment_signed,
1938                         // i.e. if they've responded to us with an RAA after announcement.
1939                         match htlc.state {
1940                                 OutboundHTLCState::Committed => included_htlcs += 1,
1941                                 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1942                                 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
1943                                 _ => {},
1944                         }
1945                 }
1946
1947                 let num_htlcs = included_htlcs + addl_htlcs;
1948                 let res = self.commit_tx_fee_msat(num_htlcs);
1949                 #[cfg(any(test, feature = "fuzztarget"))]
1950                 {
1951                         let mut fee = res;
1952                         if fee_spike_buffer_htlc.is_some() {
1953                                 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1954                         }
1955                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1956                         let commitment_tx_info = CommitmentTxInfoCached {
1957                                 fee,
1958                                 total_pending_htlcs,
1959                                 next_holder_htlc_id: match htlc.origin {
1960                                         HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1961                                         HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1962                                 },
1963                                 next_counterparty_htlc_id: match htlc.origin {
1964                                         HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1965                                         HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1966                                 },
1967                                 feerate: self.feerate_per_kw,
1968                         };
1969                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1970                 }
1971                 res
1972         }
1973
1974         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>
1975         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
1976                 // We can't accept HTLCs sent after we've sent a shutdown.
1977                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1978                 if local_sent_shutdown {
1979                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
1980                 }
1981                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
1982                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1983                 if remote_sent_shutdown {
1984                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
1985                 }
1986                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1987                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
1988                 }
1989                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1990                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
1991                 }
1992                 if msg.amount_msat == 0 {
1993                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
1994                 }
1995                 if msg.amount_msat < self.holder_htlc_minimum_msat {
1996                         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)));
1997                 }
1998
1999                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
2000                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
2001                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2002                 }
2003                 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2004                 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2005                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2006                 }
2007                 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2008                 // the reserve_satoshis we told them to always have as direct payment so that they lose
2009                 // something if we punish them for broadcasting an old state).
2010                 // Note that we don't really care about having a small/no to_remote output in our local
2011                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2012                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2013                 // present in the next commitment transaction we send them (at least for fulfilled ones,
2014                 // failed ones won't modify value_to_self).
2015                 // Note that we will send HTLCs which another instance of rust-lightning would think
2016                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2017                 // Channel state once they will not be present in the next received commitment
2018                 // transaction).
2019                 let mut removed_outbound_total_msat = 0;
2020                 for ref htlc in self.pending_outbound_htlcs.iter() {
2021                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2022                                 removed_outbound_total_msat += htlc.amount_msat;
2023                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2024                                 removed_outbound_total_msat += htlc.amount_msat;
2025                         }
2026                 }
2027
2028                 let pending_value_to_self_msat =
2029                         self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
2030                 let pending_remote_value_msat =
2031                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2032                 if pending_remote_value_msat < msg.amount_msat {
2033                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2034                 }
2035
2036                 // Check that the remote can afford to pay for this HTLC on-chain at the current
2037                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2038                 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2039                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2040                         self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2041                 };
2042                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2043                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2044                 };
2045
2046                 let chan_reserve_msat =
2047                         Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2048                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2049                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2050                 }
2051
2052                 if !self.is_outbound() {
2053                         // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2054                         // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2055                         // receiver's side, only on the sender's.
2056                         // Note that when we eventually remove support for fee updates and switch to anchor output
2057                         // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2058                         // the extra htlc when calculating the next remote commitment transaction fee as we should
2059                         // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2060                         // sensitive to fee spikes.
2061                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2062                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2063                         if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2064                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2065                                 // the HTLC, i.e. its status is already set to failing.
2066                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2067                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2068                         }
2069                 } else {
2070                         // Check that they won't violate our local required channel reserve by adding this HTLC.
2071                         let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2072                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2073                         if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis * 1000 + local_commit_tx_fee_msat {
2074                                 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2075                         }
2076                 }
2077                 if self.next_counterparty_htlc_id != msg.htlc_id {
2078                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2079                 }
2080                 if msg.cltv_expiry >= 500000000 {
2081                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2082                 }
2083
2084                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2085                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2086                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2087                         }
2088                 }
2089
2090                 // Now update local state:
2091                 self.next_counterparty_htlc_id += 1;
2092                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2093                         htlc_id: msg.htlc_id,
2094                         amount_msat: msg.amount_msat,
2095                         payment_hash: msg.payment_hash,
2096                         cltv_expiry: msg.cltv_expiry,
2097                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2098                 });
2099                 Ok(())
2100         }
2101
2102         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2103         #[inline]
2104         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
2105                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2106                         if htlc.htlc_id == htlc_id {
2107                                 match check_preimage {
2108                                         None => {},
2109                                         Some(payment_hash) =>
2110                                                 if payment_hash != htlc.payment_hash {
2111                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2112                                                 }
2113                                 };
2114                                 match htlc.state {
2115                                         OutboundHTLCState::LocalAnnounced(_) =>
2116                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2117                                         OutboundHTLCState::Committed => {
2118                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2119                                         },
2120                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2121                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2122                                 }
2123                                 return Ok(&htlc.source);
2124                         }
2125                 }
2126                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2127         }
2128
2129         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
2130                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2131                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2132                 }
2133                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2134                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2135                 }
2136
2137                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2138                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
2139         }
2140
2141         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2142                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2143                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2144                 }
2145                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2146                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2147                 }
2148
2149                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2150                 Ok(())
2151         }
2152
2153         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2154                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2155                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2156                 }
2157                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2158                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2159                 }
2160
2161                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2162                 Ok(())
2163         }
2164
2165         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)>
2166         where F::Target: FeeEstimator,
2167                                 L::Target: Logger
2168         {
2169                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2170                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2171                 }
2172                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2173                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2174                 }
2175                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2176                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2177                 }
2178
2179                 let funding_script = self.get_funding_redeemscript();
2180
2181                 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2182
2183                 let mut update_fee = false;
2184                 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2185                         update_fee = true;
2186                         self.pending_update_fee.unwrap()
2187                 } else {
2188                         self.feerate_per_kw
2189                 };
2190
2191                 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2192                         let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2193                         let commitment_txid = {
2194                                 let trusted_tx = commitment_tx.0.trust();
2195                                 let bitcoin_tx = trusted_tx.built_transaction();
2196                                 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2197
2198                                 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2199                                         log_bytes!(msg.signature.serialize_compact()[..]),
2200                                         log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2201                                         log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2202                                 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2203                                         return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2204                                 }
2205                                 bitcoin_tx.txid
2206                         };
2207                         let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2208                         (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2209                 };
2210
2211                 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2212                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2213                 if update_fee {
2214                         let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2215                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2216                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2217                         }
2218                 }
2219                 #[cfg(any(test, feature = "fuzztarget"))]
2220                 {
2221                         if self.is_outbound() {
2222                                 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2223                                 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2224                                 if let Some(info) = projected_commit_tx_info {
2225                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2226                                                 + self.holding_cell_htlc_updates.len();
2227                                         if info.total_pending_htlcs == total_pending_htlcs
2228                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
2229                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2230                                                 && info.feerate == self.feerate_per_kw {
2231                                                         assert_eq!(total_fee, info.fee / 1000);
2232                                                 }
2233                                 }
2234                         }
2235                 }
2236
2237                 if msg.htlc_signatures.len() != num_htlcs {
2238                         return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2239                 }
2240
2241                 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2242                 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2243                 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2244                         if let Some(_) = htlc.transaction_output_index {
2245                                 let htlc_tx = self.build_htlc_transaction(&commitment_txid, &htlc, true, &keys, feerate_per_kw);
2246                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2247                                 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2248                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2249                                         log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2250                                         encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2251                                 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2252                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2253                                 }
2254                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2255                         } else {
2256                                 htlcs_and_sigs.push((htlc, None, source));
2257                         }
2258                 }
2259
2260                 let holder_commitment_tx = HolderCommitmentTransaction::new(
2261                         commitment_tx,
2262                         msg.signature,
2263                         msg.htlc_signatures.clone(),
2264                         &self.get_holder_pubkeys().funding_pubkey,
2265                         self.counterparty_funding_pubkey()
2266                 );
2267
2268                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2269                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2270
2271                 // Update state now that we've passed all the can-fail calls...
2272                 let mut need_commitment = false;
2273                 if !self.is_outbound() {
2274                         if let Some(fee_update) = self.pending_update_fee {
2275                                 self.feerate_per_kw = fee_update;
2276                                 // We later use the presence of pending_update_fee to indicate we should generate a
2277                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2278                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2279                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2280                                         need_commitment = true;
2281                                         self.pending_update_fee = None;
2282                                 }
2283                         }
2284                 }
2285
2286                 self.latest_monitor_update_id += 1;
2287                 let mut monitor_update = ChannelMonitorUpdate {
2288                         update_id: self.latest_monitor_update_id,
2289                         updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2290                                 commitment_tx: holder_commitment_tx,
2291                                 htlc_outputs: htlcs_and_sigs
2292                         }]
2293                 };
2294
2295                 for htlc in self.pending_inbound_htlcs.iter_mut() {
2296                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2297                                 Some(forward_info.clone())
2298                         } else { None };
2299                         if let Some(forward_info) = new_forward {
2300                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2301                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2302                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2303                                 need_commitment = true;
2304                         }
2305                 }
2306                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2307                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2308                                 Some(fail_reason.take())
2309                         } else { None } {
2310                                 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2311                                         log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2312                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2313                                 need_commitment = true;
2314                         }
2315                 }
2316
2317                 self.cur_holder_commitment_transaction_number -= 1;
2318                 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2319                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2320                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2321
2322                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2323                         // In case we initially failed monitor updating without requiring a response, we need
2324                         // to make sure the RAA gets sent first.
2325                         self.monitor_pending_revoke_and_ack = true;
2326                         if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2327                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2328                                 // the corresponding HTLC status updates so that get_last_commitment_update
2329                                 // includes the right HTLCs.
2330                                 self.monitor_pending_commitment_signed = true;
2331                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2332                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2333                                 // strictly increasing by one, so decrement it here.
2334                                 self.latest_monitor_update_id = monitor_update.update_id;
2335                                 monitor_update.updates.append(&mut additional_update.updates);
2336                         }
2337                         log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2338                                 log_bytes!(self.channel_id));
2339                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2340                         // re-send the message on restoration)
2341                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2342                 }
2343
2344                 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2345                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2346                         // we'll send one right away when we get the revoke_and_ack when we
2347                         // free_holding_cell_htlcs().
2348                         let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2349                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2350                         // strictly increasing by one, so decrement it here.
2351                         self.latest_monitor_update_id = monitor_update.update_id;
2352                         monitor_update.updates.append(&mut additional_update.updates);
2353                         (Some(msg), None)
2354                 } else if !need_commitment {
2355                         (None, self.maybe_propose_first_closing_signed(fee_estimator))
2356                 } else { (None, None) };
2357
2358                 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2359                         log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2360
2361                 Ok((msgs::RevokeAndACK {
2362                         channel_id: self.channel_id,
2363                         per_commitment_secret,
2364                         next_per_commitment_point,
2365                 }, commitment_signed, closing_signed, monitor_update))
2366         }
2367
2368         /// Public version of the below, checking relevant preconditions first.
2369         /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2370         /// returns `(None, Vec::new())`.
2371         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 {
2372                 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2373                    (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2374                         self.free_holding_cell_htlcs(logger)
2375                 } else { Ok((None, Vec::new())) }
2376         }
2377
2378         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2379         /// fulfilling or failing the last pending HTLC)
2380         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2381                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2382                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2383                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2384                                 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2385
2386                         let mut monitor_update = ChannelMonitorUpdate {
2387                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2388                                 updates: Vec::new(),
2389                         };
2390
2391                         let mut htlc_updates = Vec::new();
2392                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2393                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2394                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2395                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2396                         let mut htlcs_to_fail = Vec::new();
2397                         for htlc_update in htlc_updates.drain(..) {
2398                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
2399                                 // fee races with adding too many outputs which push our total payments just over
2400                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
2401                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2402                                 // to rebalance channels.
2403                                 match &htlc_update {
2404                                         &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2405                                                 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2406                                                         Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2407                                                         Err(e) => {
2408                                                                 match e {
2409                                                                         ChannelError::Ignore(ref msg) => {
2410                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2411                                                                                         log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2412                                                                                 // If we fail to send here, then this HTLC should
2413                                                                                 // be failed backwards. Failing to send here
2414                                                                                 // indicates that this HTLC may keep being put back
2415                                                                                 // into the holding cell without ever being
2416                                                                                 // successfully forwarded/failed/fulfilled, causing
2417                                                                                 // our counterparty to eventually close on us.
2418                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
2419                                                                         },
2420                                                                         _ => {
2421                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2422                                                                         },
2423                                                                 }
2424                                                         }
2425                                                 }
2426                                         },
2427                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2428                                                 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2429                                                         Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2430                                                                 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2431                                                                 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2432                                                                         monitor_update.updates.append(&mut additional_monitor_update.updates);
2433                                                                 }
2434                                                         },
2435                                                         Err(e) => {
2436                                                                 if let ChannelError::Ignore(_) = e {}
2437                                                                 else {
2438                                                                         panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2439                                                                 }
2440                                                         }
2441                                                 }
2442                                         },
2443                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2444                                                 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2445                                                         Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2446                                                         Err(e) => {
2447                                                                 if let ChannelError::Ignore(_) = e {}
2448                                                                 else {
2449                                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2450                                                                 }
2451                                                         }
2452                                                 }
2453                                         },
2454                                 }
2455                         }
2456                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2457                                 return Ok((None, htlcs_to_fail));
2458                         }
2459                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2460                                 self.pending_update_fee = self.holding_cell_update_fee.take();
2461                                 Some(msgs::UpdateFee {
2462                                         channel_id: self.channel_id,
2463                                         feerate_per_kw: feerate as u32,
2464                                 })
2465                         } else {
2466                                 None
2467                         };
2468
2469                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2470                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2471                         // but we want them to be strictly increasing by one, so reset it here.
2472                         self.latest_monitor_update_id = monitor_update.update_id;
2473                         monitor_update.updates.append(&mut additional_update.updates);
2474
2475                         log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2476                                 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2477                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2478
2479                         Ok((Some((msgs::CommitmentUpdate {
2480                                 update_add_htlcs,
2481                                 update_fulfill_htlcs,
2482                                 update_fail_htlcs,
2483                                 update_fail_malformed_htlcs: Vec::new(),
2484                                 update_fee,
2485                                 commitment_signed,
2486                         }, monitor_update)), htlcs_to_fail))
2487                 } else {
2488                         Ok((None, Vec::new()))
2489                 }
2490         }
2491
2492         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2493         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2494         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2495         /// generating an appropriate error *after* the channel state has been updated based on the
2496         /// revoke_and_ack message.
2497         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>
2498                 where F::Target: FeeEstimator,
2499                                         L::Target: Logger,
2500         {
2501                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2502                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2503                 }
2504                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2505                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2506                 }
2507                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2508                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2509                 }
2510
2511                 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2512                         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 {
2513                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2514                         }
2515                 }
2516
2517                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2518                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
2519                         // haven't given them a new commitment transaction to broadcast). We should probably
2520                         // take advantage of this by updating our channel monitor, sending them an error, and
2521                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2522                         // lot of work, and there's some chance this is all a misunderstanding anyway.
2523                         // We have to do *something*, though, since our signer may get mad at us for otherwise
2524                         // jumping a remote commitment number, so best to just force-close and move on.
2525                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2526                 }
2527
2528                 #[cfg(any(test, feature = "fuzztarget"))]
2529                 {
2530                         *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2531                         *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2532                 }
2533
2534                 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2535                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2536                 self.latest_monitor_update_id += 1;
2537                 let mut monitor_update = ChannelMonitorUpdate {
2538                         update_id: self.latest_monitor_update_id,
2539                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2540                                 idx: self.cur_counterparty_commitment_transaction_number + 1,
2541                                 secret: msg.per_commitment_secret,
2542                         }],
2543                 };
2544
2545                 // Update state now that we've passed all the can-fail calls...
2546                 // (note that we may still fail to generate the new commitment_signed message, but that's
2547                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2548                 // channel based on that, but stepping stuff here should be safe either way.
2549                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2550                 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2551                 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2552                 self.cur_counterparty_commitment_transaction_number -= 1;
2553
2554                 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2555                 let mut to_forward_infos = Vec::new();
2556                 let mut revoked_htlcs = Vec::new();
2557                 let mut update_fail_htlcs = Vec::new();
2558                 let mut update_fail_malformed_htlcs = Vec::new();
2559                 let mut require_commitment = false;
2560                 let mut value_to_self_msat_diff: i64 = 0;
2561
2562                 {
2563                         // Take references explicitly so that we can hold multiple references to self.
2564                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2565                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2566
2567                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2568                         pending_inbound_htlcs.retain(|htlc| {
2569                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2570                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2571                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2572                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2573                                         }
2574                                         false
2575                                 } else { true }
2576                         });
2577                         pending_outbound_htlcs.retain(|htlc| {
2578                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2579                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2580                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2581                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2582                                         } else {
2583                                                 // They fulfilled, so we sent them money
2584                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2585                                         }
2586                                         false
2587                                 } else { true }
2588                         });
2589                         for htlc in pending_inbound_htlcs.iter_mut() {
2590                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2591                                         true
2592                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2593                                         true
2594                                 } else { false };
2595                                 if swap {
2596                                         let mut state = InboundHTLCState::Committed;
2597                                         mem::swap(&mut state, &mut htlc.state);
2598
2599                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2600                                                 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2601                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2602                                                 require_commitment = true;
2603                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2604                                                 match forward_info {
2605                                                         PendingHTLCStatus::Fail(fail_msg) => {
2606                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2607                                                                 require_commitment = true;
2608                                                                 match fail_msg {
2609                                                                         HTLCFailureMsg::Relay(msg) => {
2610                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2611                                                                                 update_fail_htlcs.push(msg)
2612                                                                         },
2613                                                                         HTLCFailureMsg::Malformed(msg) => {
2614                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2615                                                                                 update_fail_malformed_htlcs.push(msg)
2616                                                                         },
2617                                                                 }
2618                                                         },
2619                                                         PendingHTLCStatus::Forward(forward_info) => {
2620                                                                 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2621                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2622                                                                 htlc.state = InboundHTLCState::Committed;
2623                                                         }
2624                                                 }
2625                                         }
2626                                 }
2627                         }
2628                         for htlc in pending_outbound_htlcs.iter_mut() {
2629                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2630                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2631                                         htlc.state = OutboundHTLCState::Committed;
2632                                 }
2633                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2634                                         Some(fail_reason.take())
2635                                 } else { None } {
2636                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2637                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2638                                         require_commitment = true;
2639                                 }
2640                         }
2641                 }
2642                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2643
2644                 if self.is_outbound() {
2645                         if let Some(feerate) = self.pending_update_fee.take() {
2646                                 self.feerate_per_kw = feerate;
2647                         }
2648                 } else {
2649                         if let Some(feerate) = self.pending_update_fee {
2650                                 // Because a node cannot send two commitment_signeds in a row without getting a
2651                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2652                                 // it should use to create keys with) and because a node can't send a
2653                                 // commitment_signed without changes, checking if the feerate is equal to the
2654                                 // pending feerate update is sufficient to detect require_commitment.
2655                                 if feerate == self.feerate_per_kw {
2656                                         require_commitment = true;
2657                                         self.pending_update_fee = None;
2658                                 }
2659                         }
2660                 }
2661
2662                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2663                         // We can't actually generate a new commitment transaction (incl by freeing holding
2664                         // cells) while we can't update the monitor, so we just return what we have.
2665                         if require_commitment {
2666                                 self.monitor_pending_commitment_signed = true;
2667                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2668                                 // which does not update state, but we're definitely now awaiting a remote revoke
2669                                 // before we can step forward any more, so set it here.
2670                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2671                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2672                                 // strictly increasing by one, so decrement it here.
2673                                 self.latest_monitor_update_id = monitor_update.update_id;
2674                                 monitor_update.updates.append(&mut additional_update.updates);
2675                         }
2676                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2677                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2678                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2679                         return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2680                 }
2681
2682                 match self.free_holding_cell_htlcs(logger)? {
2683                         (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2684                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2685                                 for fail_msg in update_fail_htlcs.drain(..) {
2686                                         commitment_update.update_fail_htlcs.push(fail_msg);
2687                                 }
2688                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2689                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2690                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2691                                 }
2692
2693                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2694                                 // strictly increasing by one, so decrement it here.
2695                                 self.latest_monitor_update_id = monitor_update.update_id;
2696                                 monitor_update.updates.append(&mut additional_update.updates);
2697
2698                                 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2699                         },
2700                         (None, htlcs_to_fail) => {
2701                                 if require_commitment {
2702                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2703
2704                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2705                                         // strictly increasing by one, so decrement it here.
2706                                         self.latest_monitor_update_id = monitor_update.update_id;
2707                                         monitor_update.updates.append(&mut additional_update.updates);
2708
2709                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2710                                                 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2711                                         Ok((Some(msgs::CommitmentUpdate {
2712                                                 update_add_htlcs: Vec::new(),
2713                                                 update_fulfill_htlcs: Vec::new(),
2714                                                 update_fail_htlcs,
2715                                                 update_fail_malformed_htlcs,
2716                                                 update_fee: None,
2717                                                 commitment_signed
2718                                         }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2719                                 } else {
2720                                         log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2721                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2722                                 }
2723                         }
2724                 }
2725
2726         }
2727
2728         /// Adds a pending update to this channel. See the doc for send_htlc for
2729         /// further details on the optionness of the return value.
2730         /// You MUST call send_commitment prior to any other calls on this Channel
2731         fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2732                 if !self.is_outbound() {
2733                         panic!("Cannot send fee from inbound channel");
2734                 }
2735                 if !self.is_usable() {
2736                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2737                 }
2738                 if !self.is_live() {
2739                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2740                 }
2741
2742                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2743                         self.holding_cell_update_fee = Some(feerate_per_kw);
2744                         return None;
2745                 }
2746
2747                 debug_assert!(self.pending_update_fee.is_none());
2748                 self.pending_update_fee = Some(feerate_per_kw);
2749
2750                 Some(msgs::UpdateFee {
2751                         channel_id: self.channel_id,
2752                         feerate_per_kw,
2753                 })
2754         }
2755
2756         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 {
2757                 match self.send_update_fee(feerate_per_kw) {
2758                         Some(update_fee) => {
2759                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2760                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2761                         },
2762                         None => Ok(None)
2763                 }
2764         }
2765
2766         /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2767         /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2768         /// resent.
2769         /// No further message handling calls may be made until a channel_reestablish dance has
2770         /// completed.
2771         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L)  where L::Target: Logger {
2772                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2773                 if self.channel_state < ChannelState::FundingSent as u32 {
2774                         self.channel_state = ChannelState::ShutdownComplete as u32;
2775                         return;
2776                 }
2777                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2778                 // will be retransmitted.
2779                 self.last_sent_closing_fee = None;
2780
2781                 let mut inbound_drop_count = 0;
2782                 self.pending_inbound_htlcs.retain(|htlc| {
2783                         match htlc.state {
2784                                 InboundHTLCState::RemoteAnnounced(_) => {
2785                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2786                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2787                                         // this HTLC accordingly
2788                                         inbound_drop_count += 1;
2789                                         false
2790                                 },
2791                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2792                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2793                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2794                                         // in response to it yet, so don't touch it.
2795                                         true
2796                                 },
2797                                 InboundHTLCState::Committed => true,
2798                                 InboundHTLCState::LocalRemoved(_) => {
2799                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2800                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2801                                         // (that we missed). Keep this around for now and if they tell us they missed
2802                                         // the commitment_signed we can re-transmit the update then.
2803                                         true
2804                                 },
2805                         }
2806                 });
2807                 self.next_counterparty_htlc_id -= inbound_drop_count;
2808
2809                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2810                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2811                                 // They sent us an update to remove this but haven't yet sent the corresponding
2812                                 // commitment_signed, we need to move it back to Committed and they can re-send
2813                                 // the update upon reconnection.
2814                                 htlc.state = OutboundHTLCState::Committed;
2815                         }
2816                 }
2817
2818                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2819                 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
2820         }
2821
2822         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2823         /// updates are partially paused.
2824         /// This must be called immediately after the call which generated the ChannelMonitor update
2825         /// which failed. The messages which were generated from that call which generated the
2826         /// monitor update failure must *not* have been sent to the remote end, and must instead
2827         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2828         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)>) {
2829                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2830                 self.monitor_pending_revoke_and_ack = resend_raa;
2831                 self.monitor_pending_commitment_signed = resend_commitment;
2832                 assert!(self.monitor_pending_forwards.is_empty());
2833                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2834                 assert!(self.monitor_pending_failures.is_empty());
2835                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2836                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2837         }
2838
2839         /// Indicates that the latest ChannelMonitor update has been committed by the client
2840         /// successfully and we should restore normal operation. Returns messages which should be sent
2841         /// to the remote side.
2842         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 {
2843                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2844                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2845
2846                 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
2847                         self.funding_transaction.take()
2848                 } else { None };
2849
2850                 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
2851                 // we assume the user never directly broadcasts the funding transaction and waits for us to
2852                 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
2853                 // channel which failed to persist the monitor on funding_created, and we got the funding
2854                 // transaction confirmed before the monitor was persisted.
2855                 let funding_locked = if self.monitor_pending_funding_locked {
2856                         assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
2857                         self.monitor_pending_funding_locked = false;
2858                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2859                         Some(msgs::FundingLocked {
2860                                 channel_id: self.channel_id(),
2861                                 next_per_commitment_point,
2862                         })
2863                 } else { None };
2864
2865                 let mut forwards = Vec::new();
2866                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2867                 let mut failures = Vec::new();
2868                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2869
2870                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2871                         self.monitor_pending_revoke_and_ack = false;
2872                         self.monitor_pending_commitment_signed = false;
2873                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
2874                 }
2875
2876                 let raa = if self.monitor_pending_revoke_and_ack {
2877                         Some(self.get_last_revoke_and_ack())
2878                 } else { None };
2879                 let commitment_update = if self.monitor_pending_commitment_signed {
2880                         Some(self.get_last_commitment_update(logger))
2881                 } else { None };
2882
2883                 self.monitor_pending_revoke_and_ack = false;
2884                 self.monitor_pending_commitment_signed = false;
2885                 let order = self.resend_order.clone();
2886                 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
2887                         log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
2888                         if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
2889                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2890                 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
2891         }
2892
2893         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2894                 where F::Target: FeeEstimator
2895         {
2896                 if self.is_outbound() {
2897                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2898                 }
2899                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2900                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2901                 }
2902                 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2903                 self.pending_update_fee = Some(msg.feerate_per_kw);
2904                 self.update_time_counter += 1;
2905                 Ok(())
2906         }
2907
2908         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2909                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2910                 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
2911                 msgs::RevokeAndACK {
2912                         channel_id: self.channel_id,
2913                         per_commitment_secret,
2914                         next_per_commitment_point,
2915                 }
2916         }
2917
2918         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2919                 let mut update_add_htlcs = Vec::new();
2920                 let mut update_fulfill_htlcs = Vec::new();
2921                 let mut update_fail_htlcs = Vec::new();
2922                 let mut update_fail_malformed_htlcs = Vec::new();
2923
2924                 for htlc in self.pending_outbound_htlcs.iter() {
2925                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2926                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2927                                         channel_id: self.channel_id(),
2928                                         htlc_id: htlc.htlc_id,
2929                                         amount_msat: htlc.amount_msat,
2930                                         payment_hash: htlc.payment_hash,
2931                                         cltv_expiry: htlc.cltv_expiry,
2932                                         onion_routing_packet: (**onion_packet).clone(),
2933                                 });
2934                         }
2935                 }
2936
2937                 for htlc in self.pending_inbound_htlcs.iter() {
2938                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2939                                 match reason {
2940                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2941                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2942                                                         channel_id: self.channel_id(),
2943                                                         htlc_id: htlc.htlc_id,
2944                                                         reason: err_packet.clone()
2945                                                 });
2946                                         },
2947                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2948                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2949                                                         channel_id: self.channel_id(),
2950                                                         htlc_id: htlc.htlc_id,
2951                                                         sha256_of_onion: sha256_of_onion.clone(),
2952                                                         failure_code: failure_code.clone(),
2953                                                 });
2954                                         },
2955                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2956                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2957                                                         channel_id: self.channel_id(),
2958                                                         htlc_id: htlc.htlc_id,
2959                                                         payment_preimage: payment_preimage.clone(),
2960                                                 });
2961                                         },
2962                                 }
2963                         }
2964                 }
2965
2966                 log_trace!(logger, "Regenerated latest commitment update in channel {} with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2967                                 log_bytes!(self.channel_id()), update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2968                 msgs::CommitmentUpdate {
2969                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2970                         update_fee: None,
2971                         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,
2972                 }
2973         }
2974
2975         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2976         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2977         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 {
2978                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2979                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2980                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2981                         // just close here instead of trying to recover.
2982                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
2983                 }
2984
2985                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2986                         msg.next_local_commitment_number == 0 {
2987                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
2988                 }
2989
2990                 if msg.next_remote_commitment_number > 0 {
2991                         match msg.data_loss_protect {
2992                                 OptionalField::Present(ref data_loss) => {
2993                                         let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
2994                                         let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
2995                                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
2996                                         if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
2997                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
2998                                         }
2999                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3000                                                 return Err(ChannelError::CloseDelayBroadcast(
3001                                                         "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()
3002                                                 ));
3003                                         }
3004                                 },
3005                                 OptionalField::Absent => {}
3006                         }
3007                 }
3008
3009                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3010                 // remaining cases either succeed or ErrorMessage-fail).
3011                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3012
3013                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3014                         Some(msgs::Shutdown {
3015                                 channel_id: self.channel_id,
3016                                 scriptpubkey: self.get_closing_scriptpubkey(),
3017                         })
3018                 } else { None };
3019
3020                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3021                         // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3022                         if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3023                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3024                                 if msg.next_remote_commitment_number != 0 {
3025                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3026                                 }
3027                                 // Short circuit the whole handler as there is nothing we can resend them
3028                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3029                         }
3030
3031                         // We have OurFundingLocked set!
3032                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3033                         return Ok((Some(msgs::FundingLocked {
3034                                 channel_id: self.channel_id(),
3035                                 next_per_commitment_point,
3036                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3037                 }
3038
3039                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3040                         // Remote isn't waiting on any RevokeAndACK from us!
3041                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3042                         None
3043                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3044                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3045                                 self.monitor_pending_revoke_and_ack = true;
3046                                 None
3047                         } else {
3048                                 Some(self.get_last_revoke_and_ack())
3049                         }
3050                 } else {
3051                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3052                 };
3053
3054                 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3055                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3056                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3057                 // the corresponding revoke_and_ack back yet.
3058                 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 };
3059
3060                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3061                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3062                         let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3063                         Some(msgs::FundingLocked {
3064                                 channel_id: self.channel_id(),
3065                                 next_per_commitment_point,
3066                         })
3067                 } else { None };
3068
3069                 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3070                         if required_revoke.is_some() {
3071                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3072                         } else {
3073                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3074                         }
3075
3076                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3077                                 // We're up-to-date and not waiting on a remote revoke (if we are our
3078                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3079                                 // have received some updates while we were disconnected. Free the holding cell
3080                                 // now!
3081                                 match self.free_holding_cell_htlcs(logger) {
3082                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3083                                         Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3084                                         Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3085                                                 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3086                                         },
3087                                         Ok((None, htlcs_to_fail)) => {
3088                                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3089                                         },
3090                                 }
3091                         } else {
3092                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3093                         }
3094                 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3095                         if required_revoke.is_some() {
3096                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3097                         } else {
3098                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3099                         }
3100
3101                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3102                                 self.monitor_pending_commitment_signed = true;
3103                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3104                         }
3105
3106                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3107                 } else {
3108                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3109                 }
3110         }
3111
3112         fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3113                 where F::Target: FeeEstimator
3114         {
3115                 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3116                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3117                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3118                         return None;
3119                 }
3120
3121                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3122                 if self.feerate_per_kw > proposed_feerate {
3123                         proposed_feerate = self.feerate_per_kw;
3124                 }
3125                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3126                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3127
3128                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3129                 let sig = self.holder_signer
3130                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3131                         .ok();
3132                 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3133                 if sig.is_none() { return None; }
3134
3135                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3136                 Some(msgs::ClosingSigned {
3137                         channel_id: self.channel_id,
3138                         fee_satoshis: total_fee_satoshis,
3139                         signature: sig.unwrap(),
3140                 })
3141         }
3142
3143         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>
3144                 where F::Target: FeeEstimator
3145         {
3146                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3147                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3148                 }
3149                 if self.channel_state < ChannelState::FundingSent as u32 {
3150                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
3151                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3152                         // can do that via error message without getting a connection fail anyway...
3153                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3154                 }
3155                 for htlc in self.pending_inbound_htlcs.iter() {
3156                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3157                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3158                         }
3159                 }
3160                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3161
3162                 if is_unsupported_shutdown_script(&their_features, &msg.scriptpubkey) {
3163                         return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3164                 }
3165
3166                 if self.counterparty_shutdown_scriptpubkey.is_some() {
3167                         if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3168                                 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3169                         }
3170                 } else {
3171                         self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3172                 }
3173
3174                 // From here on out, we may not fail!
3175
3176                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3177                 self.update_time_counter += 1;
3178
3179                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3180                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3181                 // cell HTLCs and return them to fail the payment.
3182                 self.holding_cell_update_fee = None;
3183                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3184                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3185                         match htlc_update {
3186                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3187                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3188                                         false
3189                                 },
3190                                 _ => true
3191                         }
3192                 });
3193                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3194                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3195                 // any further commitment updates after we set LocalShutdownSent.
3196
3197                 let shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3198                         None
3199                 } else {
3200                         Some(msgs::Shutdown {
3201                                 channel_id: self.channel_id,
3202                                 scriptpubkey: self.get_closing_scriptpubkey(),
3203                         })
3204                 };
3205
3206                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3207                 self.update_time_counter += 1;
3208
3209                 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
3210         }
3211
3212         fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3213                 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3214                 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3215                 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3216
3217                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3218
3219                 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3220                 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3221                 if funding_key[..] < counterparty_funding_key[..] {
3222                         tx.input[0].witness.push(sig.serialize_der().to_vec());
3223                         tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3224                 } else {
3225                         tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3226                         tx.input[0].witness.push(sig.serialize_der().to_vec());
3227                 }
3228                 tx.input[0].witness[1].push(SigHashType::All as u8);
3229                 tx.input[0].witness[2].push(SigHashType::All as u8);
3230
3231                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3232         }
3233
3234         pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3235                 where F::Target: FeeEstimator
3236         {
3237                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3238                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3239                 }
3240                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3241                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3242                 }
3243                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3244                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3245                 }
3246                 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3247                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3248                 }
3249
3250                 let funding_redeemscript = self.get_funding_redeemscript();
3251                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3252                 if used_total_fee != msg.fee_satoshis {
3253                         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)));
3254                 }
3255                 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3256
3257                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3258                         Ok(_) => {},
3259                         Err(_e) => {
3260                                 // The remote end may have decided to revoke their output due to inconsistent dust
3261                                 // limits, so check for that case by re-checking the signature here.
3262                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3263                                 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3264                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3265                         },
3266                 };
3267
3268                 let closing_tx_max_weight = self.get_closing_transaction_weight(
3269                         if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3270                         if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3271                 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3272                         if last_fee == msg.fee_satoshis {
3273                                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3274                                 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3275                                 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3276                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3277                                 self.update_time_counter += 1;
3278                                 return Ok((None, Some(closing_tx)));
3279                         }
3280                 }
3281
3282                 macro_rules! propose_new_feerate {
3283                         ($new_feerate: expr) => {
3284                                 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3285                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3286                                 let sig = self.holder_signer
3287                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3288                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3289                                 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3290                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3291                                 return Ok((Some(msgs::ClosingSigned {
3292                                         channel_id: self.channel_id,
3293                                         fee_satoshis: used_total_fee,
3294                                         signature: sig,
3295                                 }), None))
3296                         }
3297                 }
3298
3299                 let mut min_feerate = 253;
3300                 if self.is_outbound() {
3301                         let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3302                         if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3303                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3304                                         if max_feerate <= last_feerate {
3305                                                 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)));
3306                                         }
3307                                 }
3308                                 propose_new_feerate!(max_feerate);
3309                         }
3310                 } else {
3311                         min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3312                 }
3313                 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3314                         if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3315                                 if min_feerate >= last_feerate {
3316                                         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)));
3317                                 }
3318                         }
3319                         propose_new_feerate!(min_feerate);
3320                 }
3321
3322                 let sig = self.holder_signer
3323                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3324                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3325                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3326                 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3327                 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3328
3329                 self.channel_state = ChannelState::ShutdownComplete as u32;
3330                 self.update_time_counter += 1;
3331
3332                 Ok((Some(msgs::ClosingSigned {
3333                         channel_id: self.channel_id,
3334                         fee_satoshis: msg.fee_satoshis,
3335                         signature: sig,
3336                 }), Some(closing_tx)))
3337         }
3338
3339         // Public utilities:
3340
3341         pub fn channel_id(&self) -> [u8; 32] {
3342                 self.channel_id
3343         }
3344
3345         /// Gets the "user_id" value passed into the construction of this channel. It has no special
3346         /// meaning and exists only to allow users to have a persistent identifier of a channel.
3347         pub fn get_user_id(&self) -> u64 {
3348                 self.user_id
3349         }
3350
3351         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3352         /// is_usable() returns true).
3353         /// Allowed in any state (including after shutdown)
3354         pub fn get_short_channel_id(&self) -> Option<u64> {
3355                 self.short_channel_id
3356         }
3357
3358         /// Returns the funding_txo we either got from our peer, or were given by
3359         /// get_outbound_funding_created.
3360         pub fn get_funding_txo(&self) -> Option<OutPoint> {
3361                 self.channel_transaction_parameters.funding_outpoint
3362         }
3363
3364         fn get_holder_selected_contest_delay(&self) -> u16 {
3365                 self.channel_transaction_parameters.holder_selected_contest_delay
3366         }
3367
3368         fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3369                 &self.channel_transaction_parameters.holder_pubkeys
3370         }
3371
3372         fn get_counterparty_selected_contest_delay(&self) -> u16 {
3373                 self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().selected_contest_delay
3374         }
3375
3376         fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3377                 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3378         }
3379
3380         /// Allowed in any state (including after shutdown)
3381         pub fn get_counterparty_node_id(&self) -> PublicKey {
3382                 self.counterparty_node_id
3383         }
3384
3385         /// Allowed in any state (including after shutdown)
3386         #[cfg(test)]
3387         pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3388                 self.holder_htlc_minimum_msat
3389         }
3390
3391         /// Allowed in any state (including after shutdown)
3392         pub fn get_announced_htlc_max_msat(&self) -> u64 {
3393                 return cmp::min(
3394                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3395                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
3396                         // channel might have been used to route very small values (either by honest users or as DoS).
3397                         self.channel_value_satoshis * 1000 * 9 / 10,
3398
3399                         Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3400                 );
3401         }
3402
3403         /// Allowed in any state (including after shutdown)
3404         pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3405                 self.counterparty_htlc_minimum_msat
3406         }
3407
3408         pub fn get_value_satoshis(&self) -> u64 {
3409                 self.channel_value_satoshis
3410         }
3411
3412         pub fn get_fee_proportional_millionths(&self) -> u32 {
3413                 self.config.fee_proportional_millionths
3414         }
3415
3416         pub fn get_cltv_expiry_delta(&self) -> u16 {
3417                 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3418         }
3419
3420         #[cfg(test)]
3421         pub fn get_feerate(&self) -> u32 {
3422                 self.feerate_per_kw
3423         }
3424
3425         pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3426                 self.cur_holder_commitment_transaction_number + 1
3427         }
3428
3429         pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3430                 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3431         }
3432
3433         pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3434                 self.cur_counterparty_commitment_transaction_number + 2
3435         }
3436
3437         #[cfg(test)]
3438         pub fn get_signer(&self) -> &Signer {
3439                 &self.holder_signer
3440         }
3441
3442         #[cfg(test)]
3443         pub fn get_value_stat(&self) -> ChannelValueStat {
3444                 ChannelValueStat {
3445                         value_to_self_msat: self.value_to_self_msat,
3446                         channel_value_msat: self.channel_value_satoshis * 1000,
3447                         channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis * 1000,
3448                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3449                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3450                         holding_cell_outbound_amount_msat: {
3451                                 let mut res = 0;
3452                                 for h in self.holding_cell_htlc_updates.iter() {
3453                                         match h {
3454                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3455                                                         res += amount_msat;
3456                                                 }
3457                                                 _ => {}
3458                                         }
3459                                 }
3460                                 res
3461                         },
3462                         counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3463                         counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3464                 }
3465         }
3466
3467         /// Allowed in any state (including after shutdown)
3468         pub fn get_update_time_counter(&self) -> u32 {
3469                 self.update_time_counter
3470         }
3471
3472         pub fn get_latest_monitor_update_id(&self) -> u64 {
3473                 self.latest_monitor_update_id
3474         }
3475
3476         pub fn should_announce(&self) -> bool {
3477                 self.config.announced_channel
3478         }
3479
3480         pub fn is_outbound(&self) -> bool {
3481                 self.channel_transaction_parameters.is_outbound_from_holder
3482         }
3483
3484         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3485         /// Allowed in any state (including after shutdown)
3486         pub fn get_holder_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3487                 where F::Target: FeeEstimator
3488         {
3489                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3490                 // output value back into a transaction with the regular channel output:
3491
3492                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3493                 let mut res = self.feerate_per_kw as u64 * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3494
3495                 if self.is_outbound() {
3496                         // + the marginal fee increase cost to us in the commitment transaction:
3497                         res += self.feerate_per_kw as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3498                 }
3499
3500                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3501                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as u64 * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3502
3503                 res as u32
3504         }
3505
3506         /// Returns true if we've ever received a message from the remote end for this Channel
3507         pub fn have_received_message(&self) -> bool {
3508                 self.channel_state > (ChannelState::OurInitSent as u32)
3509         }
3510
3511         /// Returns true if this channel is fully established and not known to be closing.
3512         /// Allowed in any state (including after shutdown)
3513         pub fn is_usable(&self) -> bool {
3514                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3515                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3516         }
3517
3518         /// Returns true if this channel is currently available for use. This is a superset of
3519         /// is_usable() and considers things like the channel being temporarily disabled.
3520         /// Allowed in any state (including after shutdown)
3521         pub fn is_live(&self) -> bool {
3522                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3523         }
3524
3525         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3526         /// Allowed in any state (including after shutdown)
3527         pub fn is_awaiting_monitor_update(&self) -> bool {
3528                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3529         }
3530
3531         /// Returns true if funding_created was sent/received.
3532         pub fn is_funding_initiated(&self) -> bool {
3533                 self.channel_state >= ChannelState::FundingSent as u32
3534         }
3535
3536         /// Returns true if this channel is fully shut down. True here implies that no further actions
3537         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3538         /// will be handled appropriately by the chain monitor.
3539         pub fn is_shutdown(&self) -> bool {
3540                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
3541                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3542                         true
3543                 } else { false }
3544         }
3545
3546         pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3547                 self.channel_update_status
3548         }
3549
3550         pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3551                 self.channel_update_status = status;
3552         }
3553
3554         fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3555                 if self.funding_tx_confirmation_height == 0 {
3556                         return None;
3557                 }
3558
3559                 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3560                 if funding_tx_confirmations <= 0 {
3561                         self.funding_tx_confirmation_height = 0;
3562                 }
3563
3564                 if funding_tx_confirmations < self.minimum_depth as i64 {
3565                         return None;
3566                 }
3567
3568                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3569                 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3570                         self.channel_state |= ChannelState::OurFundingLocked as u32;
3571                         true
3572                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3573                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3574                         self.update_time_counter += 1;
3575                         true
3576                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3577                         // We got a reorg but not enough to trigger a force close, just ignore.
3578                         false
3579                 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3580                         panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3581                 } else {
3582                         // We got a reorg but not enough to trigger a force close, just ignore.
3583                         false
3584                 };
3585
3586                 if need_commitment_update {
3587                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3588                                 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3589                                 return Some(msgs::FundingLocked {
3590                                         channel_id: self.channel_id,
3591                                         next_per_commitment_point,
3592                                 });
3593                         } else {
3594                                 self.monitor_pending_funding_locked = true;
3595                         }
3596                 }
3597                 None
3598         }
3599
3600         /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3601         /// In the first case, we store the confirmation height and calculating the short channel id.
3602         /// In the second, we simply return an Err indicating we need to be force-closed now.
3603         pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3604                         -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3605                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3606                 for &(index_in_block, tx) in txdata.iter() {
3607                         if let Some(funding_txo) = self.get_funding_txo() {
3608                                 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3609                                 // whether they've sent a funding_locked or not), check if we should send one.
3610                                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3611                                         if tx.txid() == funding_txo.txid {
3612                                                 let txo_idx = funding_txo.index as usize;
3613                                                 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3614                                                                 tx.output[txo_idx].value != self.channel_value_satoshis {
3615                                                         if self.is_outbound() {
3616                                                                 // If we generated the funding transaction and it doesn't match what it
3617                                                                 // should, the client is really broken and we should just panic and
3618                                                                 // tell them off. That said, because hash collisions happen with high
3619                                                                 // probability in fuzztarget mode, if we're fuzzing we just close the
3620                                                                 // channel and move on.
3621                                                                 #[cfg(not(feature = "fuzztarget"))]
3622                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3623                                                         }
3624                                                         self.update_time_counter += 1;
3625                                                         return Err(msgs::ErrorMessage {
3626                                                                 channel_id: self.channel_id(),
3627                                                                 data: "funding tx had wrong script/value or output index".to_owned()
3628                                                         });
3629                                                 } else {
3630                                                         if self.is_outbound() {
3631                                                                 for input in tx.input.iter() {
3632                                                                         if input.witness.is_empty() {
3633                                                                                 // We generated a malleable funding transaction, implying we've
3634                                                                                 // just exposed ourselves to funds loss to our counterparty.
3635                                                                                 #[cfg(not(feature = "fuzztarget"))]
3636                                                                                 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3637                                                                         }
3638                                                                 }
3639                                                         }
3640                                                         self.funding_tx_confirmation_height = height;
3641                                                         self.funding_tx_confirmed_in = Some(*block_hash);
3642                                                         self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3643                                                                 Ok(scid) => Some(scid),
3644                                                                 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3645                                                         }
3646                                                 }
3647                                         }
3648                                         // If we allow 1-conf funding, we may need to check for funding_locked here and
3649                                         // send it immediately instead of waiting for a best_block_updated call (which
3650                                         // may have already happened for this block).
3651                                         if let Some(funding_locked) = self.check_get_funding_locked(height) {
3652                                                 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3653                                                 return Ok(Some(funding_locked));
3654                                         }
3655                                 }
3656                                 for inp in tx.input.iter() {
3657                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3658                                                 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()));
3659                                                 return Err(msgs::ErrorMessage {
3660                                                         channel_id: self.channel_id(),
3661                                                         data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3662                                                 });
3663                                         }
3664                                 }
3665                         }
3666                 }
3667                 Ok(None)
3668         }
3669
3670         /// When a new block is connected, we check the height of the block against outbound holding
3671         /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3672         /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3673         /// handled by the ChannelMonitor.
3674         ///
3675         /// If we return Err, the channel may have been closed, at which point the standard
3676         /// requirements apply - no calls may be made except those explicitly stated to be allowed
3677         /// post-shutdown.
3678         ///
3679         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3680         /// back.
3681         pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
3682                         -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
3683                 let mut timed_out_htlcs = Vec::new();
3684                 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3685                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3686                         match htlc_update {
3687                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3688                                         if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3689                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3690                                                 false
3691                                         } else { true }
3692                                 },
3693                                 _ => true
3694                         }
3695                 });
3696
3697                 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3698
3699                 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3700                         log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3701                         return Ok((Some(funding_locked), timed_out_htlcs));
3702                 }
3703
3704                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3705                 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3706                    (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3707                         let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3708                         if self.funding_tx_confirmation_height == 0 {
3709                                 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3710                                 // zero if it has been reorged out, however in either case, our state flags
3711                                 // indicate we've already sent a funding_locked
3712                                 funding_tx_confirmations = 0;
3713                         }
3714
3715                         // If we've sent funding_locked (or have both sent and received funding_locked), and
3716                         // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3717                         // close the channel and hope we can get the latest state on chain (because presumably
3718                         // the funding transaction is at least still in the mempool of most nodes).
3719                         if funding_tx_confirmations < self.minimum_depth as i64 / 2 {
3720                                 return Err(msgs::ErrorMessage {
3721                                         channel_id: self.channel_id(),
3722                                         data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth, funding_tx_confirmations),
3723                                 });
3724                         }
3725                 }
3726
3727                 Ok((None, timed_out_htlcs))
3728         }
3729
3730         /// Indicates the funding transaction is no longer confirmed in the main chain. This may
3731         /// force-close the channel, but may also indicate a harmless reorganization of a block or two
3732         /// before the channel has reached funding_locked and we can just wait for more blocks.
3733         pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
3734                 if self.funding_tx_confirmation_height != 0 {
3735                         // We handle the funding disconnection by calling best_block_updated with a height one
3736                         // below where our funding was connected, implying a reorg back to conf_height - 1.
3737                         let reorg_height = self.funding_tx_confirmation_height - 1;
3738                         // We use the time field to bump the current time we set on channel updates if its
3739                         // larger. If we don't know that time has moved forward, we can just set it to the last
3740                         // time we saw and it will be ignored.
3741                         let best_time = self.update_time_counter;
3742                         match self.best_block_updated(reorg_height, best_time, logger) {
3743                                 Ok((funding_locked, timed_out_htlcs)) => {
3744                                         assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
3745                                         assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
3746                                         Ok(())
3747                                 },
3748                                 Err(e) => Err(e)
3749                         }
3750                 } else {
3751                         // We never learned about the funding confirmation anyway, just ignore
3752                         Ok(())
3753                 }
3754         }
3755
3756         // Methods to get unprompted messages to send to the remote end (or where we already returned
3757         // something in the handler for the message that prompted this message):
3758
3759         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3760                 if !self.is_outbound() {
3761                         panic!("Tried to open a channel for an inbound channel?");
3762                 }
3763                 if self.channel_state != ChannelState::OurInitSent as u32 {
3764                         panic!("Cannot generate an open_channel after we've moved forward");
3765                 }
3766
3767                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3768                         panic!("Tried to send an open_channel for a channel that has already advanced");
3769                 }
3770
3771                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3772                 let keys = self.get_holder_pubkeys();
3773
3774                 msgs::OpenChannel {
3775                         chain_hash,
3776                         temporary_channel_id: self.channel_id,
3777                         funding_satoshis: self.channel_value_satoshis,
3778                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3779                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
3780                         max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3781                         channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3782                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
3783                         feerate_per_kw: self.feerate_per_kw as u32,
3784                         to_self_delay: self.get_holder_selected_contest_delay(),
3785                         max_accepted_htlcs: OUR_MAX_HTLCS,
3786                         funding_pubkey: keys.funding_pubkey,
3787                         revocation_basepoint: keys.revocation_basepoint,
3788                         payment_point: keys.payment_point,
3789                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
3790                         htlc_basepoint: keys.htlc_basepoint,
3791                         first_per_commitment_point,
3792                         channel_flags: if self.config.announced_channel {1} else {0},
3793                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3794                 }
3795         }
3796
3797         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3798                 if self.is_outbound() {
3799                         panic!("Tried to send accept_channel for an outbound channel?");
3800                 }
3801                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3802                         panic!("Tried to send accept_channel after channel had moved forward");
3803                 }
3804                 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3805                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3806                 }
3807
3808                 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3809                 let keys = self.get_holder_pubkeys();
3810
3811                 msgs::AcceptChannel {
3812                         temporary_channel_id: self.channel_id,
3813                         dust_limit_satoshis: self.holder_dust_limit_satoshis,
3814                         max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3815                         channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3816                         htlc_minimum_msat: self.holder_htlc_minimum_msat,
3817                         minimum_depth: self.minimum_depth,
3818                         to_self_delay: self.get_holder_selected_contest_delay(),
3819                         max_accepted_htlcs: OUR_MAX_HTLCS,
3820                         funding_pubkey: keys.funding_pubkey,
3821                         revocation_basepoint: keys.revocation_basepoint,
3822                         payment_point: keys.payment_point,
3823                         delayed_payment_basepoint: keys.delayed_payment_basepoint,
3824                         htlc_basepoint: keys.htlc_basepoint,
3825                         first_per_commitment_point,
3826                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3827                 }
3828         }
3829
3830         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3831         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3832                 let counterparty_keys = self.build_remote_transaction_keys()?;
3833                 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;
3834                 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3835                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3836         }
3837
3838         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3839         /// a funding_created message for the remote peer.
3840         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3841         /// or if called on an inbound channel.
3842         /// Note that channel_id changes during this call!
3843         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3844         /// If an Err is returned, it is a ChannelError::Close.
3845         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 {
3846                 if !self.is_outbound() {
3847                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3848                 }
3849                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3850                         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)");
3851                 }
3852                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3853                                 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3854                                 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3855                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3856                 }
3857
3858                 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3859                 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3860
3861                 let signature = match self.get_outbound_funding_created_signature(logger) {
3862                         Ok(res) => res,
3863                         Err(e) => {
3864                                 log_error!(logger, "Got bad signatures: {:?}!", e);
3865                                 self.channel_transaction_parameters.funding_outpoint = None;
3866                                 return Err(e);
3867                         }
3868                 };
3869
3870                 let temporary_channel_id = self.channel_id;
3871
3872                 // Now that we're past error-generating stuff, update our local state:
3873
3874                 self.channel_state = ChannelState::FundingCreated as u32;
3875                 self.channel_id = funding_txo.to_channel_id();
3876                 self.funding_transaction = Some(funding_transaction);
3877
3878                 Ok(msgs::FundingCreated {
3879                         temporary_channel_id,
3880                         funding_txid: funding_txo.txid,
3881                         funding_output_index: funding_txo.index,
3882                         signature
3883                 })
3884         }
3885
3886         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3887         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3888         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3889         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3890         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3891         /// closing).
3892         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3893         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3894         ///
3895         /// This will only return ChannelError::Ignore upon failure.
3896         pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3897                 if !self.config.announced_channel {
3898                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3899                 }
3900                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3901                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3902                 }
3903                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3904                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3905                 }
3906
3907                 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
3908
3909                 let msg = msgs::UnsignedChannelAnnouncement {
3910                         features: ChannelFeatures::known(),
3911                         chain_hash,
3912                         short_channel_id: self.get_short_channel_id().unwrap(),
3913                         node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
3914                         node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
3915                         bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
3916                         bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
3917                         excess_data: Vec::new(),
3918                 };
3919
3920                 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
3921                         .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
3922
3923                 Ok((msg, sig))
3924         }
3925
3926         /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
3927         /// available.
3928         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> {
3929                 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
3930                         let were_node_one = announcement.node_id_1 == our_node_id;
3931
3932                         let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
3933                         Ok(msgs::ChannelAnnouncement {
3934                                 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
3935                                 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
3936                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
3937                                 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
3938                                 contents: announcement,
3939                         })
3940                 } else {
3941                         Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
3942                 }
3943         }
3944
3945         /// Processes an incoming announcement_signatures message, providing a fully-signed
3946         /// channel_announcement message which we can broadcast and storing our counterparty's
3947         /// signatures for later reconstruction/rebroadcast of the channel_announcement.
3948         pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
3949                 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
3950
3951                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
3952
3953                 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
3954                         return Err(ChannelError::Close(format!(
3955                                 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
3956                                  &announcement, self.get_counterparty_node_id())));
3957                 }
3958                 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
3959                         return Err(ChannelError::Close(format!(
3960                                 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
3961                                 &announcement, self.counterparty_funding_pubkey())));
3962                 }
3963
3964                 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
3965
3966                 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
3967         }
3968
3969         /// Gets a signed channel_announcement for this channel, if we previously received an
3970         /// announcement_signatures from our counterparty.
3971         pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
3972                 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
3973                         Ok(res) => res,
3974                         Err(_) => return None,
3975                 };
3976                 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
3977                 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
3978                         Ok(res) => Some(res),
3979                         Err(_) => None,
3980                 }
3981         }
3982
3983         /// May panic if called on a channel that wasn't immediately-previously
3984         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3985         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3986                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3987                 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3988                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3989                 // current to_remote balances. However, it no longer has any use, and thus is now simply
3990                 // set to a dummy (but valid, as required by the spec) public key.
3991                 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3992                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3993                 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3994                 let mut pk = [2; 33]; pk[1] = 0xff;
3995                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3996                 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3997                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
3998                         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()));
3999                         OptionalField::Present(DataLossProtect {
4000                                 your_last_per_commitment_secret: remote_last_secret,
4001                                 my_current_per_commitment_point: dummy_pubkey
4002                         })
4003                 } else {
4004                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4005                         OptionalField::Present(DataLossProtect {
4006                                 your_last_per_commitment_secret: [0;32],
4007                                 my_current_per_commitment_point: dummy_pubkey,
4008                         })
4009                 };
4010                 msgs::ChannelReestablish {
4011                         channel_id: self.channel_id(),
4012                         // The protocol has two different commitment number concepts - the "commitment
4013                         // transaction number", which starts from 0 and counts up, and the "revocation key
4014                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4015                         // commitment transaction numbers by the index which will be used to reveal the
4016                         // revocation key for that commitment transaction, which means we have to convert them
4017                         // to protocol-level commitment numbers here...
4018
4019                         // next_local_commitment_number is the next commitment_signed number we expect to
4020                         // receive (indicating if they need to resend one that we missed).
4021                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4022                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4023                         // receive, however we track it by the next commitment number for a remote transaction
4024                         // (which is one further, as they always revoke previous commitment transaction, not
4025                         // the one we send) so we have to decrement by 1. Note that if
4026                         // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4027                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4028                         // overflow here.
4029                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4030                         data_loss_protect,
4031                 }
4032         }
4033
4034
4035         // Send stuff to our remote peers:
4036
4037         /// Adds a pending outbound HTLC to this channel, note that you probably want
4038         /// send_htlc_and_commit instead cause you'll want both messages at once.
4039         ///
4040         /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4041         /// the wire:
4042         /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4043         ///   wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4044         ///   awaiting ACK.
4045         /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4046         ///   may not yet have sent the previous commitment update messages and will need to regenerate
4047         ///   them.
4048         ///
4049         /// You MUST call send_commitment prior to calling any other methods on this Channel!
4050         ///
4051         /// If an Err is returned, it's a ChannelError::Ignore!
4052         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> {
4053                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4054                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4055                 }
4056                 let channel_total_msat = self.channel_value_satoshis * 1000;
4057                 if amount_msat > channel_total_msat {
4058                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4059                 }
4060
4061                 if amount_msat == 0 {
4062                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4063                 }
4064
4065                 if amount_msat < self.counterparty_htlc_minimum_msat {
4066                         return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4067                 }
4068
4069                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4070                         // Note that this should never really happen, if we're !is_live() on receipt of an
4071                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4072                         // the user to send directly into a !is_live() channel. However, if we
4073                         // disconnected during the time the previous hop was doing the commitment dance we may
4074                         // end up getting here after the forwarding delay. In any case, returning an
4075                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4076                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4077                 }
4078
4079                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
4080                 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
4081                         return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4082                 }
4083                 // Check their_max_htlc_value_in_flight_msat
4084                 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4085                         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)));
4086                 }
4087
4088                 if !self.is_outbound() {
4089                         // Check that we won't violate the remote channel reserve by adding this HTLC.
4090                         let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4091                         let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
4092                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4093                         let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4094                         if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4095                                 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4096                         }
4097                 }
4098
4099                 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
4100                 if pending_value_to_self_msat < amount_msat {
4101                         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)));
4102                 }
4103
4104                 // `2 *` and extra HTLC are for the fee spike buffer.
4105                 let commit_tx_fee_msat = if self.is_outbound() {
4106                         let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4107                         2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4108                 } else { 0 };
4109                 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4110                         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)));
4111                 }
4112
4113                 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4114                 // reserve for the remote to have something to claim if we misbehave)
4115                 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis * 1000;
4116                 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4117                         return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4118                 }
4119
4120                 // Now update local state:
4121                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4122                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4123                                 amount_msat,
4124                                 payment_hash,
4125                                 cltv_expiry,
4126                                 source,
4127                                 onion_routing_packet,
4128                         });
4129                         return Ok(None);
4130                 }
4131
4132                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4133                         htlc_id: self.next_holder_htlc_id,
4134                         amount_msat,
4135                         payment_hash: payment_hash.clone(),
4136                         cltv_expiry,
4137                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4138                         source,
4139                 });
4140
4141                 let res = msgs::UpdateAddHTLC {
4142                         channel_id: self.channel_id,
4143                         htlc_id: self.next_holder_htlc_id,
4144                         amount_msat,
4145                         payment_hash,
4146                         cltv_expiry,
4147                         onion_routing_packet,
4148                 };
4149                 self.next_holder_htlc_id += 1;
4150
4151                 Ok(Some(res))
4152         }
4153
4154         /// Creates a signed commitment transaction to send to the remote peer.
4155         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4156         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4157         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4158         pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4159                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4160                         panic!("Cannot create commitment tx until channel is fully established");
4161                 }
4162                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4163                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
4164                 }
4165                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4166                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4167                 }
4168                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4169                         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");
4170                 }
4171                 let mut have_updates = self.pending_update_fee.is_some();
4172                 for htlc in self.pending_outbound_htlcs.iter() {
4173                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4174                                 have_updates = true;
4175                         }
4176                         if have_updates { break; }
4177                 }
4178                 for htlc in self.pending_inbound_htlcs.iter() {
4179                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4180                                 have_updates = true;
4181                         }
4182                         if have_updates { break; }
4183                 }
4184                 if !have_updates {
4185                         panic!("Cannot create commitment tx until we have some updates to send");
4186                 }
4187                 self.send_commitment_no_status_check(logger)
4188         }
4189         /// Only fails in case of bad keys
4190         fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4191                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4192                 // fail to generate this, we still are at least at a position where upgrading their status
4193                 // is acceptable.
4194                 for htlc in self.pending_inbound_htlcs.iter_mut() {
4195                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4196                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4197                         } else { None };
4198                         if let Some(state) = new_state {
4199                                 htlc.state = state;
4200                         }
4201                 }
4202                 for htlc in self.pending_outbound_htlcs.iter_mut() {
4203                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4204                                 Some(fail_reason.take())
4205                         } else { None } {
4206                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4207                         }
4208                 }
4209                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4210
4211                 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4212                         Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4213                                 // Update state now that we've passed all the can-fail calls...
4214                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4215                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4216                                 (res, counterparty_commitment_tx, htlcs_no_ref)
4217                         },
4218                         Err(e) => return Err(e),
4219                 };
4220
4221                 self.latest_monitor_update_id += 1;
4222                 let monitor_update = ChannelMonitorUpdate {
4223                         update_id: self.latest_monitor_update_id,
4224                         updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4225                                 commitment_txid: counterparty_commitment_txid,
4226                                 htlc_outputs: htlcs.clone(),
4227                                 commitment_number: self.cur_counterparty_commitment_transaction_number,
4228                                 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4229                         }]
4230                 };
4231                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4232                 Ok((res, monitor_update))
4233         }
4234
4235         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4236         /// when we shouldn't change HTLC/channel state.
4237         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4238                 let mut feerate_per_kw = self.feerate_per_kw;
4239                 if let Some(feerate) = self.pending_update_fee {
4240                         if self.is_outbound() {
4241                                 feerate_per_kw = feerate;
4242                         }
4243                 }
4244
4245                 let counterparty_keys = self.build_remote_transaction_keys()?;
4246                 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4247                 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4248                 let (signature, htlc_signatures);
4249
4250                 #[cfg(any(test, feature = "fuzztarget"))]
4251                 {
4252                         if !self.is_outbound() {
4253                                 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4254                                 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4255                                 if let Some(info) = projected_commit_tx_info {
4256                                         let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4257                                         if info.total_pending_htlcs == total_pending_htlcs
4258                                                 && info.next_holder_htlc_id == self.next_holder_htlc_id
4259                                                 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4260                                                 && info.feerate == self.feerate_per_kw {
4261                                                         let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4262                                                         assert_eq!(actual_fee, info.fee);
4263                                                 }
4264                                 }
4265                         }
4266                 }
4267
4268                 {
4269                         let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4270                         for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4271                                 htlcs.push(htlc);
4272                         }
4273
4274                         let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4275                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4276                         signature = res.0;
4277                         htlc_signatures = res.1;
4278
4279                         log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4280                                 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4281                                 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4282                                 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4283
4284                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4285                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4286                                         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)),
4287                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4288                                         log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4289                                         log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4290                         }
4291                 }
4292
4293                 Ok((msgs::CommitmentSigned {
4294                         channel_id: self.channel_id,
4295                         signature,
4296                         htlc_signatures,
4297                 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4298         }
4299
4300         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4301         /// to send to the remote peer in one go.
4302         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4303         /// more info.
4304         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 {
4305                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4306                         Some(update_add_htlc) => {
4307                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4308                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4309                         },
4310                         None => Ok(None)
4311                 }
4312         }
4313
4314         /// Get forwarding information for the counterparty.
4315         pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4316                 self.counterparty_forwarding_info.clone()
4317         }
4318
4319         pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4320                 let usable_channel_value_msat = (self.channel_value_satoshis - self.counterparty_selected_channel_reserve_satoshis) * 1000;
4321                 if msg.contents.htlc_minimum_msat >= usable_channel_value_msat {
4322                         return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4323                 }
4324                 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4325                         fee_base_msat: msg.contents.fee_base_msat,
4326                         fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4327                         cltv_expiry_delta: msg.contents.cltv_expiry_delta
4328                 });
4329
4330                 Ok(())
4331         }
4332
4333         /// Begins the shutdown process, getting a message for the remote peer and returning all
4334         /// holding cell HTLCs for payment failure.
4335         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
4336                 for htlc in self.pending_outbound_htlcs.iter() {
4337                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4338                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4339                         }
4340                 }
4341                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4342                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4343                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4344                         }
4345                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4346                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4347                         }
4348                 }
4349                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4350                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4351                         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()});
4352                 }
4353
4354                 let closing_script = self.get_closing_scriptpubkey();
4355
4356                 // From here on out, we may not fail!
4357                 if self.channel_state < ChannelState::FundingSent as u32 {
4358                         self.channel_state = ChannelState::ShutdownComplete as u32;
4359                 } else {
4360                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
4361                 }
4362                 self.update_time_counter += 1;
4363
4364                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4365                 // our shutdown until we've committed all of the pending changes.
4366                 self.holding_cell_update_fee = None;
4367                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4368                 self.holding_cell_htlc_updates.retain(|htlc_update| {
4369                         match htlc_update {
4370                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4371                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4372                                         false
4373                                 },
4374                                 _ => true
4375                         }
4376                 });
4377
4378                 Ok((msgs::Shutdown {
4379                         channel_id: self.channel_id,
4380                         scriptpubkey: closing_script,
4381                 }, dropped_outbound_htlcs))
4382         }
4383
4384         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4385         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4386         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4387         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4388         /// immediately (others we will have to allow to time out).
4389         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4390                 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4391                 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4392                 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4393                 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4394                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4395
4396                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4397                 // return them to fail the payment.
4398                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4399                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4400                         match htlc_update {
4401                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4402                                         dropped_outbound_htlcs.push((source, payment_hash));
4403                                 },
4404                                 _ => {}
4405                         }
4406                 }
4407                 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4408                         // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4409                         // returning a channel monitor update here would imply a channel monitor update before
4410                         // we even registered the channel monitor to begin with, which is invalid.
4411                         // Thus, if we aren't actually at a point where we could conceivably broadcast the
4412                         // funding transaction, don't return a funding txo (which prevents providing the
4413                         // monitor update to the user, even if we return one).
4414                         // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4415                         if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4416                                 self.latest_monitor_update_id += 1;
4417                                 Some((funding_txo, ChannelMonitorUpdate {
4418                                         update_id: self.latest_monitor_update_id,
4419                                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4420                                 }))
4421                         } else { None }
4422                 } else { None };
4423
4424                 self.channel_state = ChannelState::ShutdownComplete as u32;
4425                 self.update_time_counter += 1;
4426                 (monitor_update, dropped_outbound_htlcs)
4427         }
4428 }
4429
4430 fn is_unsupported_shutdown_script(their_features: &InitFeatures, script: &Script) -> bool {
4431         // We restrain shutdown scripts to standards forms to avoid transactions not propagating on the p2p tx-relay network
4432
4433         // BOLT 2 says we must only send a scriptpubkey of certain standard forms,
4434         // which for a a BIP-141-compliant witness program is at max 42 bytes in length.
4435         // So don't let the remote peer feed us some super fee-heavy script.
4436         let is_script_too_long = script.len() > 42;
4437         if is_script_too_long {
4438                 return true;
4439         }
4440
4441         if their_features.supports_shutdown_anysegwit() && script.is_witness_program() && script.as_bytes()[0] != OP_PUSHBYTES_0.into_u8() {
4442                 return false;
4443         }
4444
4445         return !script.is_p2pkh() && !script.is_p2sh() && !script.is_v0_p2wpkh() && !script.is_v0_p2wsh()
4446 }
4447
4448 const SERIALIZATION_VERSION: u8 = 1;
4449 const MIN_SERIALIZATION_VERSION: u8 = 1;
4450
4451 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4452         (0, FailRelay),
4453         (1, FailMalformed),
4454         (2, Fulfill),
4455 );
4456
4457 impl Writeable for ChannelUpdateStatus {
4458         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4459                 // We only care about writing out the current state as it was announced, ie only either
4460                 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4461                 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4462                 match self {
4463                         ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4464                         ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4465                         ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4466                         ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4467                 }
4468                 Ok(())
4469         }
4470 }
4471
4472 impl Readable for ChannelUpdateStatus {
4473         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4474                 Ok(match <u8 as Readable>::read(reader)? {
4475                         0 => ChannelUpdateStatus::Enabled,
4476                         1 => ChannelUpdateStatus::Disabled,
4477                         _ => return Err(DecodeError::InvalidValue),
4478                 })
4479         }
4480 }
4481
4482 impl<Signer: Sign> Writeable for Channel<Signer> {
4483         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4484                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4485                 // called.
4486
4487                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4488
4489                 self.user_id.write(writer)?;
4490                 self.config.write(writer)?;
4491
4492                 self.channel_id.write(writer)?;
4493                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4494                 self.channel_value_satoshis.write(writer)?;
4495
4496                 self.latest_monitor_update_id.write(writer)?;
4497
4498                 let mut key_data = VecWriter(Vec::new());
4499                 self.holder_signer.write(&mut key_data)?;
4500                 assert!(key_data.0.len() < core::usize::MAX);
4501                 assert!(key_data.0.len() < core::u32::MAX as usize);
4502                 (key_data.0.len() as u32).write(writer)?;
4503                 writer.write_all(&key_data.0[..])?;
4504
4505                 self.shutdown_pubkey.write(writer)?;
4506                 self.destination_script.write(writer)?;
4507
4508                 self.cur_holder_commitment_transaction_number.write(writer)?;
4509                 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4510                 self.value_to_self_msat.write(writer)?;
4511
4512                 let mut dropped_inbound_htlcs = 0;
4513                 for htlc in self.pending_inbound_htlcs.iter() {
4514                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4515                                 dropped_inbound_htlcs += 1;
4516                         }
4517                 }
4518                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4519                 for htlc in self.pending_inbound_htlcs.iter() {
4520                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4521                                 continue; // Drop
4522                         }
4523                         htlc.htlc_id.write(writer)?;
4524                         htlc.amount_msat.write(writer)?;
4525                         htlc.cltv_expiry.write(writer)?;
4526                         htlc.payment_hash.write(writer)?;
4527                         match &htlc.state {
4528                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4529                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4530                                         1u8.write(writer)?;
4531                                         htlc_state.write(writer)?;
4532                                 },
4533                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4534                                         2u8.write(writer)?;
4535                                         htlc_state.write(writer)?;
4536                                 },
4537                                 &InboundHTLCState::Committed => {
4538                                         3u8.write(writer)?;
4539                                 },
4540                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4541                                         4u8.write(writer)?;
4542                                         removal_reason.write(writer)?;
4543                                 },
4544                         }
4545                 }
4546
4547                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4548                 for htlc in self.pending_outbound_htlcs.iter() {
4549                         htlc.htlc_id.write(writer)?;
4550                         htlc.amount_msat.write(writer)?;
4551                         htlc.cltv_expiry.write(writer)?;
4552                         htlc.payment_hash.write(writer)?;
4553                         htlc.source.write(writer)?;
4554                         match &htlc.state {
4555                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4556                                         0u8.write(writer)?;
4557                                         onion_packet.write(writer)?;
4558                                 },
4559                                 &OutboundHTLCState::Committed => {
4560                                         1u8.write(writer)?;
4561                                 },
4562                                 &OutboundHTLCState::RemoteRemoved(_) => {
4563                                         // Treat this as a Committed because we haven't received the CS - they'll
4564                                         // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
4565                                         1u8.write(writer)?;
4566                                 },
4567                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4568                                         3u8.write(writer)?;
4569                                         fail_reason.write(writer)?;
4570                                 },
4571                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4572                                         4u8.write(writer)?;
4573                                         fail_reason.write(writer)?;
4574                                 },
4575                         }
4576                 }
4577
4578                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4579                 for update in self.holding_cell_htlc_updates.iter() {
4580                         match update {
4581                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4582                                         0u8.write(writer)?;
4583                                         amount_msat.write(writer)?;
4584                                         cltv_expiry.write(writer)?;
4585                                         payment_hash.write(writer)?;
4586                                         source.write(writer)?;
4587                                         onion_routing_packet.write(writer)?;
4588                                 },
4589                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4590                                         1u8.write(writer)?;
4591                                         payment_preimage.write(writer)?;
4592                                         htlc_id.write(writer)?;
4593                                 },
4594                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4595                                         2u8.write(writer)?;
4596                                         htlc_id.write(writer)?;
4597                                         err_packet.write(writer)?;
4598                                 }
4599                         }
4600                 }
4601
4602                 match self.resend_order {
4603                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4604                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4605                 }
4606
4607                 self.monitor_pending_funding_locked.write(writer)?;
4608                 self.monitor_pending_revoke_and_ack.write(writer)?;
4609                 self.monitor_pending_commitment_signed.write(writer)?;
4610
4611                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4612                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4613                         pending_forward.write(writer)?;
4614                         htlc_id.write(writer)?;
4615                 }
4616
4617                 (self.monitor_pending_failures.len() as u64).write(writer)?;
4618                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4619                         htlc_source.write(writer)?;
4620                         payment_hash.write(writer)?;
4621                         fail_reason.write(writer)?;
4622                 }
4623
4624                 self.pending_update_fee.write(writer)?;
4625                 self.holding_cell_update_fee.write(writer)?;
4626
4627                 self.next_holder_htlc_id.write(writer)?;
4628                 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4629                 self.update_time_counter.write(writer)?;
4630                 self.feerate_per_kw.write(writer)?;
4631
4632                 match self.last_sent_closing_fee {
4633                         Some((feerate, fee, sig)) => {
4634                                 1u8.write(writer)?;
4635                                 feerate.write(writer)?;
4636                                 fee.write(writer)?;
4637                                 sig.write(writer)?;
4638                         },
4639                         None => 0u8.write(writer)?,
4640                 }
4641
4642                 self.funding_tx_confirmed_in.write(writer)?;
4643                 self.funding_tx_confirmation_height.write(writer)?;
4644                 self.short_channel_id.write(writer)?;
4645
4646                 self.counterparty_dust_limit_satoshis.write(writer)?;
4647                 self.holder_dust_limit_satoshis.write(writer)?;
4648                 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4649                 self.counterparty_selected_channel_reserve_satoshis.write(writer)?;
4650                 self.counterparty_htlc_minimum_msat.write(writer)?;
4651                 self.holder_htlc_minimum_msat.write(writer)?;
4652                 self.counterparty_max_accepted_htlcs.write(writer)?;
4653                 self.minimum_depth.write(writer)?;
4654
4655                 match &self.counterparty_forwarding_info {
4656                         Some(info) => {
4657                                 1u8.write(writer)?;
4658                                 info.fee_base_msat.write(writer)?;
4659                                 info.fee_proportional_millionths.write(writer)?;
4660                                 info.cltv_expiry_delta.write(writer)?;
4661                         },
4662                         None => 0u8.write(writer)?
4663                 }
4664
4665                 self.channel_transaction_parameters.write(writer)?;
4666                 self.funding_transaction.write(writer)?;
4667
4668                 self.counterparty_cur_commitment_point.write(writer)?;
4669                 self.counterparty_prev_commitment_point.write(writer)?;
4670                 self.counterparty_node_id.write(writer)?;
4671
4672                 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4673
4674                 self.commitment_secrets.write(writer)?;
4675
4676                 self.channel_update_status.write(writer)?;
4677
4678                 write_tlv_fields!(writer, {(0, self.announcement_sigs, option)});
4679
4680                 Ok(())
4681         }
4682 }
4683
4684 const MAX_ALLOC_SIZE: usize = 64*1024;
4685 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4686                 where K::Target: KeysInterface<Signer = Signer> {
4687         fn read<R : ::std::io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4688                 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4689
4690                 let user_id = Readable::read(reader)?;
4691                 let config: ChannelConfig = Readable::read(reader)?;
4692
4693                 let channel_id = Readable::read(reader)?;
4694                 let channel_state = Readable::read(reader)?;
4695                 let channel_value_satoshis = Readable::read(reader)?;
4696
4697                 let latest_monitor_update_id = Readable::read(reader)?;
4698
4699                 let keys_len: u32 = Readable::read(reader)?;
4700                 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4701                 while keys_data.len() != keys_len as usize {
4702                         // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4703                         let mut data = [0; 1024];
4704                         let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4705                         reader.read_exact(read_slice)?;
4706                         keys_data.extend_from_slice(read_slice);
4707                 }
4708                 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4709
4710                 let shutdown_pubkey = Readable::read(reader)?;
4711                 let destination_script = Readable::read(reader)?;
4712
4713                 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4714                 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4715                 let value_to_self_msat = Readable::read(reader)?;
4716
4717                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4718                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4719                 for _ in 0..pending_inbound_htlc_count {
4720                         pending_inbound_htlcs.push(InboundHTLCOutput {
4721                                 htlc_id: Readable::read(reader)?,
4722                                 amount_msat: Readable::read(reader)?,
4723                                 cltv_expiry: Readable::read(reader)?,
4724                                 payment_hash: Readable::read(reader)?,
4725                                 state: match <u8 as Readable>::read(reader)? {
4726                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4727                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4728                                         3 => InboundHTLCState::Committed,
4729                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4730                                         _ => return Err(DecodeError::InvalidValue),
4731                                 },
4732                         });
4733                 }
4734
4735                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4736                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4737                 for _ in 0..pending_outbound_htlc_count {
4738                         pending_outbound_htlcs.push(OutboundHTLCOutput {
4739                                 htlc_id: Readable::read(reader)?,
4740                                 amount_msat: Readable::read(reader)?,
4741                                 cltv_expiry: Readable::read(reader)?,
4742                                 payment_hash: Readable::read(reader)?,
4743                                 source: Readable::read(reader)?,
4744                                 state: match <u8 as Readable>::read(reader)? {
4745                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4746                                         1 => OutboundHTLCState::Committed,
4747                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4748                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4749                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4750                                         _ => return Err(DecodeError::InvalidValue),
4751                                 },
4752                         });
4753                 }
4754
4755                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4756                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4757                 for _ in 0..holding_cell_htlc_update_count {
4758                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4759                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
4760                                         amount_msat: Readable::read(reader)?,
4761                                         cltv_expiry: Readable::read(reader)?,
4762                                         payment_hash: Readable::read(reader)?,
4763                                         source: Readable::read(reader)?,
4764                                         onion_routing_packet: Readable::read(reader)?,
4765                                 },
4766                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4767                                         payment_preimage: Readable::read(reader)?,
4768                                         htlc_id: Readable::read(reader)?,
4769                                 },
4770                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
4771                                         htlc_id: Readable::read(reader)?,
4772                                         err_packet: Readable::read(reader)?,
4773                                 },
4774                                 _ => return Err(DecodeError::InvalidValue),
4775                         });
4776                 }
4777
4778                 let resend_order = match <u8 as Readable>::read(reader)? {
4779                         0 => RAACommitmentOrder::CommitmentFirst,
4780                         1 => RAACommitmentOrder::RevokeAndACKFirst,
4781                         _ => return Err(DecodeError::InvalidValue),
4782                 };
4783
4784                 let monitor_pending_funding_locked = Readable::read(reader)?;
4785                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4786                 let monitor_pending_commitment_signed = Readable::read(reader)?;
4787
4788                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4789                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4790                 for _ in 0..monitor_pending_forwards_count {
4791                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4792                 }
4793
4794                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4795                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4796                 for _ in 0..monitor_pending_failures_count {
4797                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4798                 }
4799
4800                 let pending_update_fee = Readable::read(reader)?;
4801                 let holding_cell_update_fee = Readable::read(reader)?;
4802
4803                 let next_holder_htlc_id = Readable::read(reader)?;
4804                 let next_counterparty_htlc_id = Readable::read(reader)?;
4805                 let update_time_counter = Readable::read(reader)?;
4806                 let feerate_per_kw = Readable::read(reader)?;
4807
4808                 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4809                         0 => None,
4810                         1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4811                         _ => return Err(DecodeError::InvalidValue),
4812                 };
4813
4814                 let funding_tx_confirmed_in = Readable::read(reader)?;
4815                 let funding_tx_confirmation_height = Readable::read(reader)?;
4816                 let short_channel_id = Readable::read(reader)?;
4817
4818                 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4819                 let holder_dust_limit_satoshis = Readable::read(reader)?;
4820                 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4821                 let counterparty_selected_channel_reserve_satoshis = Readable::read(reader)?;
4822                 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4823                 let holder_htlc_minimum_msat = Readable::read(reader)?;
4824                 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4825                 let minimum_depth = Readable::read(reader)?;
4826
4827                 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
4828                         0 => None,
4829                         1 => Some(CounterpartyForwardingInfo {
4830                                 fee_base_msat: Readable::read(reader)?,
4831                                 fee_proportional_millionths: Readable::read(reader)?,
4832                                 cltv_expiry_delta: Readable::read(reader)?,
4833                         }),
4834                         _ => return Err(DecodeError::InvalidValue),
4835                 };
4836
4837                 let channel_parameters = Readable::read(reader)?;
4838                 let funding_transaction = Readable::read(reader)?;
4839
4840                 let counterparty_cur_commitment_point = Readable::read(reader)?;
4841
4842                 let counterparty_prev_commitment_point = Readable::read(reader)?;
4843                 let counterparty_node_id = Readable::read(reader)?;
4844
4845                 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
4846                 let commitment_secrets = Readable::read(reader)?;
4847
4848                 let channel_update_status = Readable::read(reader)?;
4849
4850                 let mut announcement_sigs = None;
4851                 read_tlv_fields!(reader, {(0, announcement_sigs, option)});
4852
4853                 let mut secp_ctx = Secp256k1::new();
4854                 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
4855
4856                 Ok(Channel {
4857                         user_id,
4858
4859                         config,
4860                         channel_id,
4861                         channel_state,
4862                         secp_ctx,
4863                         channel_value_satoshis,
4864
4865                         latest_monitor_update_id,
4866
4867                         holder_signer,
4868                         shutdown_pubkey,
4869                         destination_script,
4870
4871                         cur_holder_commitment_transaction_number,
4872                         cur_counterparty_commitment_transaction_number,
4873                         value_to_self_msat,
4874
4875                         pending_inbound_htlcs,
4876                         pending_outbound_htlcs,
4877                         holding_cell_htlc_updates,
4878
4879                         resend_order,
4880
4881                         monitor_pending_funding_locked,
4882                         monitor_pending_revoke_and_ack,
4883                         monitor_pending_commitment_signed,
4884                         monitor_pending_forwards,
4885                         monitor_pending_failures,
4886
4887                         pending_update_fee,
4888                         holding_cell_update_fee,
4889                         next_holder_htlc_id,
4890                         next_counterparty_htlc_id,
4891                         update_time_counter,
4892                         feerate_per_kw,
4893
4894                         #[cfg(debug_assertions)]
4895                         holder_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4896                         #[cfg(debug_assertions)]
4897                         counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4898
4899                         last_sent_closing_fee,
4900
4901                         funding_tx_confirmed_in,
4902                         funding_tx_confirmation_height,
4903                         short_channel_id,
4904
4905                         counterparty_dust_limit_satoshis,
4906                         holder_dust_limit_satoshis,
4907                         counterparty_max_htlc_value_in_flight_msat,
4908                         counterparty_selected_channel_reserve_satoshis,
4909                         counterparty_htlc_minimum_msat,
4910                         holder_htlc_minimum_msat,
4911                         counterparty_max_accepted_htlcs,
4912                         minimum_depth,
4913
4914                         counterparty_forwarding_info,
4915
4916                         channel_transaction_parameters: channel_parameters,
4917                         funding_transaction,
4918
4919                         counterparty_cur_commitment_point,
4920                         counterparty_prev_commitment_point,
4921                         counterparty_node_id,
4922
4923                         counterparty_shutdown_scriptpubkey,
4924
4925                         commitment_secrets,
4926
4927                         channel_update_status,
4928
4929                         announcement_sigs,
4930
4931                         #[cfg(any(test, feature = "fuzztarget"))]
4932                         next_local_commitment_tx_fee_info_cached: Mutex::new(None),
4933                         #[cfg(any(test, feature = "fuzztarget"))]
4934                         next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
4935
4936                         workaround_lnd_bug_4006: None,
4937                 })
4938         }
4939 }
4940
4941 #[cfg(test)]
4942 mod tests {
4943         use bitcoin::util::bip143;
4944         use bitcoin::consensus::encode::serialize;
4945         use bitcoin::blockdata::script::{Script, Builder};
4946         use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
4947         use bitcoin::blockdata::constants::genesis_block;
4948         use bitcoin::blockdata::opcodes;
4949         use bitcoin::network::constants::Network;
4950         use bitcoin::hashes::hex::FromHex;
4951         use hex;
4952         use ln::{PaymentPreimage, PaymentHash};
4953         use ln::channelmanager::{BestBlock, HTLCSource};
4954         use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
4955         use ln::channel::MAX_FUNDING_SATOSHIS;
4956         use ln::features::InitFeatures;
4957         use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
4958         use ln::chan_utils;
4959         use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
4960         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4961         use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
4962         use chain::transaction::OutPoint;
4963         use util::config::UserConfig;
4964         use util::enforcing_trait_impls::EnforcingSigner;
4965         use util::test_utils;
4966         use util::logger::Logger;
4967         use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4968         use bitcoin::secp256k1::ffi::Signature as FFISignature;
4969         use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4970         use bitcoin::secp256k1::recovery::RecoverableSignature;
4971         use bitcoin::hashes::sha256::Hash as Sha256;
4972         use bitcoin::hashes::Hash;
4973         use bitcoin::hash_types::{Txid, WPubkeyHash};
4974         use std::sync::Arc;
4975         use prelude::*;
4976
4977         struct TestFeeEstimator {
4978                 fee_est: u32
4979         }
4980         impl FeeEstimator for TestFeeEstimator {
4981                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
4982                         self.fee_est
4983                 }
4984         }
4985
4986         #[test]
4987         fn test_max_funding_satoshis() {
4988                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4989                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4990         }
4991
4992         struct Keys {
4993                 signer: InMemorySigner,
4994         }
4995         impl KeysInterface for Keys {
4996                 type Signer = InMemorySigner;
4997
4998                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4999                 fn get_destination_script(&self) -> Script {
5000                         let secp_ctx = Secp256k1::signing_only();
5001                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5002                         let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5003                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5004                 }
5005
5006                 fn get_shutdown_pubkey(&self) -> PublicKey {
5007                         let secp_ctx = Secp256k1::signing_only();
5008                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5009                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
5010                 }
5011
5012                 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5013                         self.signer.clone()
5014                 }
5015                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5016                 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5017                 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5018         }
5019
5020         fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5021                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5022         }
5023
5024         // Check that, during channel creation, we use the same feerate in the open channel message
5025         // as we do in the Channel object creation itself.
5026         #[test]
5027         fn test_open_channel_msg_fee() {
5028                 let original_fee = 253;
5029                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5030                 let secp_ctx = Secp256k1::new();
5031                 let seed = [42; 32];
5032                 let network = Network::Testnet;
5033                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5034
5035                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5036                 let config = UserConfig::default();
5037                 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
5038
5039                 // Now change the fee so we can check that the fee in the open_channel message is the
5040                 // same as the old fee.
5041                 fee_est.fee_est = 500;
5042                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5043                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5044         }
5045
5046         #[test]
5047         fn test_holder_vs_counterparty_dust_limit() {
5048                 // Test that when calculating the local and remote commitment transaction fees, the correct
5049                 // dust limits are used.
5050                 let feeest = TestFeeEstimator{fee_est: 15000};
5051                 let secp_ctx = Secp256k1::new();
5052                 let seed = [42; 32];
5053                 let network = Network::Testnet;
5054                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5055
5056                 // Go through the flow of opening a channel between two nodes, making sure
5057                 // they have different dust limits.
5058
5059                 // Create Node A's channel pointing to Node B's pubkey
5060                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5061                 let config = UserConfig::default();
5062                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5063
5064                 // Create Node B's channel by receiving Node A's open_channel message
5065                 // Make sure A's dust limit is as we expect.
5066                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5067                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5068                 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5069
5070                 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5071                 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5072                 accept_channel_msg.dust_limit_satoshis = 546;
5073                 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5074                 node_a_chan.holder_dust_limit_satoshis = 1560;
5075
5076                 // Put some inbound and outbound HTLCs in A's channel.
5077                 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5078                 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5079                         htlc_id: 0,
5080                         amount_msat: htlc_amount_msat,
5081                         payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5082                         cltv_expiry: 300000000,
5083                         state: InboundHTLCState::Committed,
5084                 });
5085
5086                 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5087                         htlc_id: 1,
5088                         amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5089                         payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5090                         cltv_expiry: 200000000,
5091                         state: OutboundHTLCState::Committed,
5092                         source: HTLCSource::OutboundRoute {
5093                                 path: Vec::new(),
5094                                 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5095                                 first_hop_htlc_msat: 548,
5096                         }
5097                 });
5098
5099                 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5100                 // the dust limit check.
5101                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5102                 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5103                 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5104                 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5105
5106                 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5107                 // of the HTLCs are seen to be above the dust limit.
5108                 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5109                 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5110                 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5111                 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5112                 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5113         }
5114
5115         #[test]
5116         fn test_timeout_vs_success_htlc_dust_limit() {
5117                 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5118                 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5119                 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5120                 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5121                 let fee_est = TestFeeEstimator{fee_est: 253 };
5122                 let secp_ctx = Secp256k1::new();
5123                 let seed = [42; 32];
5124                 let network = Network::Testnet;
5125                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5126
5127                 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5128                 let config = UserConfig::default();
5129                 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, 10000000, 100000, 42, &config).unwrap();
5130
5131                 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5132                 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5133
5134                 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5135                 // counted as dust when it shouldn't be.
5136                 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5137                 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5138                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5139                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5140
5141                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5142                 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5143                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5144                 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5145                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5146
5147                 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5148
5149                 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5150                 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5151                 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5152                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5153                 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5154
5155                 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5156                 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5157                 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5158                 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5159                 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5160         }
5161
5162         #[test]
5163         fn channel_reestablish_no_updates() {
5164                 let feeest = TestFeeEstimator{fee_est: 15000};
5165                 let logger = test_utils::TestLogger::new();
5166                 let secp_ctx = Secp256k1::new();
5167                 let seed = [42; 32];
5168                 let network = Network::Testnet;
5169                 let best_block = BestBlock::from_genesis(network);
5170                 let chain_hash = best_block.block_hash();
5171                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5172
5173                 // Go through the flow of opening a channel between two nodes.
5174
5175                 // Create Node A's channel pointing to Node B's pubkey
5176                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5177                 let config = UserConfig::default();
5178                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5179
5180                 // Create Node B's channel by receiving Node A's open_channel message
5181                 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5182                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5183                 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();
5184
5185                 // Node B --> Node A: accept channel
5186                 let accept_channel_msg = node_b_chan.get_accept_channel();
5187                 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5188
5189                 // Node A --> Node B: funding created
5190                 let output_script = node_a_chan.get_funding_redeemscript();
5191                 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5192                         value: 10000000, script_pubkey: output_script.clone(),
5193                 }]};
5194                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5195                 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5196                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5197
5198                 // Node B --> Node A: funding signed
5199                 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5200
5201                 // Now disconnect the two nodes and check that the commitment point in
5202                 // Node B's channel_reestablish message is sane.
5203                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5204                 let msg = node_b_chan.get_channel_reestablish(&&logger);
5205                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5206                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5207                 match msg.data_loss_protect {
5208                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5209                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5210                         },
5211                         _ => panic!()
5212                 }
5213
5214                 // Check that the commitment point in Node A's channel_reestablish message
5215                 // is sane.
5216                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5217                 let msg = node_a_chan.get_channel_reestablish(&&logger);
5218                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5219                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5220                 match msg.data_loss_protect {
5221                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5222                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5223                         },
5224                         _ => panic!()
5225                 }
5226         }
5227
5228         #[test]
5229         fn channel_update() {
5230                 let feeest = TestFeeEstimator{fee_est: 15000};
5231                 let secp_ctx = Secp256k1::new();
5232                 let seed = [42; 32];
5233                 let network = Network::Testnet;
5234                 let chain_hash = genesis_block(network).header.block_hash();
5235                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5236
5237                 // Create a channel.
5238                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5239                 let config = UserConfig::default();
5240                 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5241                 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5242                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5243                 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5244
5245                 // Make sure that receiving a channel update will update the Channel as expected.
5246                 let update = ChannelUpdate {
5247                         contents: UnsignedChannelUpdate {
5248                                 chain_hash,
5249                                 short_channel_id: 0,
5250                                 timestamp: 0,
5251                                 flags: 0,
5252                                 cltv_expiry_delta: 100,
5253                                 htlc_minimum_msat: 5,
5254                                 htlc_maximum_msat: OptionalField::Absent,
5255                                 fee_base_msat: 110,
5256                                 fee_proportional_millionths: 11,
5257                                 excess_data: Vec::new(),
5258                         },
5259                         signature: Signature::from(unsafe { FFISignature::new() })
5260                 };
5261                 node_a_chan.channel_update(&update).unwrap();
5262
5263                 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5264                 // change our official htlc_minimum_msat.
5265                 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5266                 match node_a_chan.counterparty_forwarding_info() {
5267                         Some(info) => {
5268                                 assert_eq!(info.cltv_expiry_delta, 100);
5269                                 assert_eq!(info.fee_base_msat, 110);
5270                                 assert_eq!(info.fee_proportional_millionths, 11);
5271                         },
5272                         None => panic!("expected counterparty forwarding info to be Some")
5273                 }
5274         }
5275
5276         #[test]
5277         fn outbound_commitment_test() {
5278                 // Test vectors from BOLT 3 Appendix C:
5279                 let feeest = TestFeeEstimator{fee_est: 15000};
5280                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5281                 let secp_ctx = Secp256k1::new();
5282
5283                 let mut signer = InMemorySigner::new(
5284                         &secp_ctx,
5285                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5286                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5287                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5288                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5289                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5290
5291                         // These aren't set in the test vectors:
5292                         [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],
5293                         10_000_000,
5294                         [0; 32]
5295                 );
5296
5297                 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5298                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5299                 let keys_provider = Keys { signer: signer.clone() };
5300
5301                 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5302                 let mut config = UserConfig::default();
5303                 config.channel_options.announced_channel = false;
5304                 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
5305                 chan.holder_dust_limit_satoshis = 546;
5306
5307                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5308
5309                 let counterparty_pubkeys = ChannelPublicKeys {
5310                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5311                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5312                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5313                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5314                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5315                 };
5316                 chan.channel_transaction_parameters.counterparty_parameters = Some(
5317                         CounterpartyChannelTransactionParameters {
5318                                 pubkeys: counterparty_pubkeys.clone(),
5319                                 selected_contest_delay: 144
5320                         });
5321                 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5322                 signer.ready_channel(&chan.channel_transaction_parameters);
5323
5324                 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5325                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5326
5327                 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5328                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5329
5330                 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5331                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5332
5333                 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5334                 // derived from a commitment_seed, so instead we copy it here and call
5335                 // build_commitment_transaction.
5336                 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5337                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5338                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5339                 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5340                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5341
5342                 macro_rules! test_commitment {
5343                         ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5344                                 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5345                         } ) => { {
5346                                 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5347                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5348
5349                                         let htlcs = res.2.drain(..)
5350                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5351                                                 .collect();
5352                                         (res.0, htlcs)
5353                                 };
5354                                 let trusted_tx = commitment_tx.trust();
5355                                 let unsigned_tx = trusted_tx.built_transaction();
5356                                 let redeemscript = chan.get_funding_redeemscript();
5357                                 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5358                                 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5359                                 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5360
5361                                 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5362                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5363                                 let mut counterparty_htlc_sigs = Vec::new();
5364                                 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5365                                 $({
5366                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5367                                         per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5368                                         counterparty_htlc_sigs.push(remote_signature);
5369                                 })*
5370                                 assert_eq!(htlcs.len(), per_htlc.len());
5371
5372                                 let holder_commitment_tx = HolderCommitmentTransaction::new(
5373                                         commitment_tx.clone(),
5374                                         counterparty_signature,
5375                                         counterparty_htlc_sigs,
5376                                         &chan.holder_signer.pubkeys().funding_pubkey,
5377                                         chan.counterparty_funding_pubkey()
5378                                 );
5379                                 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5380                                 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5381
5382                                 let funding_redeemscript = chan.get_funding_redeemscript();
5383                                 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5384                                 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5385
5386                                 // ((htlc, counterparty_sig), (index, holder_sig))
5387                                 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5388
5389                                 $({
5390                                         let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5391
5392                                         let ref htlc = htlcs[$htlc_idx];
5393                                         let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.txid, &htlc, true, &keys, chan.feerate_per_kw);
5394                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5395                                         let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5396                                         secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5397
5398                                         let mut preimage: Option<PaymentPreimage> = None;
5399                                         if !htlc.offered {
5400                                                 for i in 0..5 {
5401                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5402                                                         if out == htlc.payment_hash {
5403                                                                 preimage = Some(PaymentPreimage([i; 32]));
5404                                                         }
5405                                                 }
5406
5407                                                 assert!(preimage.is_some());
5408                                         }
5409
5410                                         let htlc_sig = htlc_sig_iter.next().unwrap();
5411                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5412
5413                                         let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5414                                         assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5415                                         let index = (htlc_sig.1).0;
5416                                         let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5417                                         let trusted_tx = holder_commitment_tx.trust();
5418                                         assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5419                                                         hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5420                                 })*
5421                                 assert!(htlc_sig_iter.next().is_none());
5422                         } }
5423                 }
5424
5425                 // simple commitment tx with no HTLCs
5426                 chan.value_to_self_msat = 7000000000;
5427
5428                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5429                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5430                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5431
5432                 chan.pending_inbound_htlcs.push({
5433                         let mut out = InboundHTLCOutput{
5434                                 htlc_id: 0,
5435                                 amount_msat: 1000000,
5436                                 cltv_expiry: 500,
5437                                 payment_hash: PaymentHash([0; 32]),
5438                                 state: InboundHTLCState::Committed,
5439                         };
5440                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5441                         out
5442                 });
5443                 chan.pending_inbound_htlcs.push({
5444                         let mut out = InboundHTLCOutput{
5445                                 htlc_id: 1,
5446                                 amount_msat: 2000000,
5447                                 cltv_expiry: 501,
5448                                 payment_hash: PaymentHash([0; 32]),
5449                                 state: InboundHTLCState::Committed,
5450                         };
5451                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5452                         out
5453                 });
5454                 chan.pending_outbound_htlcs.push({
5455                         let mut out = OutboundHTLCOutput{
5456                                 htlc_id: 2,
5457                                 amount_msat: 2000000,
5458                                 cltv_expiry: 502,
5459                                 payment_hash: PaymentHash([0; 32]),
5460                                 state: OutboundHTLCState::Committed,
5461                                 source: HTLCSource::dummy(),
5462                         };
5463                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5464                         out
5465                 });
5466                 chan.pending_outbound_htlcs.push({
5467                         let mut out = OutboundHTLCOutput{
5468                                 htlc_id: 3,
5469                                 amount_msat: 3000000,
5470                                 cltv_expiry: 503,
5471                                 payment_hash: PaymentHash([0; 32]),
5472                                 state: OutboundHTLCState::Committed,
5473                                 source: HTLCSource::dummy(),
5474                         };
5475                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5476                         out
5477                 });
5478                 chan.pending_inbound_htlcs.push({
5479                         let mut out = InboundHTLCOutput{
5480                                 htlc_id: 4,
5481                                 amount_msat: 4000000,
5482                                 cltv_expiry: 504,
5483                                 payment_hash: PaymentHash([0; 32]),
5484                                 state: InboundHTLCState::Committed,
5485                         };
5486                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5487                         out
5488                 });
5489
5490                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5491                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5492                 chan.feerate_per_kw = 0;
5493
5494                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5495                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5496                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5497
5498                                   { 0,
5499                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5500                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5501                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5502
5503                                   { 1,
5504                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5505                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5506                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5507
5508                                   { 2,
5509                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5510                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5511                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5512
5513                                   { 3,
5514                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5515                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5516                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5517
5518                                   { 4,
5519                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5520                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5521                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5522                 } );
5523
5524                 // commitment tx with seven outputs untrimmed (maximum feerate)
5525                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5526                 chan.feerate_per_kw = 647;
5527
5528                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5529                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5530                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5531
5532                                   { 0,
5533                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5534                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5535                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5536
5537                                   { 1,
5538                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5539                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5540                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5541
5542                                   { 2,
5543                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5544                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5545                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5546
5547                                   { 3,
5548                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5549                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5550                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5551
5552                                   { 4,
5553                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5554                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5555                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5556                 } );
5557
5558                 // commitment tx with six outputs untrimmed (minimum feerate)
5559                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5560                 chan.feerate_per_kw = 648;
5561
5562                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5563                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5564                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5565
5566                                   { 0,
5567                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5568                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5569                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5570
5571                                   { 1,
5572                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5573                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5574                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5575
5576                                   { 2,
5577                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5578                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5579                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5580
5581                                   { 3,
5582                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5583                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5584                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5585                 } );
5586
5587                 // commitment tx with six outputs untrimmed (maximum feerate)
5588                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5589                 chan.feerate_per_kw = 2069;
5590
5591                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5592                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5593                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5594
5595                                   { 0,
5596                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5597                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5598                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5599
5600                                   { 1,
5601                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5602                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5603                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5604
5605                                   { 2,
5606                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5607                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5608                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5609
5610                                   { 3,
5611                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5612                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5613                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5614                 } );
5615
5616                 // commitment tx with five outputs untrimmed (minimum feerate)
5617                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5618                 chan.feerate_per_kw = 2070;
5619
5620                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5621                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5622                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5623
5624                                   { 0,
5625                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5626                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5627                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5628
5629                                   { 1,
5630                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5631                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5632                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5633
5634                                   { 2,
5635                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5636                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5637                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5638                 } );
5639
5640                 // commitment tx with five outputs untrimmed (maximum feerate)
5641                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5642                 chan.feerate_per_kw = 2194;
5643
5644                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5645                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5646                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5647
5648                                   { 0,
5649                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5650                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5651                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5652
5653                                   { 1,
5654                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5655                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5656                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5657
5658                                   { 2,
5659                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5660                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5661                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5662                 } );
5663
5664                 // commitment tx with four outputs untrimmed (minimum feerate)
5665                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5666                 chan.feerate_per_kw = 2195;
5667
5668                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5669                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5670                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5671
5672                                   { 0,
5673                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5674                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5675                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5676
5677                                   { 1,
5678                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5679                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5680                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5681                 } );
5682
5683                 // commitment tx with four outputs untrimmed (maximum feerate)
5684                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5685                 chan.feerate_per_kw = 3702;
5686
5687                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5688                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5689                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5690
5691                                   { 0,
5692                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5693                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5694                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5695
5696                                   { 1,
5697                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5698                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5699                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5700                 } );
5701
5702                 // commitment tx with three outputs untrimmed (minimum feerate)
5703                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5704                 chan.feerate_per_kw = 3703;
5705
5706                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5707                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5708                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5709
5710                                   { 0,
5711                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5712                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5713                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5714                 } );
5715
5716                 // commitment tx with three outputs untrimmed (maximum feerate)
5717                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5718                 chan.feerate_per_kw = 4914;
5719
5720                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5721                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5722                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5723
5724                                   { 0,
5725                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5726                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5727                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5728                 } );
5729
5730                 // commitment tx with two outputs untrimmed (minimum feerate)
5731                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5732                 chan.feerate_per_kw = 4915;
5733
5734                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5735                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5736                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5737
5738                 // commitment tx with two outputs untrimmed (maximum feerate)
5739                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5740                 chan.feerate_per_kw = 9651180;
5741
5742                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5743                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5744                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5745
5746                 // commitment tx with one output untrimmed (minimum feerate)
5747                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5748                 chan.feerate_per_kw = 9651181;
5749
5750                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5751                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5752                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5753
5754                 // commitment tx with fee greater than funder amount
5755                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5756                 chan.feerate_per_kw = 9651936;
5757
5758                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5759                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5760                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5761
5762                 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5763                 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5764                 chan.feerate_per_kw = 253;
5765                 chan.pending_inbound_htlcs.clear();
5766                 chan.pending_inbound_htlcs.push({
5767                         let mut out = InboundHTLCOutput{
5768                                 htlc_id: 1,
5769                                 amount_msat: 2000000,
5770                                 cltv_expiry: 501,
5771                                 payment_hash: PaymentHash([0; 32]),
5772                                 state: InboundHTLCState::Committed,
5773                         };
5774                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5775                         out
5776                 });
5777                 chan.pending_outbound_htlcs.clear();
5778                 chan.pending_outbound_htlcs.push({
5779                         let mut out = OutboundHTLCOutput{
5780                                 htlc_id: 6,
5781                                 amount_msat: 5000000,
5782                                 cltv_expiry: 506,
5783                                 payment_hash: PaymentHash([0; 32]),
5784                                 state: OutboundHTLCState::Committed,
5785                                 source: HTLCSource::dummy(),
5786                         };
5787                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5788                         out
5789                 });
5790                 chan.pending_outbound_htlcs.push({
5791                         let mut out = OutboundHTLCOutput{
5792                                 htlc_id: 5,
5793                                 amount_msat: 5000000,
5794                                 cltv_expiry: 505,
5795                                 payment_hash: PaymentHash([0; 32]),
5796                                 state: OutboundHTLCState::Committed,
5797                                 source: HTLCSource::dummy(),
5798                         };
5799                         out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5800                         out
5801                 });
5802
5803                 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
5804                                  "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
5805                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5806
5807                                   { 0,
5808                                   "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
5809                                   "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
5810                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5811                                   { 1,
5812                                   "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
5813                                   "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
5814                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
5815                                   { 2,
5816                                   "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
5817                                   "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
5818                                   "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
5819                 } );
5820         }
5821
5822         #[test]
5823         fn test_per_commitment_secret_gen() {
5824                 // Test vectors from BOLT 3 Appendix D:
5825
5826                 let mut seed = [0; 32];
5827                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5828                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5829                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5830
5831                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5832                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5833                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5834
5835                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5836                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5837
5838                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5839                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5840
5841                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5842                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5843                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5844         }
5845
5846         #[test]
5847         fn test_key_derivation() {
5848                 // Test vectors from BOLT 3 Appendix E:
5849                 let secp_ctx = Secp256k1::new();
5850
5851                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5852                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5853
5854                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5855                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5856
5857                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5858                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5859
5860                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5861                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5862
5863                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5864                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
5865
5866                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5867                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
5868
5869                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
5870                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
5871         }
5872 }