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