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