Drop time_created in HTLCAwaitingACK::AddHTLC (we can use the CLTV)
[rust-lightning] / src / ln / channel.rs
1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::BitcoinHash;
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
8
9 use bitcoin_hashes::{Hash, HashEngine};
10 use bitcoin_hashes::sha256::Hash as Sha256;
11 use bitcoin_hashes::hash160::Hash as Hash160;
12 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
13
14 use secp256k1::key::{PublicKey,SecretKey};
15 use secp256k1::{Secp256k1,Signature};
16 use secp256k1;
17
18 use ln::msgs;
19 use ln::msgs::{DecodeError, OptionalField};
20 use ln::channelmonitor::ChannelMonitor;
21 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash};
22 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
23 use ln::chan_utils;
24 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
25 use chain::transaction::OutPoint;
26 use chain::keysinterface::{ChannelKeys, KeysInterface};
27 use util::transaction_utils;
28 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
29 use util::logger::{Logger, LogHolder};
30 use util::errors::APIError;
31 use util::config::{UserConfig,ChannelConfig};
32
33 use std;
34 use std::default::Default;
35 use std::{cmp,mem};
36 use std::sync::{Arc};
37
38 #[cfg(test)]
39 pub struct ChannelValueStat {
40         pub value_to_self_msat: u64,
41         pub channel_value_msat: u64,
42         pub channel_reserve_msat: u64,
43         pub pending_outbound_htlcs_amount_msat: u64,
44         pub pending_inbound_htlcs_amount_msat: u64,
45         pub holding_cell_outbound_amount_msat: u64,
46         pub their_max_htlc_value_in_flight_msat: u64, // outgoing
47 }
48
49 enum InboundHTLCRemovalReason {
50         FailRelay(msgs::OnionErrorPacket),
51         FailMalformed(([u8; 32], u16)),
52         Fulfill(PaymentPreimage),
53 }
54
55 enum InboundHTLCState {
56         /// Added by remote, to be included in next local commitment tx.
57         RemoteAnnounced(PendingHTLCStatus),
58         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
59         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
60         /// accept this HTLC. Implies AwaitingRemoteRevoke.
61         /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
62         /// a remote revoke_and_ack on a previous state before we can do so.
63         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
64         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
65         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
66         /// accept this HTLC. Implies AwaitingRemoteRevoke.
67         /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
68         /// revoke_and_ack.
69         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
70         Committed,
71         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
72         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
73         /// we'll drop it.
74         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
75         /// commitment transaction without it as otherwise we'll have to force-close the channel to
76         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
77         /// anyway). That said, ChannelMonitor does this for us (see
78         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
79         /// local state before then, once we're sure that the next commitment_signed and
80         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
81         LocalRemoved(InboundHTLCRemovalReason),
82 }
83
84 struct InboundHTLCOutput {
85         htlc_id: u64,
86         amount_msat: u64,
87         cltv_expiry: u32,
88         payment_hash: PaymentHash,
89         state: InboundHTLCState,
90 }
91
92 enum OutboundHTLCState {
93         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
94         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
95         /// we will promote to Committed (note that they may not accept it until the next time we
96         /// revoke, but we don't really care about that:
97         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
98         ///    money back (though we won't), and,
99         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
100         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
101         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
102         ///    we'll never get out of sync).
103         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
104         /// OutboundHTLCOutput's size just for a temporary bit
105         LocalAnnounced(Box<msgs::OnionPacket>),
106         Committed,
107         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
108         /// the change (though they'll need to revoke before we fail the payment).
109         RemoteRemoved(Option<HTLCFailReason>),
110         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
111         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
113         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
114         /// remote revoke_and_ack on a previous state before we can do so.
115         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
116         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
117         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
119         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
120         /// revoke_and_ack to drop completely.
121         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
122 }
123
124 struct OutboundHTLCOutput {
125         htlc_id: u64,
126         amount_msat: u64,
127         cltv_expiry: u32,
128         payment_hash: PaymentHash,
129         state: OutboundHTLCState,
130         source: HTLCSource,
131 }
132
133 /// See AwaitingRemoteRevoke ChannelState for more info
134 enum HTLCUpdateAwaitingACK {
135         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
136                 // always outbound
137                 amount_msat: u64,
138                 cltv_expiry: u32,
139                 payment_hash: PaymentHash,
140                 source: HTLCSource,
141                 onion_routing_packet: msgs::OnionPacket,
142         },
143         ClaimHTLC {
144                 payment_preimage: PaymentPreimage,
145                 htlc_id: u64,
146         },
147         FailHTLC {
148                 htlc_id: u64,
149                 err_packet: msgs::OnionErrorPacket,
150         },
151 }
152
153 /// There are a few "states" and then a number of flags which can be applied:
154 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
155 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
156 /// move on to ChannelFunded.
157 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
158 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
159 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
160 enum ChannelState {
161         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
162         OurInitSent = (1 << 0),
163         /// Implies we have received their open_channel/accept_channel message
164         TheirInitSent = (1 << 1),
165         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
166         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
167         /// upon receipt of funding_created, so simply skip this state.
168         FundingCreated = 4,
169         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
170         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
171         /// and our counterparty consider the funding transaction confirmed.
172         FundingSent = 8,
173         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
174         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
175         TheirFundingLocked = (1 << 4),
176         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
177         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
178         OurFundingLocked = (1 << 5),
179         ChannelFunded = 64,
180         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
181         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
182         /// dance.
183         PeerDisconnected = (1 << 7),
184         /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
185         /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
186         /// messages until they've managed to do so.
187         MonitorUpdateFailed = (1 << 8),
188         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
189         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
190         /// messages as then we will be unable to determine which HTLCs they included in their
191         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
192         /// later.
193         /// Flag is set on ChannelFunded.
194         AwaitingRemoteRevoke = (1 << 9),
195         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
196         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
197         /// to respond with our own shutdown message when possible.
198         RemoteShutdownSent = (1 << 10),
199         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
200         /// point, we may not add any new HTLCs to the channel.
201         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
202         /// us their shutdown.
203         LocalShutdownSent = (1 << 11),
204         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
205         /// to drop us, but we store this anyway.
206         ShutdownComplete = 4096,
207 }
208 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
209 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
210
211 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
212
213 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
214 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
215 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
216 // inbound channel.
217 pub(super) struct Channel {
218         config: ChannelConfig,
219
220         user_id: u64,
221
222         channel_id: [u8; 32],
223         channel_state: u32,
224         channel_outbound: bool,
225         secp_ctx: Secp256k1<secp256k1::All>,
226         channel_value_satoshis: u64,
227
228         local_keys: ChannelKeys,
229         shutdown_pubkey: PublicKey,
230
231         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
232         // generation start at 0 and count up...this simplifies some parts of implementation at the
233         // cost of others, but should really just be changed.
234
235         cur_local_commitment_transaction_number: u64,
236         cur_remote_commitment_transaction_number: u64,
237         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
238         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
239         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
240         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
241
242         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
243         /// need to ensure we resend them in the order we originally generated them. Note that because
244         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
245         /// sufficient to simply set this to the opposite of any message we are generating as we
246         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
247         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
248         /// send it first.
249         resend_order: RAACommitmentOrder,
250
251         monitor_pending_revoke_and_ack: bool,
252         monitor_pending_commitment_signed: bool,
253         monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
254         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
255
256         // pending_update_fee is filled when sending and receiving update_fee
257         // For outbound channel, feerate_per_kw is updated with the value from
258         // pending_update_fee when revoke_and_ack is received
259         //
260         // For inbound channel, feerate_per_kw is updated when it receives
261         // commitment_signed and revoke_and_ack is generated
262         // The pending value is kept when another pair of update_fee and commitment_signed
263         // is received during AwaitingRemoteRevoke and relieved when the expected
264         // revoke_and_ack is received and new commitment_signed is generated to be
265         // sent to the funder. Otherwise, the pending value is removed when receiving
266         // commitment_signed.
267         pending_update_fee: Option<u64>,
268         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
269         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
270         // is received. holding_cell_update_fee is updated when there are additional
271         // update_fee() during ChannelState::AwaitingRemoteRevoke.
272         holding_cell_update_fee: Option<u64>,
273         next_local_htlc_id: u64,
274         next_remote_htlc_id: u64,
275         channel_update_count: u32,
276         feerate_per_kw: u64,
277
278         #[cfg(debug_assertions)]
279         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
280         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
281         #[cfg(debug_assertions)]
282         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
283         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
284
285         #[cfg(test)]
286         // Used in ChannelManager's tests to send a revoked transaction
287         pub last_local_commitment_txn: Vec<Transaction>,
288         #[cfg(not(test))]
289         last_local_commitment_txn: Vec<Transaction>,
290
291         last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
292
293         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
294         /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
295         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
296         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
297         funding_tx_confirmed_in: Option<Sha256dHash>,
298         short_channel_id: Option<u64>,
299         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
300         /// ChannelManager deserialization (hence pub(super))
301         pub(super) last_block_connected: Sha256dHash,
302         funding_tx_confirmations: u64,
303
304         their_dust_limit_satoshis: u64,
305         #[cfg(test)]
306         pub(super) our_dust_limit_satoshis: u64,
307         #[cfg(not(test))]
308         our_dust_limit_satoshis: u64,
309         #[cfg(test)]
310         pub(super) their_max_htlc_value_in_flight_msat: u64,
311         #[cfg(not(test))]
312         their_max_htlc_value_in_flight_msat: u64,
313         //get_our_max_htlc_value_in_flight_msat(): u64,
314         /// minimum channel reserve for **self** to maintain - set by them.
315         their_channel_reserve_satoshis: u64,
316         //get_our_channel_reserve_satoshis(): u64,
317         their_htlc_minimum_msat: u64,
318         our_htlc_minimum_msat: u64,
319         their_to_self_delay: u16,
320         //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
321         #[cfg(test)]
322         pub their_max_accepted_htlcs: u16,
323         #[cfg(not(test))]
324         their_max_accepted_htlcs: u16,
325         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
326         minimum_depth: u32,
327
328         their_funding_pubkey: Option<PublicKey>,
329         their_revocation_basepoint: Option<PublicKey>,
330         their_payment_basepoint: Option<PublicKey>,
331         their_delayed_payment_basepoint: Option<PublicKey>,
332         their_htlc_basepoint: Option<PublicKey>,
333         their_cur_commitment_point: Option<PublicKey>,
334
335         their_prev_commitment_point: Option<PublicKey>,
336         their_node_id: PublicKey,
337
338         their_shutdown_scriptpubkey: Option<Script>,
339
340         channel_monitor: ChannelMonitor,
341
342         logger: Arc<Logger>,
343 }
344
345 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
346 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
347 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
348 /// really allow for this, so instead we're stuck closing it out at that point.
349 const UNCONF_THRESHOLD: u32 = 6;
350 /// The amount of time we require our counterparty wait to claim their money (ie time between when
351 /// we, or our watchtower, must check for them having broadcast a theft transaction).
352 #[cfg(not(test))]
353 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
354 #[cfg(test)]
355 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
356 /// The amount of time we're willing to wait to claim money back to us
357 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
358 /// Exposing these two constants for use in test in ChannelMonitor
359 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
360 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
361 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
362 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?)
363 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
364 /// it's 2^24.
365 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
366
367 #[cfg(test)]
368 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
369 #[cfg(not(test))]
370 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 139;
371 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
372
373 /// Used to return a simple Error back to ChannelManager. Will get converted to a
374 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
375 /// channel_id in ChannelManager.
376 #[derive(Debug)]
377 pub(super) enum ChannelError {
378         Ignore(&'static str),
379         Close(&'static str),
380 }
381
382 macro_rules! secp_check {
383         ($res: expr, $err: expr) => {
384                 match $res {
385                         Ok(thing) => thing,
386                         Err(_) => return Err(ChannelError::Close($err)),
387                 }
388         };
389 }
390
391 impl Channel {
392         // Convert constants + channel value to limits:
393         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
394                 channel_value_satoshis * 1000 / 10 //TODO
395         }
396
397         /// Returns a minimum channel reserve value **they** need to maintain
398         ///
399         /// Guaranteed to return a value no larger than channel_value_satoshis
400         fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
401                 let (q, _) = channel_value_satoshis.overflowing_div(100);
402                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
403         }
404
405         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
406                 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
407         }
408
409         fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
410                 1000 // TODO
411         }
412
413         // Constructors:
414         pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
415                 let chan_keys = keys_provider.get_channel_keys(false);
416
417                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
418                         return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
419                 }
420
421                 if push_msat > channel_value_satoshis * 1000 {
422                         return Err(APIError::APIMisuseError{err: "push value > channel value"});
423                 }
424
425
426                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
427                 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
428                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
429                 }
430
431                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
432
433                 let secp_ctx = Secp256k1::new();
434                 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
435                                                           &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
436                                                           keys_provider.get_destination_script(), logger.clone());
437
438                 Ok(Channel {
439                         user_id: user_id,
440                         config: config.channel_options.clone(),
441
442                         channel_id: keys_provider.get_channel_id(),
443                         channel_state: ChannelState::OurInitSent as u32,
444                         channel_outbound: true,
445                         secp_ctx: secp_ctx,
446                         channel_value_satoshis: channel_value_satoshis,
447
448                         local_keys: chan_keys,
449                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
450                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
451                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
452                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
453
454                         pending_inbound_htlcs: Vec::new(),
455                         pending_outbound_htlcs: Vec::new(),
456                         holding_cell_htlc_updates: Vec::new(),
457                         pending_update_fee: None,
458                         holding_cell_update_fee: None,
459                         next_local_htlc_id: 0,
460                         next_remote_htlc_id: 0,
461                         channel_update_count: 1,
462
463                         resend_order: RAACommitmentOrder::CommitmentFirst,
464
465                         monitor_pending_revoke_and_ack: false,
466                         monitor_pending_commitment_signed: false,
467                         monitor_pending_forwards: Vec::new(),
468                         monitor_pending_failures: Vec::new(),
469
470                         #[cfg(debug_assertions)]
471                         max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
472                         #[cfg(debug_assertions)]
473                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
474
475                         last_local_commitment_txn: Vec::new(),
476
477                         last_sent_closing_fee: None,
478
479                         funding_tx_confirmed_in: None,
480                         short_channel_id: None,
481                         last_block_connected: Default::default(),
482                         funding_tx_confirmations: 0,
483
484                         feerate_per_kw: feerate,
485                         their_dust_limit_satoshis: 0,
486                         our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
487                         their_max_htlc_value_in_flight_msat: 0,
488                         their_channel_reserve_satoshis: 0,
489                         their_htlc_minimum_msat: 0,
490                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
491                         their_to_self_delay: 0,
492                         their_max_accepted_htlcs: 0,
493                         minimum_depth: 0, // Filled in in accept_channel
494
495                         their_funding_pubkey: None,
496                         their_revocation_basepoint: None,
497                         their_payment_basepoint: None,
498                         their_delayed_payment_basepoint: None,
499                         their_htlc_basepoint: None,
500                         their_cur_commitment_point: None,
501
502                         their_prev_commitment_point: None,
503                         their_node_id: their_node_id,
504
505                         their_shutdown_scriptpubkey: None,
506
507                         channel_monitor: channel_monitor,
508
509                         logger,
510                 })
511         }
512
513         fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
514                 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
515                         return Err(ChannelError::Close("Peer's feerate much too low"));
516                 }
517                 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
518                         return Err(ChannelError::Close("Peer's feerate much too high"));
519                 }
520                 Ok(())
521         }
522
523         /// Creates a new channel from a remote sides' request for one.
524         /// Assumes chain_hash has already been checked and corresponds with what we expect!
525         pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
526                 let chan_keys = keys_provider.get_channel_keys(true);
527                 let mut local_config = (*config).channel_options.clone();
528
529                 // Check sanity of message fields:
530                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
531                         return Err(ChannelError::Close("funding value > 2^24"));
532                 }
533                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
534                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
535                 }
536                 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
537                         return Err(ChannelError::Close("push_msat larger than funding value"));
538                 }
539                 if msg.dust_limit_satoshis > msg.funding_satoshis {
540                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
541                 }
542                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
543                         return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
544                 }
545                 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
546                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
547                 }
548                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
549
550                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
551                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
552                 }
553                 if msg.max_accepted_htlcs < 1 {
554                         return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
555                 }
556                 if msg.max_accepted_htlcs > 483 {
557                         return Err(ChannelError::Close("max_accpted_htlcs > 483"));
558                 }
559
560                 // Now check against optional parameters as set by config...
561                 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
562                         return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
563                 }
564                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
565                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
566                 }
567                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
568                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
569                 }
570                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
571                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
572                 }
573                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
574                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
575                 }
576                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
577                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
578                 }
579                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
580                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
581                 }
582
583                 // Convert things into internal flags and prep our state:
584
585                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
586                 if config.peer_channel_config_limits.force_announced_channel_preference {
587                         if local_config.announced_channel != their_announce {
588                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
589                         }
590                 }
591                 // we either accept their preference or the preferences match
592                 local_config.announced_channel = their_announce;
593
594                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
595
596                 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
597                 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
598                 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
599                         return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
600                 }
601                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
602                         return Err(ChannelError::Close("channel_reserve_satoshis too small"));
603                 }
604                 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
605                         return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
606                 }
607
608                 // check if the funder's amount for the initial commitment tx is sufficient
609                 // for full fee payment
610                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
611                 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
612                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
613                 }
614
615                 let to_local_msat = msg.push_msat;
616                 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
617                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
618                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
619                 }
620
621                 let secp_ctx = Secp256k1::new();
622                 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
623                                                               &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
624                                                               keys_provider.get_destination_script(), logger.clone());
625                 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
626                 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
627
628                 let mut chan = Channel {
629                         user_id: user_id,
630                         config: local_config,
631
632                         channel_id: msg.temporary_channel_id,
633                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
634                         channel_outbound: false,
635                         secp_ctx: secp_ctx,
636
637                         local_keys: chan_keys,
638                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
639                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
640                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
641                         value_to_self_msat: msg.push_msat,
642
643                         pending_inbound_htlcs: Vec::new(),
644                         pending_outbound_htlcs: Vec::new(),
645                         holding_cell_htlc_updates: Vec::new(),
646                         pending_update_fee: None,
647                         holding_cell_update_fee: None,
648                         next_local_htlc_id: 0,
649                         next_remote_htlc_id: 0,
650                         channel_update_count: 1,
651
652                         resend_order: RAACommitmentOrder::CommitmentFirst,
653
654                         monitor_pending_revoke_and_ack: false,
655                         monitor_pending_commitment_signed: false,
656                         monitor_pending_forwards: Vec::new(),
657                         monitor_pending_failures: Vec::new(),
658
659                         #[cfg(debug_assertions)]
660                         max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
661                         #[cfg(debug_assertions)]
662                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
663
664                         last_local_commitment_txn: Vec::new(),
665
666                         last_sent_closing_fee: None,
667
668                         funding_tx_confirmed_in: None,
669                         short_channel_id: None,
670                         last_block_connected: Default::default(),
671                         funding_tx_confirmations: 0,
672
673                         feerate_per_kw: msg.feerate_per_kw as u64,
674                         channel_value_satoshis: msg.funding_satoshis,
675                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
676                         our_dust_limit_satoshis: our_dust_limit_satoshis,
677                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
678                         their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
679                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
680                         our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
681                         their_to_self_delay: msg.to_self_delay,
682                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
683                         minimum_depth: config.own_channel_config.minimum_depth,
684
685                         their_funding_pubkey: Some(msg.funding_pubkey),
686                         their_revocation_basepoint: Some(msg.revocation_basepoint),
687                         their_payment_basepoint: Some(msg.payment_basepoint),
688                         their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
689                         their_htlc_basepoint: Some(msg.htlc_basepoint),
690                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
691
692                         their_prev_commitment_point: None,
693                         their_node_id: their_node_id,
694
695                         their_shutdown_scriptpubkey: None,
696
697                         channel_monitor: channel_monitor,
698
699                         logger,
700                 };
701
702                 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
703                 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
704
705                 Ok(chan)
706         }
707
708         // Utilities to derive keys:
709
710         fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
711                 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
712                 SecretKey::from_slice(&res).unwrap()
713         }
714
715         // Utilities to build transactions:
716
717         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
718                 let mut sha = Sha256::engine();
719                 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
720
721                 if self.channel_outbound {
722                         sha.input(&our_payment_basepoint.serialize());
723                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
724                 } else {
725                         sha.input(&self.their_payment_basepoint.unwrap().serialize());
726                         sha.input(&our_payment_basepoint.serialize());
727                 }
728                 let res = Sha256::from_engine(sha).into_inner();
729
730                 ((res[26] as u64) << 5*8) |
731                 ((res[27] as u64) << 4*8) |
732                 ((res[28] as u64) << 3*8) |
733                 ((res[29] as u64) << 2*8) |
734                 ((res[30] as u64) << 1*8) |
735                 ((res[31] as u64) << 0*8)
736         }
737
738         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
739         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
740         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
741         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
742         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
743         /// an HTLC to a).
744         /// @local is used only to convert relevant internal structures which refer to remote vs local
745         /// to decide value of outputs and direction of HTLCs.
746         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
747         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
748         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
749         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
750         /// which peer generated this transaction and "to whom" this transaction flows.
751         /// Returns (the transaction built, the number of HTLC outputs which were present in the
752         /// transaction, the list of HTLCs which were not ignored when building the transaction).
753         /// Note that below-dust HTLCs are included in the third return value, but not the second, and
754         /// sources are provided only for outbound HTLCs in the third return value.
755         #[inline]
756         fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
757                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
758
759                 let txins = {
760                         let mut ins: Vec<TxIn> = Vec::new();
761                         ins.push(TxIn {
762                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
763                                 script_sig: Script::new(),
764                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
765                                 witness: Vec::new(),
766                         });
767                         ins
768                 };
769
770                 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
771                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
772
773                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
774                 let mut remote_htlc_total_msat = 0;
775                 let mut local_htlc_total_msat = 0;
776                 let mut value_to_self_msat_offset = 0;
777
778                 log_trace!(self, "Building commitment transaction number {} for {}, generated by {} with fee {}...", commitment_number, if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
779
780                 macro_rules! get_htlc_in_commitment {
781                         ($htlc: expr, $offered: expr) => {
782                                 HTLCOutputInCommitment {
783                                         offered: $offered,
784                                         amount_msat: $htlc.amount_msat,
785                                         cltv_expiry: $htlc.cltv_expiry,
786                                         payment_hash: $htlc.payment_hash,
787                                         transaction_output_index: None
788                                 }
789                         }
790                 }
791
792                 macro_rules! add_htlc_output {
793                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
794                                 if $outbound == local { // "offered HTLC output"
795                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
796                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
797                                                 log_trace!(self, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
798                                                 txouts.push((TxOut {
799                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
800                                                         value: $htlc.amount_msat / 1000
801                                                 }, Some((htlc_in_tx, $source))));
802                                         } else {
803                                                 log_trace!(self, "   ...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);
804                                                 included_dust_htlcs.push((htlc_in_tx, $source));
805                                         }
806                                 } else {
807                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
808                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
809                                                 log_trace!(self, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
810                                                 txouts.push((TxOut { // "received HTLC output"
811                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
812                                                         value: $htlc.amount_msat / 1000
813                                                 }, Some((htlc_in_tx, $source))));
814                                         } else {
815                                                 log_trace!(self, "   ...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);
816                                                 included_dust_htlcs.push((htlc_in_tx, $source));
817                                         }
818                                 }
819                         }
820                 }
821
822                 for ref htlc in self.pending_inbound_htlcs.iter() {
823                         let (include, state_name) = match htlc.state {
824                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
825                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
826                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
827                                 InboundHTLCState::Committed => (true, "Committed"),
828                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
829                         };
830
831                         if include {
832                                 add_htlc_output!(htlc, false, None, state_name);
833                                 remote_htlc_total_msat += htlc.amount_msat;
834                         } else {
835                                 log_trace!(self, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
836                                 match &htlc.state {
837                                         &InboundHTLCState::LocalRemoved(ref reason) => {
838                                                 if generated_by_local {
839                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
840                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
841                                                         }
842                                                 }
843                                         },
844                                         _ => {},
845                                 }
846                         }
847                 }
848
849                 for ref htlc in self.pending_outbound_htlcs.iter() {
850                         let (include, state_name) = match htlc.state {
851                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
852                                 OutboundHTLCState::Committed => (true, "Committed"),
853                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
854                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
855                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
856                         };
857
858                         if include {
859                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
860                                 local_htlc_total_msat += htlc.amount_msat;
861                         } else {
862                                 log_trace!(self, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
863                                 match htlc.state {
864                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
865                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
866                                         },
867                                         OutboundHTLCState::RemoteRemoved(None) => {
868                                                 if !generated_by_local {
869                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
870                                                 }
871                                         },
872                                         _ => {},
873                                 }
874                         }
875                 }
876
877                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
878                 assert!(value_to_self_msat >= 0);
879                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
880                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
881                 // "violate" their reserve value by couting those against it. Thus, we have to convert
882                 // everything to i64 before subtracting as otherwise we can overflow.
883                 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;
884                 assert!(value_to_remote_msat >= 0);
885
886                 #[cfg(debug_assertions)]
887                 {
888                         // Make sure that the to_self/to_remote is always either past the appropriate
889                         // channel_reserve *or* it is making progress towards it.
890                         // TODO: This should happen after fee calculation, but we don't handle that correctly
891                         // yet!
892                         let mut max_commitment_tx_output = if generated_by_local {
893                                 self.max_commitment_tx_output_local.lock().unwrap()
894                         } else {
895                                 self.max_commitment_tx_output_remote.lock().unwrap()
896                         };
897                         debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
898                         max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
899                         debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
900                         max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
901                 }
902
903                 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
904                 let (value_to_self, value_to_remote) = if self.channel_outbound {
905                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
906                 } else {
907                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
908                 };
909
910                 let value_to_a = if local { value_to_self } else { value_to_remote };
911                 let value_to_b = if local { value_to_remote } else { value_to_self };
912
913                 if value_to_a >= (dust_limit_satoshis as i64) {
914                         log_trace!(self, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
915                         txouts.push((TxOut {
916                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
917                                                                                        if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
918                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
919                                 value: value_to_a as u64
920                         }, None));
921                 }
922
923                 if value_to_b >= (dust_limit_satoshis as i64) {
924                         log_trace!(self, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
925                         txouts.push((TxOut {
926                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
927                                                              .push_slice(&Hash160::hash(&keys.b_payment_key.serialize())[..])
928                                                              .into_script(),
929                                 value: value_to_b as u64
930                         }, None));
931                 }
932
933                 transaction_utils::sort_outputs(&mut txouts, |a, b| {
934                         if let &Some(ref a_htlc) = a {
935                                 if let &Some(ref b_htlc) = b {
936                                         a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
937                                                 // Note that due to hash collisions, we have to have a fallback comparison
938                                                 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
939                                                 // may fail)!
940                                                 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
941                                 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
942                                 // close the channel due to mismatches - they're doing something dumb:
943                                 } else { cmp::Ordering::Equal }
944                         } else { cmp::Ordering::Equal }
945                 });
946
947                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
948                 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
949                 for (idx, mut out) in txouts.drain(..).enumerate() {
950                         outputs.push(out.0);
951                         if let Some((mut htlc, source_option)) = out.1.take() {
952                                 htlc.transaction_output_index = Some(idx as u32);
953                                 htlcs_included.push((htlc, source_option));
954                         }
955                 }
956                 let non_dust_htlc_count = htlcs_included.len();
957                 htlcs_included.append(&mut included_dust_htlcs);
958
959                 (Transaction {
960                         version: 2,
961                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
962                         input: txins,
963                         output: outputs,
964                 }, non_dust_htlc_count, htlcs_included)
965         }
966
967         #[inline]
968         fn get_closing_scriptpubkey(&self) -> Script {
969                 let our_channel_close_key_hash = Hash160::hash(&self.shutdown_pubkey.serialize());
970                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
971         }
972
973         #[inline]
974         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
975                 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
976         }
977
978         #[inline]
979         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
980                 let txins = {
981                         let mut ins: Vec<TxIn> = Vec::new();
982                         ins.push(TxIn {
983                                 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
984                                 script_sig: Script::new(),
985                                 sequence: 0xffffffff,
986                                 witness: Vec::new(),
987                         });
988                         ins
989                 };
990
991                 assert!(self.pending_inbound_htlcs.is_empty());
992                 assert!(self.pending_outbound_htlcs.is_empty());
993                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
994
995                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
996                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
997                 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
998
999                 if value_to_self < 0 {
1000                         assert!(self.channel_outbound);
1001                         total_fee_satoshis += (-value_to_self) as u64;
1002                 } else if value_to_remote < 0 {
1003                         assert!(!self.channel_outbound);
1004                         total_fee_satoshis += (-value_to_remote) as u64;
1005                 }
1006
1007                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1008                         txouts.push((TxOut {
1009                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1010                                 value: value_to_remote as u64
1011                         }, ()));
1012                 }
1013
1014                 if value_to_self as u64 > self.our_dust_limit_satoshis {
1015                         txouts.push((TxOut {
1016                                 script_pubkey: self.get_closing_scriptpubkey(),
1017                                 value: value_to_self as u64
1018                         }, ()));
1019                 }
1020
1021                 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1022
1023                 let mut outputs: Vec<TxOut> = Vec::new();
1024                 for out in txouts.drain(..) {
1025                         outputs.push(out.0);
1026                 }
1027
1028                 (Transaction {
1029                         version: 2,
1030                         lock_time: 0,
1031                         input: txins,
1032                         output: outputs,
1033                 }, total_fee_satoshis)
1034         }
1035
1036         #[inline]
1037         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1038         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1039         /// our counterparty!)
1040         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1041         /// TODO Some magic rust shit to compile-time check this?
1042         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1043                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1044                 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1045                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1046
1047                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), "Local tx keys generation got bogus keys"))
1048         }
1049
1050         #[inline]
1051         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1052         /// will sign and send to our counterparty.
1053         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1054         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1055                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1056                 //may see payments to it!
1057                 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1058                 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1059                 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1060
1061                 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1062         }
1063
1064         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1065         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1066         /// Panics if called before accept_channel/new_from_req
1067         pub fn get_funding_redeemscript(&self) -> Script {
1068                 let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
1069                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1070                 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1071                 if our_funding_key[..] < their_funding_key[..] {
1072                         builder.push_slice(&our_funding_key)
1073                                 .push_slice(&their_funding_key)
1074                 } else {
1075                         builder.push_slice(&their_funding_key)
1076                                 .push_slice(&our_funding_key)
1077                 }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
1078         }
1079
1080         fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1081                 if tx.input.len() != 1 {
1082                         panic!("Tried to sign commitment transaction that had input count != 1!");
1083                 }
1084                 if tx.input[0].witness.len() != 0 {
1085                         panic!("Tried to re-sign commitment transaction");
1086                 }
1087
1088                 let funding_redeemscript = self.get_funding_redeemscript();
1089
1090                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
1091                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1092
1093                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1094
1095                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1096                 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1097                 if our_funding_key[..] < their_funding_key[..] {
1098                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1099                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1100                 } else {
1101                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1102                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1103                 }
1104                 tx.input[0].witness[1].push(SigHashType::All as u8);
1105                 tx.input[0].witness[2].push(SigHashType::All as u8);
1106
1107                 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1108
1109                 our_sig
1110         }
1111
1112         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1113         /// @local is used only to convert relevant internal structures which refer to remote vs local
1114         /// to decide value of outputs and direction of HTLCs.
1115         fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1116                 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1117         }
1118
1119         fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), ChannelError> {
1120                 if tx.input.len() != 1 {
1121                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1122                 }
1123
1124                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1125
1126                 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
1127                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1128                 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1129                 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1130         }
1131
1132         /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1133         /// HTLC-Success transaction (ie htlc.offered is false), preimage must be set!
1134         fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<PaymentPreimage>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, ChannelError> {
1135                 if tx.input.len() != 1 {
1136                         panic!("Tried to sign HTLC transaction that had input count != 1!");
1137                 }
1138                 if tx.input[0].witness.len() != 0 {
1139                         panic!("Tried to re-sign HTLC transaction");
1140                 }
1141
1142                 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1143
1144                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1145
1146                 if local_tx { // b, then a
1147                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1148                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1149                 } else {
1150                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1151                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1152                 }
1153                 tx.input[0].witness[1].push(SigHashType::All as u8);
1154                 tx.input[0].witness[2].push(SigHashType::All as u8);
1155
1156                 if htlc.offered {
1157                         tx.input[0].witness.push(Vec::new());
1158                 } else {
1159                         tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1160                 }
1161
1162                 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1163
1164                 Ok(our_sig)
1165         }
1166
1167         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1168         /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1169         /// Ok(_) if debug assertions are turned on and preconditions are met.
1170         fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), ChannelError> {
1171                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1172                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1173                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1174                 // either.
1175                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1176                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1177                 }
1178                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1179
1180                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1181
1182                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1183                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1184                 // these, but for now we just have to treat them as normal.
1185
1186                 let mut pending_idx = std::usize::MAX;
1187                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1188                         if htlc.htlc_id == htlc_id_arg {
1189                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1190                                 match htlc.state {
1191                                         InboundHTLCState::Committed => {},
1192                                         InboundHTLCState::LocalRemoved(ref reason) => {
1193                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1194                                                 } else {
1195                                                         log_warn!(self, "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()));
1196                                                 }
1197                                                 return Ok((None, None));
1198                                         },
1199                                         _ => {
1200                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1201                                                 // Don't return in release mode here so that we can update channel_monitor
1202                                         }
1203                                 }
1204                                 pending_idx = idx;
1205                                 break;
1206                         }
1207                 }
1208                 if pending_idx == std::usize::MAX {
1209                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1210                 }
1211
1212                 // Now update local state:
1213                 //
1214                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1215                 // can claim it even if the channel hits the chain before we see their next commitment.
1216                 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1217
1218                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1219                         for pending_update in self.holding_cell_htlc_updates.iter() {
1220                                 match pending_update {
1221                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1222                                                 if htlc_id_arg == htlc_id {
1223                                                         return Ok((None, None));
1224                                                 }
1225                                         },
1226                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1227                                                 if htlc_id_arg == htlc_id {
1228                                                         log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1229                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1230                                                         // rare enough it may not be worth the complexity burden.
1231                                                         return Ok((None, Some(self.channel_monitor.clone())));
1232                                                 }
1233                                         },
1234                                         _ => {}
1235                                 }
1236                         }
1237                         log_trace!(self, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1238                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1239                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1240                         });
1241                         return Ok((None, Some(self.channel_monitor.clone())));
1242                 }
1243
1244                 {
1245                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1246                         if let InboundHTLCState::Committed = htlc.state {
1247                         } else {
1248                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1249                                 return Ok((None, Some(self.channel_monitor.clone())));
1250                         }
1251                         log_trace!(self, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1252                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1253                 }
1254
1255                 Ok((Some(msgs::UpdateFulfillHTLC {
1256                         channel_id: self.channel_id(),
1257                         htlc_id: htlc_id_arg,
1258                         payment_preimage: payment_preimage_arg,
1259                 }), Some(self.channel_monitor.clone())))
1260         }
1261
1262         pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), ChannelError> {
1263                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1264                         (Some(update_fulfill_htlc), _) => {
1265                                 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1266                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1267                         },
1268                         (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
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 an IgnoreError. Thus, will always return
1275         /// Ok(_) if debug assertions are turned on and preconditions are met.
1276         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1277                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1278                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1279                 }
1280                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1281
1282                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1283                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1284                 // these, but for now we just have to treat them as normal.
1285
1286                 let mut pending_idx = std::usize::MAX;
1287                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1288                         if htlc.htlc_id == htlc_id_arg {
1289                                 match htlc.state {
1290                                         InboundHTLCState::Committed => {},
1291                                         InboundHTLCState::LocalRemoved(_) => {
1292                                                 return Ok(None);
1293                                         },
1294                                         _ => {
1295                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1296                                                 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1297                                         }
1298                                 }
1299                                 pending_idx = idx;
1300                         }
1301                 }
1302                 if pending_idx == std::usize::MAX {
1303                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1304                 }
1305
1306                 // Now update local state:
1307                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1308                         for pending_update in self.holding_cell_htlc_updates.iter() {
1309                                 match pending_update {
1310                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1311                                                 if htlc_id_arg == htlc_id {
1312                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1313                                                 }
1314                                         },
1315                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1316                                                 if htlc_id_arg == htlc_id {
1317                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1318                                                 }
1319                                         },
1320                                         _ => {}
1321                                 }
1322                         }
1323                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1324                                 htlc_id: htlc_id_arg,
1325                                 err_packet,
1326                         });
1327                         return Ok(None);
1328                 }
1329
1330                 {
1331                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1332                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1333                 }
1334
1335                 Ok(Some(msgs::UpdateFailHTLC {
1336                         channel_id: self.channel_id(),
1337                         htlc_id: htlc_id_arg,
1338                         reason: err_packet
1339                 }))
1340         }
1341
1342         // Message handlers:
1343
1344         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig) -> Result<(), ChannelError> {
1345                 // Check sanity of message fields:
1346                 if !self.channel_outbound {
1347                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1348                 }
1349                 if self.channel_state != ChannelState::OurInitSent as u32 {
1350                         return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1351                 }
1352                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1353                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1354                 }
1355                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1356                         return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1357                 }
1358                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1359                         return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1360                 }
1361                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1362                         return Err(ChannelError::Close("Peer never wants payout outputs?"));
1363                 }
1364                 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1365                         return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1366                 }
1367                 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1368                         return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1369                 }
1370                 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1371                         return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1372                 }
1373                 if msg.max_accepted_htlcs < 1 {
1374                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1375                 }
1376                 if msg.max_accepted_htlcs > 483 {
1377                         return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1378                 }
1379
1380                 // Now check against optional parameters as set by config...
1381                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1382                         return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1383                 }
1384                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1385                         return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1386                 }
1387                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1388                         return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1389                 }
1390                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1391                         return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1392                 }
1393                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1394                         return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1395                 }
1396                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1397                         return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1398                 }
1399                 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1400                         return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1401                 }
1402
1403                 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1404
1405                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1406                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1407                 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1408                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1409                 self.their_to_self_delay = msg.to_self_delay;
1410                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1411                 self.minimum_depth = msg.minimum_depth;
1412                 self.their_funding_pubkey = Some(msg.funding_pubkey);
1413                 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1414                 self.their_payment_basepoint = Some(msg.payment_basepoint);
1415                 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1416                 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1417                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1418
1419                 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1420                 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1421                 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1422
1423                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1424
1425                 Ok(())
1426         }
1427
1428         fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), ChannelError> {
1429                 let funding_script = self.get_funding_redeemscript();
1430
1431                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1432                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1433                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1434
1435                 // They sign the "local" commitment transaction...
1436                 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer");
1437
1438                 // ...and we sign it, allowing us to broadcast the tx if we wish
1439                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1440
1441                 let remote_keys = self.build_remote_transaction_keys()?;
1442                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1443                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1444
1445                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1446                 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1447         }
1448
1449         pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), ChannelError> {
1450                 if self.channel_outbound {
1451                         return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1452                 }
1453                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1454                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1455                         // remember the channel, so it's safe to just send an error_message here and drop the
1456                         // channel.
1457                         return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1458                 }
1459                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1460                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1461                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1462                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1463                 }
1464
1465                 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1466                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1467                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1468
1469                 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1470                         Ok(res) => res,
1471                         Err(e) => {
1472                                 self.channel_monitor.unset_funding_info();
1473                                 return Err(e);
1474                         }
1475                 };
1476
1477                 // Now that we're past error-generating stuff, update our local state:
1478
1479                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1480                 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1481                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new());
1482                 self.channel_state = ChannelState::FundingSent as u32;
1483                 self.channel_id = funding_txo.to_channel_id();
1484                 self.cur_remote_commitment_transaction_number -= 1;
1485                 self.cur_local_commitment_transaction_number -= 1;
1486
1487                 Ok((msgs::FundingSigned {
1488                         channel_id: self.channel_id,
1489                         signature: our_signature
1490                 }, self.channel_monitor.clone()))
1491         }
1492
1493         /// Handles a funding_signed message from the remote end.
1494         /// If this call is successful, broadcast the funding transaction (and not before!)
1495         pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, ChannelError> {
1496                 if !self.channel_outbound {
1497                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1498                 }
1499                 if self.channel_state != ChannelState::FundingCreated as u32 {
1500                         return Err(ChannelError::Close("Received funding_signed in strange state!"));
1501                 }
1502                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1503                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1504                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1505                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1506                 }
1507
1508                 let funding_script = self.get_funding_redeemscript();
1509
1510                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1511                 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1512                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1513
1514                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1515                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer");
1516
1517                 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1518                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1519                 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1520                 self.channel_state = ChannelState::FundingSent as u32;
1521                 self.cur_local_commitment_transaction_number -= 1;
1522
1523                 Ok(self.channel_monitor.clone())
1524         }
1525
1526         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1527                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1528                         return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1529                 }
1530
1531                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1532
1533                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1534                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1535                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1536                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1537                         self.channel_update_count += 1;
1538                 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1539                                 // Note that funding_signed/funding_created will have decremented both by 1!
1540                                 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1541                                 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1542                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1543                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1544                         }
1545                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1546                         return Ok(());
1547                 } else {
1548                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1549                 }
1550
1551                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1552                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1553                 Ok(())
1554         }
1555
1556         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1557         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1558                 let mut htlc_inbound_value_msat = 0;
1559                 for ref htlc in self.pending_inbound_htlcs.iter() {
1560                         htlc_inbound_value_msat += htlc.amount_msat;
1561                 }
1562                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1563         }
1564
1565         /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1566         /// holding cell.
1567         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1568                 let mut htlc_outbound_value_msat = 0;
1569                 for ref htlc in self.pending_outbound_htlcs.iter() {
1570                         htlc_outbound_value_msat += htlc.amount_msat;
1571                 }
1572
1573                 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1574                 for update in self.holding_cell_htlc_updates.iter() {
1575                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1576                                 htlc_outbound_count += 1;
1577                                 htlc_outbound_value_msat += amount_msat;
1578                         }
1579                 }
1580
1581                 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1582         }
1583
1584         pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1585                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1586                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1587                 }
1588                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1589                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1590                 }
1591                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1592                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1593                 }
1594                 if msg.amount_msat < self.our_htlc_minimum_msat {
1595                         return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1596                 }
1597
1598                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1599                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1600                         return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1601                 }
1602                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1603                 // Check our_max_htlc_value_in_flight_msat
1604                 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1605                         return Err(ChannelError::Close("Remote HTLC add would put them over their max HTLC value in flight"));
1606                 }
1607                 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1608                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1609                 // something if we punish them for broadcasting an old state).
1610                 // Note that we don't really care about having a small/no to_remote output in our local
1611                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1612                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1613                 // present in the next commitment transaction we send them (at least for fulfilled ones,
1614                 // failed ones won't modify value_to_self).
1615                 // Note that we will send HTLCs which another instance of rust-lightning would think
1616                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1617                 // Channel state once they will not be present in the next received commitment
1618                 // transaction).
1619                 let mut removed_outbound_total_msat = 0;
1620                 for ref htlc in self.pending_outbound_htlcs.iter() {
1621                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1622                                 removed_outbound_total_msat += htlc.amount_msat;
1623                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1624                                 removed_outbound_total_msat += htlc.amount_msat;
1625                         }
1626                 }
1627                 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1628                         return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1629                 }
1630                 if self.next_remote_htlc_id != msg.htlc_id {
1631                         return Err(ChannelError::Close("Remote skipped HTLC ID"));
1632                 }
1633                 if msg.cltv_expiry >= 500000000 {
1634                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1635                 }
1636
1637                 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1638
1639                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1640                         if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1641                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1642                         }
1643                 }
1644
1645                 // Now update local state:
1646                 self.next_remote_htlc_id += 1;
1647                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1648                         htlc_id: msg.htlc_id,
1649                         amount_msat: msg.amount_msat,
1650                         payment_hash: msg.payment_hash,
1651                         cltv_expiry: msg.cltv_expiry,
1652                         state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1653                 });
1654                 Ok(())
1655         }
1656
1657         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1658         #[inline]
1659         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1660                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1661                         if htlc.htlc_id == htlc_id {
1662                                 match check_preimage {
1663                                         None => {},
1664                                         Some(payment_hash) =>
1665                                                 if payment_hash != htlc.payment_hash {
1666                                                         return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1667                                                 }
1668                                 };
1669                                 match htlc.state {
1670                                         OutboundHTLCState::LocalAnnounced(_) =>
1671                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1672                                         OutboundHTLCState::Committed => {
1673                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1674                                         },
1675                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1676                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1677                                 }
1678                                 return Ok(&htlc.source);
1679                         }
1680                 }
1681                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1682         }
1683
1684         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1685                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1686                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1687                 }
1688                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1689                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1690                 }
1691
1692                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1693                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1694         }
1695
1696         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1697                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1698                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1699                 }
1700                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1701                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1702                 }
1703
1704                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1705                 Ok(())
1706         }
1707
1708         pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1709                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1710                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1711                 }
1712                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1713                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1714                 }
1715
1716                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1717                 Ok(())
1718         }
1719
1720         pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1721                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1722                         return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state"));
1723                 }
1724                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1725                         return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish"));
1726                 }
1727                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1728                         return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds"));
1729                 }
1730
1731                 let funding_script = self.get_funding_redeemscript();
1732
1733                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1734
1735                 let mut update_fee = false;
1736                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1737                         update_fee = true;
1738                         self.pending_update_fee.unwrap()
1739                 } else {
1740                         self.feerate_per_kw
1741                 };
1742
1743                 let mut local_commitment_tx = {
1744                         let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1745                         let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1746                         (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1747                 };
1748                 let local_commitment_txid = local_commitment_tx.0.txid();
1749                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1750                 log_trace!(self, "Checking commitment tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey.unwrap().serialize()), encode::serialize_hex(&local_commitment_tx.0), encode::serialize_hex(&funding_script));
1751                 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
1752
1753                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1754                 if update_fee {
1755                         let num_htlcs = local_commitment_tx.1;
1756                         let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1757
1758                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1759                                 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee"));
1760                         }
1761                 }
1762
1763                 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1764                         return Err(ChannelError::Close("Got wrong number of HTLC signatures from remote"));
1765                 }
1766
1767                 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1 + 1);
1768                 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1769                 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1770
1771                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1772                 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1773                         if let Some(_) = htlc.transaction_output_index {
1774                                 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1775                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1776                                 log_trace!(self, "Checking HTLC tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript));
1777                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1778                                 secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
1779                                 let htlc_sig = if htlc.offered {
1780                                         let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, &htlc, &local_keys)?;
1781                                         new_local_commitment_txn.push(htlc_tx);
1782                                         htlc_sig
1783                                 } else {
1784                                         self.create_htlc_tx_signature(&htlc_tx, &htlc, &local_keys)?.1
1785                                 };
1786                                 htlcs_and_sigs.push((htlc, Some((msg.htlc_signatures[idx], htlc_sig)), source));
1787                         } else {
1788                                 htlcs_and_sigs.push((htlc, None, source));
1789                         }
1790                 }
1791
1792                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1793                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1794
1795                 // Update state now that we've passed all the can-fail calls...
1796                 let mut need_our_commitment = false;
1797                 if !self.channel_outbound {
1798                         if let Some(fee_update) = self.pending_update_fee {
1799                                 self.feerate_per_kw = fee_update;
1800                                 // We later use the presence of pending_update_fee to indicate we should generate a
1801                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1802                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1803                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1804                                         need_our_commitment = true;
1805                                         self.pending_update_fee = None;
1806                                 }
1807                         }
1808                 }
1809
1810                 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1811
1812                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1813                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1814                                 Some(forward_info.clone())
1815                         } else { None };
1816                         if let Some(forward_info) = new_forward {
1817                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1818                                 need_our_commitment = true;
1819                         }
1820                 }
1821                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1822                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1823                                 Some(fail_reason.take())
1824                         } else { None } {
1825                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1826                                 need_our_commitment = true;
1827                         }
1828                 }
1829
1830                 self.cur_local_commitment_transaction_number -= 1;
1831                 self.last_local_commitment_txn = new_local_commitment_txn;
1832                 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1833                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1834                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1835
1836                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1837                         // In case we initially failed monitor updating without requiring a response, we need
1838                         // to make sure the RAA gets sent first.
1839                         self.monitor_pending_revoke_and_ack = true;
1840                         if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1841                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1842                                 // the corresponding HTLC status updates so that get_last_commitment_update
1843                                 // includes the right HTLCs.
1844                                 // Note that this generates a monitor update that we ignore! This is OK since we
1845                                 // won't actually send the commitment_signed that generated the update to the other
1846                                 // side until the latest monitor has been pulled from us and stored.
1847                                 self.monitor_pending_commitment_signed = true;
1848                                 self.send_commitment_no_status_check()?;
1849                         }
1850                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1851                         // re-send the message on restoration)
1852                         return Err(ChannelError::Ignore("Previous monitor update failure prevented generation of RAA"));
1853                 }
1854
1855                 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1856                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1857                         // we'll send one right away when we get the revoke_and_ack when we
1858                         // free_holding_cell_htlcs().
1859                         let (msg, monitor) = self.send_commitment_no_status_check()?;
1860                         (Some(msg), monitor, None)
1861                 } else if !need_our_commitment {
1862                         (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1863                 } else { (None, self.channel_monitor.clone(), None) };
1864
1865                 Ok((msgs::RevokeAndACK {
1866                         channel_id: self.channel_id,
1867                         per_commitment_secret: per_commitment_secret,
1868                         next_per_commitment_point: next_per_commitment_point,
1869                 }, our_commitment_signed, closing_signed, monitor_update))
1870         }
1871
1872         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1873         /// fulfilling or failing the last pending HTLC)
1874         fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, ChannelError> {
1875                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1876                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1877                         log_trace!(self, "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 { "" });
1878
1879                         let mut htlc_updates = Vec::new();
1880                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1881                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1882                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1883                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1884                         let mut err = None;
1885                         for htlc_update in htlc_updates.drain(..) {
1886                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
1887                                 // fee races with adding too many outputs which push our total payments just over
1888                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
1889                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
1890                                 // to rebalance channels.
1891                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1892                                         self.holding_cell_htlc_updates.push(htlc_update);
1893                                 } else {
1894                                         match &htlc_update {
1895                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
1896                                                         match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1897                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1898                                                                 Err(e) => {
1899                                                                         match e {
1900                                                                                 ChannelError::Ignore(ref msg) => {
1901                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
1902                                                                                 },
1903                                                                                 _ => {
1904                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
1905                                                                                 },
1906                                                                         }
1907                                                                         err = Some(e);
1908                                                                 }
1909                                                         }
1910                                                 },
1911                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
1912                                                         match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
1913                                                                 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1914                                                                 Err(e) => {
1915                                                                         if let ChannelError::Ignore(_) = e {}
1916                                                                         else {
1917                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1918                                                                         }
1919                                                                 }
1920                                                         }
1921                                                 },
1922                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1923                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1924                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1925                                                                 Err(e) => {
1926                                                                         if let ChannelError::Ignore(_) = e {}
1927                                                                         else {
1928                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1929                                                                         }
1930                                                                 }
1931                                                         }
1932                                                 },
1933                                         }
1934                                         if err.is_some() {
1935                                                 self.holding_cell_htlc_updates.push(htlc_update);
1936                                                 if let Some(ChannelError::Ignore(_)) = err {
1937                                                         // If we failed to add the HTLC, but got an Ignore error, we should
1938                                                         // still send the new commitment_signed, so reset the err to None.
1939                                                         err = None;
1940                                                 }
1941                                         }
1942                                 }
1943                         }
1944                         //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
1945                         //fail it back the route, if it's a temporary issue we can ignore it...
1946                         match err {
1947                                 None => {
1948                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1949                                                 // This should never actually happen and indicates we got some Errs back
1950                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1951                                                 // case there is some strange way to hit duplicate HTLC removes.
1952                                                 return Ok(None);
1953                                         }
1954                                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1955                                                         self.pending_update_fee = self.holding_cell_update_fee.take();
1956                                                         Some(msgs::UpdateFee {
1957                                                                 channel_id: self.channel_id,
1958                                                                 feerate_per_kw: feerate as u32,
1959                                                         })
1960                                                 } else {
1961                                                         None
1962                                                 };
1963                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1964                                         Ok(Some((msgs::CommitmentUpdate {
1965                                                 update_add_htlcs,
1966                                                 update_fulfill_htlcs,
1967                                                 update_fail_htlcs,
1968                                                 update_fail_malformed_htlcs: Vec::new(),
1969                                                 update_fee: update_fee,
1970                                                 commitment_signed,
1971                                         }, monitor_update)))
1972                                 },
1973                                 Some(e) => Err(e)
1974                         }
1975                 } else {
1976                         Ok(None)
1977                 }
1978         }
1979
1980         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1981         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1982         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1983         /// generating an appropriate error *after* the channel state has been updated based on the
1984         /// revoke_and_ack message.
1985         pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1986                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1987                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
1988                 }
1989                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1990                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
1991                 }
1992                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1993                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
1994                 }
1995
1996                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1997                         if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
1998                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
1999                         }
2000                 }
2001                 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2002                         .map_err(|e| ChannelError::Close(e.0))?;
2003
2004                 // Update state now that we've passed all the can-fail calls...
2005                 // (note that we may still fail to generate the new commitment_signed message, but that's
2006                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2007                 // channel based on that, but stepping stuff here should be safe either way.
2008                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2009                 self.their_prev_commitment_point = self.their_cur_commitment_point;
2010                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2011                 self.cur_remote_commitment_transaction_number -= 1;
2012
2013                 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2014                 let mut to_forward_infos = Vec::new();
2015                 let mut revoked_htlcs = Vec::new();
2016                 let mut update_fail_htlcs = Vec::new();
2017                 let mut update_fail_malformed_htlcs = Vec::new();
2018                 let mut require_commitment = false;
2019                 let mut value_to_self_msat_diff: i64 = 0;
2020
2021                 {
2022                         // Take references explicitly so that we can hold multiple references to self.
2023                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2024                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2025                         let logger = LogHolder { logger: &self.logger };
2026
2027                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2028                         pending_inbound_htlcs.retain(|htlc| {
2029                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2030                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2031                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2032                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2033                                         }
2034                                         false
2035                                 } else { true }
2036                         });
2037                         pending_outbound_htlcs.retain(|htlc| {
2038                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2039                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2040                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2041                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2042                                         } else {
2043                                                 // They fulfilled, so we sent them money
2044                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2045                                         }
2046                                         false
2047                                 } else { true }
2048                         });
2049                         for htlc in pending_inbound_htlcs.iter_mut() {
2050                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2051                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2052                                         true
2053                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2054                                         log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2055                                         true
2056                                 } else { false };
2057                                 if swap {
2058                                         let mut state = InboundHTLCState::Committed;
2059                                         mem::swap(&mut state, &mut htlc.state);
2060
2061                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2062                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2063                                                 require_commitment = true;
2064                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2065                                                 match forward_info {
2066                                                         PendingHTLCStatus::Fail(fail_msg) => {
2067                                                                 require_commitment = true;
2068                                                                 match fail_msg {
2069                                                                         HTLCFailureMsg::Relay(msg) => {
2070                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2071                                                                                 update_fail_htlcs.push(msg)
2072                                                                         },
2073                                                                         HTLCFailureMsg::Malformed(msg) => {
2074                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2075                                                                                 update_fail_malformed_htlcs.push(msg)
2076                                                                         },
2077                                                                 }
2078                                                         },
2079                                                         PendingHTLCStatus::Forward(forward_info) => {
2080                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2081                                                                 htlc.state = InboundHTLCState::Committed;
2082                                                         }
2083                                                 }
2084                                         }
2085                                 }
2086                         }
2087                         for htlc in pending_outbound_htlcs.iter_mut() {
2088                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2089                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2090                                         htlc.state = OutboundHTLCState::Committed;
2091                                 }
2092                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2093                                         Some(fail_reason.take())
2094                                 } else { None } {
2095                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2096                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2097                                         require_commitment = true;
2098                                 }
2099                         }
2100                 }
2101                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2102
2103                 if self.channel_outbound {
2104                         if let Some(feerate) = self.pending_update_fee.take() {
2105                                 self.feerate_per_kw = feerate;
2106                         }
2107                 } else {
2108                         if let Some(feerate) = self.pending_update_fee {
2109                                 // Because a node cannot send two commitment_signeds in a row without getting a
2110                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2111                                 // it should use to create keys with) and because a node can't send a
2112                                 // commitment_signed without changes, checking if the feerate is equal to the
2113                                 // pending feerate update is sufficient to detect require_commitment.
2114                                 if feerate == self.feerate_per_kw {
2115                                         require_commitment = true;
2116                                         self.pending_update_fee = None;
2117                                 }
2118                         }
2119                 }
2120
2121                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2122                         // We can't actually generate a new commitment transaction (incl by freeing holding
2123                         // cells) while we can't update the monitor, so we just return what we have.
2124                         if require_commitment {
2125                                 self.monitor_pending_commitment_signed = true;
2126                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2127                                 // which does not update state, but we're definitely now awaiting a remote revoke
2128                                 // before we can step forward any more, so set it here.
2129                                 self.send_commitment_no_status_check()?;
2130                         }
2131                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2132                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2133                         return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2134                 }
2135
2136                 match self.free_holding_cell_htlcs()? {
2137                         Some(mut commitment_update) => {
2138                                 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2139                                 for fail_msg in update_fail_htlcs.drain(..) {
2140                                         commitment_update.0.update_fail_htlcs.push(fail_msg);
2141                                 }
2142                                 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2143                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2144                                         commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2145                                 }
2146                                 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2147                         },
2148                         None => {
2149                                 if require_commitment {
2150                                         let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2151                                         Ok((Some(msgs::CommitmentUpdate {
2152                                                 update_add_htlcs: Vec::new(),
2153                                                 update_fulfill_htlcs: Vec::new(),
2154                                                 update_fail_htlcs,
2155                                                 update_fail_malformed_htlcs,
2156                                                 update_fee: None,
2157                                                 commitment_signed
2158                                         }), to_forward_infos, revoked_htlcs, None, monitor_update))
2159                                 } else {
2160                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2161                                 }
2162                         }
2163                 }
2164
2165         }
2166
2167         /// Adds a pending update to this channel. See the doc for send_htlc for
2168         /// further details on the optionness of the return value.
2169         /// You MUST call send_commitment prior to any other calls on this Channel
2170         fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2171                 if !self.channel_outbound {
2172                         panic!("Cannot send fee from inbound channel");
2173                 }
2174                 if !self.is_usable() {
2175                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2176                 }
2177                 if !self.is_live() {
2178                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2179                 }
2180
2181                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2182                         self.holding_cell_update_fee = Some(feerate_per_kw);
2183                         return None;
2184                 }
2185
2186                 debug_assert!(self.pending_update_fee.is_none());
2187                 self.pending_update_fee = Some(feerate_per_kw);
2188
2189                 Some(msgs::UpdateFee {
2190                         channel_id: self.channel_id,
2191                         feerate_per_kw: feerate_per_kw as u32,
2192                 })
2193         }
2194
2195         pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
2196                 match self.send_update_fee(feerate_per_kw) {
2197                         Some(update_fee) => {
2198                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2199                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2200                         },
2201                         None => Ok(None)
2202                 }
2203         }
2204
2205         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2206         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2207         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2208         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2209         /// No further message handling calls may be made until a channel_reestablish dance has
2210         /// completed.
2211         pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2212                 let mut outbound_drops = Vec::new();
2213
2214                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2215                 if self.channel_state < ChannelState::FundingSent as u32 {
2216                         self.channel_state = ChannelState::ShutdownComplete as u32;
2217                         return outbound_drops;
2218                 }
2219                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2220                 // will be retransmitted.
2221                 self.last_sent_closing_fee = None;
2222
2223                 let mut inbound_drop_count = 0;
2224                 self.pending_inbound_htlcs.retain(|htlc| {
2225                         match htlc.state {
2226                                 InboundHTLCState::RemoteAnnounced(_) => {
2227                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2228                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2229                                         // this HTLC accordingly
2230                                         inbound_drop_count += 1;
2231                                         false
2232                                 },
2233                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2234                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2235                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2236                                         // in response to it yet, so don't touch it.
2237                                         true
2238                                 },
2239                                 InboundHTLCState::Committed => true,
2240                                 InboundHTLCState::LocalRemoved(_) => {
2241                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2242                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2243                                         // (that we missed). Keep this around for now and if they tell us they missed
2244                                         // the commitment_signed we can re-transmit the update then.
2245                                         true
2246                                 },
2247                         }
2248                 });
2249                 self.next_remote_htlc_id -= inbound_drop_count;
2250
2251                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2252                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2253                                 // They sent us an update to remove this but haven't yet sent the corresponding
2254                                 // commitment_signed, we need to move it back to Committed and they can re-send
2255                                 // the update upon reconnection.
2256                                 htlc.state = OutboundHTLCState::Committed;
2257                         }
2258                 }
2259
2260                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2261                         match htlc_update {
2262                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2263                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2264                                         false
2265                                 },
2266                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2267                         }
2268                 });
2269                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2270                 log_debug!(self, "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()));
2271                 outbound_drops
2272         }
2273
2274         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2275         /// updates are partially paused.
2276         /// This must be called immediately after the call which generated the ChannelMonitor update
2277         /// which failed. The messages which were generated from that call which generated the
2278         /// monitor update failure must *not* have been sent to the remote end, and must instead
2279         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2280         pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2281                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2282                 self.monitor_pending_revoke_and_ack = resend_raa;
2283                 self.monitor_pending_commitment_signed = resend_commitment;
2284                 assert!(self.monitor_pending_forwards.is_empty());
2285                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2286                 assert!(self.monitor_pending_failures.is_empty());
2287                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2288                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2289         }
2290
2291         /// Indicates that the latest ChannelMonitor update has been committed by the client
2292         /// successfully and we should restore normal operation. Returns messages which should be sent
2293         /// to the remote side.
2294         pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2295                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2296                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2297
2298                 let mut forwards = Vec::new();
2299                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2300                 let mut failures = Vec::new();
2301                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2302
2303                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2304                         self.monitor_pending_revoke_and_ack = false;
2305                         self.monitor_pending_commitment_signed = false;
2306                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2307                 }
2308
2309                 let raa = if self.monitor_pending_revoke_and_ack {
2310                         Some(self.get_last_revoke_and_ack())
2311                 } else { None };
2312                 let commitment_update = if self.monitor_pending_commitment_signed {
2313                         Some(self.get_last_commitment_update())
2314                 } else { None };
2315
2316                 self.monitor_pending_revoke_and_ack = false;
2317                 self.monitor_pending_commitment_signed = false;
2318                 let order = self.resend_order.clone();
2319                 log_trace!(self, "Restored monitor updating resulting in {} commitment update and {} RAA, with {} first",
2320                         if commitment_update.is_some() { "a" } else { "no" },
2321                         if raa.is_some() { "an" } else { "no" },
2322                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2323                 (raa, commitment_update, order, forwards, failures)
2324         }
2325
2326         pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2327                 if self.channel_outbound {
2328                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2329                 }
2330                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2331                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2332                 }
2333                 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2334                 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2335                 self.channel_update_count += 1;
2336                 Ok(())
2337         }
2338
2339         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2340                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2341                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2342                 msgs::RevokeAndACK {
2343                         channel_id: self.channel_id,
2344                         per_commitment_secret,
2345                         next_per_commitment_point,
2346                 }
2347         }
2348
2349         fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2350                 let mut update_add_htlcs = Vec::new();
2351                 let mut update_fulfill_htlcs = Vec::new();
2352                 let mut update_fail_htlcs = Vec::new();
2353                 let mut update_fail_malformed_htlcs = Vec::new();
2354
2355                 for htlc in self.pending_outbound_htlcs.iter() {
2356                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2357                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2358                                         channel_id: self.channel_id(),
2359                                         htlc_id: htlc.htlc_id,
2360                                         amount_msat: htlc.amount_msat,
2361                                         payment_hash: htlc.payment_hash,
2362                                         cltv_expiry: htlc.cltv_expiry,
2363                                         onion_routing_packet: (**onion_packet).clone(),
2364                                 });
2365                         }
2366                 }
2367
2368                 for htlc in self.pending_inbound_htlcs.iter() {
2369                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2370                                 match reason {
2371                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2372                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2373                                                         channel_id: self.channel_id(),
2374                                                         htlc_id: htlc.htlc_id,
2375                                                         reason: err_packet.clone()
2376                                                 });
2377                                         },
2378                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2379                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2380                                                         channel_id: self.channel_id(),
2381                                                         htlc_id: htlc.htlc_id,
2382                                                         sha256_of_onion: sha256_of_onion.clone(),
2383                                                         failure_code: failure_code.clone(),
2384                                                 });
2385                                         },
2386                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2387                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2388                                                         channel_id: self.channel_id(),
2389                                                         htlc_id: htlc.htlc_id,
2390                                                         payment_preimage: payment_preimage.clone(),
2391                                                 });
2392                                         },
2393                                 }
2394                         }
2395                 }
2396
2397                 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2398                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2399                 msgs::CommitmentUpdate {
2400                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2401                         update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2402                         commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2403                 }
2404         }
2405
2406         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2407         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2408         pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2409                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2410                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2411                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2412                         // just close here instead of trying to recover.
2413                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2414                 }
2415
2416                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2417                         msg.next_local_commitment_number == 0 {
2418                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2419                 }
2420
2421                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2422                 // remaining cases either succeed or ErrorMessage-fail).
2423                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2424
2425                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2426                         Some(msgs::Shutdown {
2427                                 channel_id: self.channel_id,
2428                                 scriptpubkey: self.get_closing_scriptpubkey(),
2429                         })
2430                 } else { None };
2431
2432                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2433                         if self.channel_state & ChannelState::OurFundingLocked as u32 == 0 {
2434                                 if msg.next_remote_commitment_number != 0 {
2435                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2436                                 }
2437                                 // Short circuit the whole handler as there is nothing we can resend them
2438                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2439                         }
2440
2441                         // We have OurFundingLocked set!
2442                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2443                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2444                         return Ok((Some(msgs::FundingLocked {
2445                                 channel_id: self.channel_id(),
2446                                 next_per_commitment_point: next_per_commitment_point,
2447                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2448                 }
2449
2450                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2451                         // Remote isn't waiting on any RevokeAndACK from us!
2452                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2453                         None
2454                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2455                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2456                                 self.monitor_pending_revoke_and_ack = true;
2457                                 None
2458                         } else {
2459                                 Some(self.get_last_revoke_and_ack())
2460                         }
2461                 } else {
2462                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2463                 };
2464
2465                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2466                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2467                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2468                 // the corresponding revoke_and_ack back yet.
2469                 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2470
2471                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2472                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2473                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2474                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2475                         Some(msgs::FundingLocked {
2476                                 channel_id: self.channel_id(),
2477                                 next_per_commitment_point: next_per_commitment_point,
2478                         })
2479                 } else { None };
2480
2481                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2482                         if required_revoke.is_some() {
2483                                 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2484                         } else {
2485                                 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2486                         }
2487
2488                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2489                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2490                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2491                                 // have received some updates while we were disconnected. Free the holding cell
2492                                 // now!
2493                                 match self.free_holding_cell_htlcs() {
2494                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2495                                         Err(ChannelError::Ignore(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2496                                         Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), self.resend_order.clone(), shutdown_msg)),
2497                                         Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2498                                 }
2499                         } else {
2500                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2501                         }
2502                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2503                         if required_revoke.is_some() {
2504                                 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2505                         } else {
2506                                 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2507                         }
2508
2509                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2510                                 self.monitor_pending_commitment_signed = true;
2511                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2512                         }
2513
2514                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, self.resend_order.clone(), shutdown_msg));
2515                 } else {
2516                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2517                 }
2518         }
2519
2520         fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2521                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2522                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2523                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2524                         return None;
2525                 }
2526
2527                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2528                 if self.feerate_per_kw > proposed_feerate {
2529                         proposed_feerate = self.feerate_per_kw;
2530                 }
2531                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2532                 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2533
2534                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2535                 let funding_redeemscript = self.get_funding_redeemscript();
2536                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2537
2538                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2539                 Some(msgs::ClosingSigned {
2540                         channel_id: self.channel_id,
2541                         fee_satoshis: total_fee_satoshis,
2542                         signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2543                 })
2544         }
2545
2546         pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError> {
2547                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2548                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2549                 }
2550                 if self.channel_state < ChannelState::FundingSent as u32 {
2551                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2552                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2553                         // can do that via error message without getting a connection fail anyway...
2554                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2555                 }
2556                 for htlc in self.pending_inbound_htlcs.iter() {
2557                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2558                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2559                         }
2560                 }
2561                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2562
2563                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2564                 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2565                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2566                         return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2567                 }
2568
2569                 //Check shutdown_scriptpubkey form as BOLT says we must
2570                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2571                         return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2572                 }
2573
2574                 if self.their_shutdown_scriptpubkey.is_some() {
2575                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2576                                 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2577                         }
2578                 } else {
2579                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2580                 }
2581
2582                 // From here on out, we may not fail!
2583
2584                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2585                 self.channel_update_count += 1;
2586
2587                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2588                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2589                 // cell HTLCs and return them to fail the payment.
2590                 self.holding_cell_update_fee = None;
2591                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2592                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2593                         match htlc_update {
2594                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2595                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2596                                         false
2597                                 },
2598                                 _ => true
2599                         }
2600                 });
2601                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2602                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2603                 // any further commitment updates after we set LocalShutdownSent.
2604
2605                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2606                         None
2607                 } else {
2608                         Some(msgs::Shutdown {
2609                                 channel_id: self.channel_id,
2610                                 scriptpubkey: self.get_closing_scriptpubkey(),
2611                         })
2612                 };
2613
2614                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2615                 self.channel_update_count += 1;
2616                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2617         }
2618
2619         pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError> {
2620                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2621                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2622                 }
2623                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2624                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2625                 }
2626                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2627                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2628                 }
2629                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2630                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2631                 }
2632
2633                 let funding_redeemscript = self.get_funding_redeemscript();
2634                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2635                 if used_total_fee != msg.fee_satoshis {
2636                         return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2637                 }
2638                 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2639
2640                 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2641                         Ok(_) => {},
2642                         Err(_e) => {
2643                                 // The remote end may have decided to revoke their output due to inconsistent dust
2644                                 // limits, so check for that case by re-checking the signature here.
2645                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2646                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2647                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer");
2648                         },
2649                 };
2650
2651                 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2652                         if last_fee == msg.fee_satoshis {
2653                                 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2654                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2655                                 self.channel_update_count += 1;
2656                                 return Ok((None, Some(closing_tx)));
2657                         }
2658                 }
2659
2660                 macro_rules! propose_new_feerate {
2661                         ($new_feerate: expr) => {
2662                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2663                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2664                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2665                                 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2666                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2667                                 return Ok((Some(msgs::ClosingSigned {
2668                                         channel_id: self.channel_id,
2669                                         fee_satoshis: used_total_fee,
2670                                         signature: our_sig,
2671                                 }), None))
2672                         }
2673                 }
2674
2675                 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2676                 if self.channel_outbound {
2677                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2678                         if proposed_sat_per_kw > our_max_feerate {
2679                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2680                                         if our_max_feerate <= last_feerate {
2681                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2682                                         }
2683                                 }
2684                                 propose_new_feerate!(our_max_feerate);
2685                         }
2686                 } else {
2687                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2688                         if proposed_sat_per_kw < our_min_feerate {
2689                                 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2690                                         if our_min_feerate >= last_feerate {
2691                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2692                                         }
2693                                 }
2694                                 propose_new_feerate!(our_min_feerate);
2695                         }
2696                 }
2697
2698                 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2699                 self.channel_state = ChannelState::ShutdownComplete as u32;
2700                 self.channel_update_count += 1;
2701
2702                 Ok((Some(msgs::ClosingSigned {
2703                         channel_id: self.channel_id,
2704                         fee_satoshis: msg.fee_satoshis,
2705                         signature: our_sig,
2706                 }), Some(closing_tx)))
2707         }
2708
2709         // Public utilities:
2710
2711         pub fn channel_id(&self) -> [u8; 32] {
2712                 self.channel_id
2713         }
2714
2715         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2716         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2717         pub fn get_user_id(&self) -> u64 {
2718                 self.user_id
2719         }
2720
2721         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2722         pub fn channel_monitor(&self) -> ChannelMonitor {
2723                 if self.channel_state < ChannelState::FundingCreated as u32 {
2724                         panic!("Can't get a channel monitor until funding has been created");
2725                 }
2726                 self.channel_monitor.clone()
2727         }
2728
2729         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2730         /// is_usable() returns true).
2731         /// Allowed in any state (including after shutdown)
2732         pub fn get_short_channel_id(&self) -> Option<u64> {
2733                 self.short_channel_id
2734         }
2735
2736         /// Returns the funding_txo we either got from our peer, or were given by
2737         /// get_outbound_funding_created.
2738         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2739                 self.channel_monitor.get_funding_txo()
2740         }
2741
2742         /// Allowed in any state (including after shutdown)
2743         pub fn get_their_node_id(&self) -> PublicKey {
2744                 self.their_node_id
2745         }
2746
2747         /// Allowed in any state (including after shutdown)
2748         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2749                 self.our_htlc_minimum_msat
2750         }
2751
2752         /// Allowed in any state (including after shutdown)
2753         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2754                 self.our_htlc_minimum_msat
2755         }
2756
2757         pub fn get_value_satoshis(&self) -> u64 {
2758                 self.channel_value_satoshis
2759         }
2760
2761         pub fn get_fee_proportional_millionths(&self) -> u32 {
2762                 self.config.fee_proportional_millionths
2763         }
2764
2765         #[cfg(test)]
2766         pub fn get_feerate(&self) -> u64 {
2767                 self.feerate_per_kw
2768         }
2769
2770         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2771                 self.cur_local_commitment_transaction_number + 1
2772         }
2773
2774         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2775                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2776         }
2777
2778         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2779                 self.cur_remote_commitment_transaction_number + 2
2780         }
2781
2782         //TODO: Testing purpose only, should be changed in another way after #81
2783         #[cfg(test)]
2784         pub fn get_local_keys(&self) -> &ChannelKeys {
2785                 &self.local_keys
2786         }
2787
2788         #[cfg(test)]
2789         pub fn get_value_stat(&self) -> ChannelValueStat {
2790                 ChannelValueStat {
2791                         value_to_self_msat: self.value_to_self_msat,
2792                         channel_value_msat: self.channel_value_satoshis * 1000,
2793                         channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2794                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2795                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2796                         holding_cell_outbound_amount_msat: {
2797                                 let mut res = 0;
2798                                 for h in self.holding_cell_htlc_updates.iter() {
2799                                         match h {
2800                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2801                                                         res += amount_msat;
2802                                                 }
2803                                                 _ => {}
2804                                         }
2805                                 }
2806                                 res
2807                         },
2808                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2809                 }
2810         }
2811
2812         /// Allowed in any state (including after shutdown)
2813         pub fn get_channel_update_count(&self) -> u32 {
2814                 self.channel_update_count
2815         }
2816
2817         pub fn should_announce(&self) -> bool {
2818                 self.config.announced_channel
2819         }
2820
2821         pub fn is_outbound(&self) -> bool {
2822                 self.channel_outbound
2823         }
2824
2825         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2826         /// Allowed in any state (including after shutdown)
2827         pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2828                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2829                 // output value back into a transaction with the regular channel output:
2830
2831                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2832                 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2833
2834                 if self.channel_outbound {
2835                         // + the marginal fee increase cost to us in the commitment transaction:
2836                         res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2837                 }
2838
2839                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2840                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2841
2842                 res as u32
2843         }
2844
2845         /// Returns true if we've ever received a message from the remote end for this Channel
2846         pub fn have_received_message(&self) -> bool {
2847                 self.channel_state > (ChannelState::OurInitSent as u32)
2848         }
2849
2850         /// Returns true if this channel is fully established and not known to be closing.
2851         /// Allowed in any state (including after shutdown)
2852         pub fn is_usable(&self) -> bool {
2853                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2854                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2855         }
2856
2857         /// Returns true if this channel is currently available for use. This is a superset of
2858         /// is_usable() and considers things like the channel being temporarily disabled.
2859         /// Allowed in any state (including after shutdown)
2860         pub fn is_live(&self) -> bool {
2861                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2862         }
2863
2864         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2865         /// Allowed in any state (including after shutdown)
2866         pub fn is_awaiting_monitor_update(&self) -> bool {
2867                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2868         }
2869
2870         /// Returns true if funding_created was sent/received.
2871         pub fn is_funding_initiated(&self) -> bool {
2872                 self.channel_state >= ChannelState::FundingCreated as u32
2873         }
2874
2875         /// Returns true if this channel is fully shut down. True here implies that no further actions
2876         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2877         /// will be handled appropriately by the chain monitor.
2878         pub fn is_shutdown(&self) -> bool {
2879                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
2880                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2881                         true
2882                 } else { false }
2883         }
2884
2885         /// Called by channelmanager based on chain blocks being connected.
2886         /// Note that we only need to use this to detect funding_signed, anything else is handled by
2887         /// the channel_monitor.
2888         /// In case of Err, the channel may have been closed, at which point the standard requirements
2889         /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2890         /// Only returns an ErrorAction of DisconnectPeer, if Err.
2891         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
2892                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2893                 if header.bitcoin_hash() != self.last_block_connected {
2894                         self.last_block_connected = header.bitcoin_hash();
2895                         self.channel_monitor.last_block_hash = self.last_block_connected;
2896                         if self.funding_tx_confirmations > 0 {
2897                                 self.funding_tx_confirmations += 1;
2898                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2899                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2900                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
2901                                                 true
2902                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2903                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2904                                                 self.channel_update_count += 1;
2905                                                 true
2906                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2907                                                 // We got a reorg but not enough to trigger a force close, just update
2908                                                 // funding_tx_confirmed_in and return.
2909                                                 false
2910                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2911                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2912                                         } else {
2913                                                 // We got a reorg but not enough to trigger a force close, just update
2914                                                 // funding_tx_confirmed_in and return.
2915                                                 false
2916                                         };
2917                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2918
2919                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2920                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2921                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2922                                         //a protocol oversight, but I assume I'm just missing something.
2923                                         if need_commitment_update {
2924                                                 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2925                                                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2926                                                 return Ok(Some(msgs::FundingLocked {
2927                                                         channel_id: self.channel_id,
2928                                                         next_per_commitment_point: next_per_commitment_point,
2929                                                 }));
2930                                         }
2931                                 }
2932                         }
2933                 }
2934                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2935                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2936                                 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2937                                         let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2938                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2939                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
2940                                                 if self.channel_outbound {
2941                                                         // If we generated the funding transaction and it doesn't match what it
2942                                                         // should, the client is really broken and we should just panic and
2943                                                         // tell them off. That said, because hash collisions happen with high
2944                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
2945                                                         // channel and move on.
2946                                                         #[cfg(not(feature = "fuzztarget"))]
2947                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2948                                                 }
2949                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2950                                                 self.channel_update_count += 1;
2951                                                 return Err(msgs::ErrorMessage {
2952                                                         channel_id: self.channel_id(),
2953                                                         data: "funding tx had wrong script/value".to_owned()
2954                                                 });
2955                                         } else {
2956                                                 if self.channel_outbound {
2957                                                         for input in tx.input.iter() {
2958                                                                 if input.witness.is_empty() {
2959                                                                         // We generated a malleable funding transaction, implying we've
2960                                                                         // just exposed ourselves to funds loss to our counterparty.
2961                                                                         #[cfg(not(feature = "fuzztarget"))]
2962                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2963                                                                 }
2964                                                         }
2965                                                 }
2966                                                 self.funding_tx_confirmations = 1;
2967                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
2968                                                                              ((*index_in_block as u64) << (2*8)) |
2969                                                                              ((txo_idx as u64)         << (0*8)));
2970                                         }
2971                                 }
2972                         }
2973                 }
2974                 Ok(None)
2975         }
2976
2977         /// Called by channelmanager based on chain blocks being disconnected.
2978         /// Returns true if we need to close the channel now due to funding transaction
2979         /// unconfirmation/reorg.
2980         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2981                 if self.funding_tx_confirmations > 0 {
2982                         self.funding_tx_confirmations -= 1;
2983                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2984                                 return true;
2985                         }
2986                 }
2987                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2988                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2989                 }
2990                 self.last_block_connected = header.bitcoin_hash();
2991                 self.channel_monitor.last_block_hash = self.last_block_connected;
2992                 false
2993         }
2994
2995         // Methods to get unprompted messages to send to the remote end (or where we already returned
2996         // something in the handler for the message that prompted this message):
2997
2998         pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2999                 if !self.channel_outbound {
3000                         panic!("Tried to open a channel for an inbound channel?");
3001                 }
3002                 if self.channel_state != ChannelState::OurInitSent as u32 {
3003                         panic!("Cannot generate an open_channel after we've moved forward");
3004                 }
3005
3006                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3007                         panic!("Tried to send an open_channel for a channel that has already advanced");
3008                 }
3009
3010                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3011
3012                 msgs::OpenChannel {
3013                         chain_hash: chain_hash,
3014                         temporary_channel_id: self.channel_id,
3015                         funding_satoshis: self.channel_value_satoshis,
3016                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3017                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3018                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3019                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3020                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3021                         feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3022                         to_self_delay: BREAKDOWN_TIMEOUT,
3023                         max_accepted_htlcs: OUR_MAX_HTLCS,
3024                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3025                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3026                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3027                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3028                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3029                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3030                         channel_flags: if self.config.announced_channel {1} else {0},
3031                         shutdown_scriptpubkey: OptionalField::Absent
3032                 }
3033         }
3034
3035         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3036                 if self.channel_outbound {
3037                         panic!("Tried to send accept_channel for an outbound channel?");
3038                 }
3039                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3040                         panic!("Tried to send accept_channel after channel had moved forward");
3041                 }
3042                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3043                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3044                 }
3045
3046                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3047
3048                 msgs::AcceptChannel {
3049                         temporary_channel_id: self.channel_id,
3050                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3051                         max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3052                         channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3053                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3054                         minimum_depth: self.minimum_depth,
3055                         to_self_delay: BREAKDOWN_TIMEOUT,
3056                         max_accepted_htlcs: OUR_MAX_HTLCS,
3057                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3058                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3059                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3060                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3061                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3062                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3063                         shutdown_scriptpubkey: OptionalField::Absent
3064                 }
3065         }
3066
3067         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3068         fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
3069                 let funding_script = self.get_funding_redeemscript();
3070
3071                 let remote_keys = self.build_remote_transaction_keys()?;
3072                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3073                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
3074
3075                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
3076                 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
3077         }
3078
3079         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3080         /// a funding_created message for the remote peer.
3081         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3082         /// or if called on an inbound channel.
3083         /// Note that channel_id changes during this call!
3084         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3085         /// If an Err is returned, it is a ChannelError::Close.
3086         pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), ChannelError> {
3087                 if !self.channel_outbound {
3088                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3089                 }
3090                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3091                         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)");
3092                 }
3093                 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
3094                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3095                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3096                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3097                 }
3098
3099                 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
3100                 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
3101
3102                 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3103                         Ok(res) => res,
3104                         Err(e) => {
3105                                 log_error!(self, "Got bad signatures: {:?}!", e);
3106                                 self.channel_monitor.unset_funding_info();
3107                                 return Err(e);
3108                         }
3109                 };
3110
3111                 let temporary_channel_id = self.channel_id;
3112
3113                 // Now that we're past error-generating stuff, update our local state:
3114                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3115                 self.channel_state = ChannelState::FundingCreated as u32;
3116                 self.channel_id = funding_txo.to_channel_id();
3117                 self.cur_remote_commitment_transaction_number -= 1;
3118
3119                 Ok((msgs::FundingCreated {
3120                         temporary_channel_id: temporary_channel_id,
3121                         funding_txid: funding_txo.txid,
3122                         funding_output_index: funding_txo.index,
3123                         signature: our_signature
3124                 }, self.channel_monitor.clone()))
3125         }
3126
3127         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3128         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3129         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3130         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3131         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3132         /// closing).
3133         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3134         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3135         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3136                 if !self.config.announced_channel {
3137                         return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3138                 }
3139                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3140                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3141                 }
3142                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3143                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3144                 }
3145
3146                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3147                 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3148
3149                 let msg = msgs::UnsignedChannelAnnouncement {
3150                         features: msgs::GlobalFeatures::new(),
3151                         chain_hash: chain_hash,
3152                         short_channel_id: self.get_short_channel_id().unwrap(),
3153                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3154                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3155                         bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3156                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3157                         excess_data: Vec::new(),
3158                 };
3159
3160                 let msghash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
3161                 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3162
3163                 Ok((msg, sig))
3164         }
3165
3166         /// May panic if called on a channel that wasn't immediately-previously
3167         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3168         pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3169                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3170                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3171                 msgs::ChannelReestablish {
3172                         channel_id: self.channel_id(),
3173                         // The protocol has two different commitment number concepts - the "commitment
3174                         // transaction number", which starts from 0 and counts up, and the "revocation key
3175                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3176                         // commitment transaction numbers by the index which will be used to reveal the
3177                         // revocation key for that commitment transaction, which means we have to convert them
3178                         // to protocol-level commitment numbers here...
3179
3180                         // next_local_commitment_number is the next commitment_signed number we expect to
3181                         // receive (indicating if they need to resend one that we missed).
3182                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3183                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3184                         // receive, however we track it by the next commitment number for a remote transaction
3185                         // (which is one further, as they always revoke previous commitment transaction, not
3186                         // the one we send) so we have to decrement by 1. Note that if
3187                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3188                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3189                         // overflow here.
3190                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3191                         data_loss_protect: OptionalField::Absent,
3192                 }
3193         }
3194
3195
3196         // Send stuff to our remote peers:
3197
3198         /// Adds a pending outbound HTLC to this channel, note that you probably want
3199         /// send_htlc_and_commit instead cause you'll want both messages at once.
3200         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3201         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3202         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3203         /// You MUST call send_commitment prior to any other calls on this Channel
3204         /// If an Err is returned, it's a ChannelError::Ignore!
3205         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> {
3206                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3207                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3208                 }
3209
3210                 if amount_msat > self.channel_value_satoshis * 1000 {
3211                         return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3212                 }
3213                 if amount_msat < self.their_htlc_minimum_msat {
3214                         return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3215                 }
3216
3217                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3218                         // Note that this should never really happen, if we're !is_live() on receipt of an
3219                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3220                         // the user to send directly into a !is_live() channel. However, if we
3221                         // disconnected during the time the previous hop was doing the commitment dance we may
3222                         // end up getting here after the forwarding delay. In any case, returning an
3223                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3224                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3225                 }
3226
3227                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3228                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3229                         return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3230                 }
3231                 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3232                 // Check their_max_htlc_value_in_flight_msat
3233                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3234                         return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight"));
3235                 }
3236
3237                 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3238                 // reserve for them to have something to claim if we misbehave)
3239                 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3240                         return Err(ChannelError::Ignore("Cannot send value that would put us over the reserve value"));
3241                 }
3242
3243                 //TODO: Check cltv_expiry? Do this in channel manager?
3244
3245                 // Now update local state:
3246                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3247                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3248                                 amount_msat: amount_msat,
3249                                 payment_hash: payment_hash,
3250                                 cltv_expiry: cltv_expiry,
3251                                 source,
3252                                 onion_routing_packet: onion_routing_packet,
3253                         });
3254                         return Ok(None);
3255                 }
3256
3257                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3258                         htlc_id: self.next_local_htlc_id,
3259                         amount_msat: amount_msat,
3260                         payment_hash: payment_hash.clone(),
3261                         cltv_expiry: cltv_expiry,
3262                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3263                         source,
3264                 });
3265
3266                 let res = msgs::UpdateAddHTLC {
3267                         channel_id: self.channel_id,
3268                         htlc_id: self.next_local_htlc_id,
3269                         amount_msat: amount_msat,
3270                         payment_hash: payment_hash,
3271                         cltv_expiry: cltv_expiry,
3272                         onion_routing_packet: onion_routing_packet,
3273                 };
3274                 self.next_local_htlc_id += 1;
3275
3276                 Ok(Some(res))
3277         }
3278
3279         /// Creates a signed commitment transaction to send to the remote peer.
3280         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3281         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3282         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3283         pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3284                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3285                         panic!("Cannot create commitment tx until channel is fully established");
3286                 }
3287                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3288                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3289                 }
3290                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3291                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3292                 }
3293                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3294                         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");
3295                 }
3296                 let mut have_updates = self.pending_update_fee.is_some();
3297                 for htlc in self.pending_outbound_htlcs.iter() {
3298                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3299                                 have_updates = true;
3300                         }
3301                         if have_updates { break; }
3302                 }
3303                 for htlc in self.pending_inbound_htlcs.iter() {
3304                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3305                                 have_updates = true;
3306                         }
3307                         if have_updates { break; }
3308                 }
3309                 if !have_updates {
3310                         panic!("Cannot create commitment tx until we have some updates to send");
3311                 }
3312                 self.send_commitment_no_status_check()
3313         }
3314         /// Only fails in case of bad keys
3315         fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3316                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3317                 // fail to generate this, we still are at least at a position where upgrading their status
3318                 // is acceptable.
3319                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3320                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3321                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3322                         } else { None };
3323                         if let Some(state) = new_state {
3324                                 htlc.state = state;
3325                         }
3326                 }
3327                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3328                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3329                                 Some(fail_reason.take())
3330                         } else { None } {
3331                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3332                         }
3333                 }
3334                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3335
3336                 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3337                         Ok((res, (remote_commitment_tx, mut htlcs))) => {
3338                                 // Update state now that we've passed all the can-fail calls...
3339                                 let htlcs_no_ref = htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3340                                 (res, remote_commitment_tx, htlcs_no_ref)
3341                         },
3342                         Err(e) => return Err(e),
3343                 };
3344
3345                 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx, htlcs, self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3346                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3347                 Ok((res, self.channel_monitor.clone()))
3348         }
3349
3350         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3351         /// when we shouldn't change HTLC/channel state.
3352         fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3353                 let funding_script = self.get_funding_redeemscript();
3354
3355                 let mut feerate_per_kw = self.feerate_per_kw;
3356                 if let Some(feerate) = self.pending_update_fee {
3357                         if self.channel_outbound {
3358                                 feerate_per_kw = feerate;
3359                         }
3360                 }
3361
3362                 let remote_keys = self.build_remote_transaction_keys()?;
3363                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3364                 let remote_commitment_txid = remote_commitment_tx.0.txid();
3365                 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
3366                 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3367                 log_trace!(self, "Signing remote commitment tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&remote_commitment_tx.0), encode::serialize_hex(&funding_script), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize()), log_bytes!(our_sig.serialize_compact()[..]));
3368
3369                 let mut htlc_sigs = Vec::with_capacity(remote_commitment_tx.1);
3370                 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3371                         if let Some(_) = htlc.transaction_output_index {
3372                                 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3373                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3374                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
3375                                 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
3376                                 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3377                                 log_trace!(self, "Signing remote HTLC tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key).serialize()), log_bytes!(htlc_sigs.last().unwrap().serialize_compact()[..]));
3378                         }
3379                 }
3380
3381                 Ok((msgs::CommitmentSigned {
3382                         channel_id: self.channel_id,
3383                         signature: our_sig,
3384                         htlc_signatures: htlc_sigs,
3385                 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3386         }
3387
3388         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3389         /// to send to the remote peer in one go.
3390         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3391         /// more info.
3392         pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
3393                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3394                         Some(update_add_htlc) => {
3395                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3396                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3397                         },
3398                         None => Ok(None)
3399                 }
3400         }
3401
3402         /// Begins the shutdown process, getting a message for the remote peer and returning all
3403         /// holding cell HTLCs for payment failure.
3404         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3405                 for htlc in self.pending_outbound_htlcs.iter() {
3406                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3407                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3408                         }
3409                 }
3410                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3411                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3412                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3413                         }
3414                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3415                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3416                         }
3417                 }
3418                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3419                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3420                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3421                 }
3422
3423                 let our_closing_script = self.get_closing_scriptpubkey();
3424
3425                 // From here on out, we may not fail!
3426                 if self.channel_state < ChannelState::FundingSent as u32 {
3427                         self.channel_state = ChannelState::ShutdownComplete as u32;
3428                 } else {
3429                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3430                 }
3431                 self.channel_update_count += 1;
3432
3433                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3434                 // our shutdown until we've committed all of the pending changes.
3435                 self.holding_cell_update_fee = None;
3436                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3437                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3438                         match htlc_update {
3439                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3440                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3441                                         false
3442                                 },
3443                                 _ => true
3444                         }
3445                 });
3446
3447                 Ok((msgs::Shutdown {
3448                         channel_id: self.channel_id,
3449                         scriptpubkey: our_closing_script,
3450                 }, dropped_outbound_htlcs))
3451         }
3452
3453         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3454         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3455         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3456         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3457         /// immediately (others we will have to allow to time out).
3458         pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>) {
3459                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3460
3461                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3462                 // return them to fail the payment.
3463                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3464                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3465                         match htlc_update {
3466                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3467                                         dropped_outbound_htlcs.push((source, payment_hash));
3468                                 },
3469                                 _ => {}
3470                         }
3471                 }
3472
3473                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3474                         //TODO: Do something with the remaining HTLCs
3475                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3476                         //which correspond)
3477                 }
3478
3479                 self.channel_state = ChannelState::ShutdownComplete as u32;
3480                 self.channel_update_count += 1;
3481                 let mut res = Vec::new();
3482                 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3483                 (res, dropped_outbound_htlcs)
3484         }
3485 }
3486
3487 const SERIALIZATION_VERSION: u8 = 1;
3488 const MIN_SERIALIZATION_VERSION: u8 = 1;
3489
3490 impl Writeable for InboundHTLCRemovalReason {
3491         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3492                 match self {
3493                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3494                                 0u8.write(writer)?;
3495                                 error_packet.write(writer)?;
3496                         },
3497                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3498                                 1u8.write(writer)?;
3499                                 onion_hash.write(writer)?;
3500                                 err_code.write(writer)?;
3501                         },
3502                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3503                                 2u8.write(writer)?;
3504                                 payment_preimage.write(writer)?;
3505                         },
3506                 }
3507                 Ok(())
3508         }
3509 }
3510
3511 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3512         fn read(reader: &mut R) -> Result<Self, DecodeError> {
3513                 Ok(match <u8 as Readable<R>>::read(reader)? {
3514                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3515                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3516                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3517                         _ => return Err(DecodeError::InvalidValue),
3518                 })
3519         }
3520 }
3521
3522 impl Writeable for Channel {
3523         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3524                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3525                 // called but include holding cell updates (and obviously we don't modify self).
3526
3527                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3528                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3529
3530                 self.user_id.write(writer)?;
3531                 self.config.write(writer)?;
3532
3533                 self.channel_id.write(writer)?;
3534                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3535                 self.channel_outbound.write(writer)?;
3536                 self.channel_value_satoshis.write(writer)?;
3537
3538                 self.local_keys.write(writer)?;
3539                 self.shutdown_pubkey.write(writer)?;
3540
3541                 self.cur_local_commitment_transaction_number.write(writer)?;
3542                 self.cur_remote_commitment_transaction_number.write(writer)?;
3543                 self.value_to_self_msat.write(writer)?;
3544
3545                 let mut dropped_inbound_htlcs = 0;
3546                 for htlc in self.pending_inbound_htlcs.iter() {
3547                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3548                                 dropped_inbound_htlcs += 1;
3549                         }
3550                 }
3551                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3552                 for htlc in self.pending_inbound_htlcs.iter() {
3553                         htlc.htlc_id.write(writer)?;
3554                         htlc.amount_msat.write(writer)?;
3555                         htlc.cltv_expiry.write(writer)?;
3556                         htlc.payment_hash.write(writer)?;
3557                         match &htlc.state {
3558                                 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3559                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3560                                         1u8.write(writer)?;
3561                                         htlc_state.write(writer)?;
3562                                 },
3563                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3564                                         2u8.write(writer)?;
3565                                         htlc_state.write(writer)?;
3566                                 },
3567                                 &InboundHTLCState::Committed => {
3568                                         3u8.write(writer)?;
3569                                 },
3570                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3571                                         4u8.write(writer)?;
3572                                         removal_reason.write(writer)?;
3573                                 },
3574                         }
3575                 }
3576
3577                 macro_rules! write_option {
3578                         ($thing: expr) => {
3579                                 match &$thing {
3580                                         &None => 0u8.write(writer)?,
3581                                         &Some(ref v) => {
3582                                                 1u8.write(writer)?;
3583                                                 v.write(writer)?;
3584                                         },
3585                                 }
3586                         }
3587                 }
3588
3589                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3590                 for htlc in self.pending_outbound_htlcs.iter() {
3591                         htlc.htlc_id.write(writer)?;
3592                         htlc.amount_msat.write(writer)?;
3593                         htlc.cltv_expiry.write(writer)?;
3594                         htlc.payment_hash.write(writer)?;
3595                         htlc.source.write(writer)?;
3596                         match &htlc.state {
3597                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3598                                         0u8.write(writer)?;
3599                                         onion_packet.write(writer)?;
3600                                 },
3601                                 &OutboundHTLCState::Committed => {
3602                                         1u8.write(writer)?;
3603                                 },
3604                                 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3605                                         2u8.write(writer)?;
3606                                         write_option!(*fail_reason);
3607                                 },
3608                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3609                                         3u8.write(writer)?;
3610                                         write_option!(*fail_reason);
3611                                 },
3612                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3613                                         4u8.write(writer)?;
3614                                         write_option!(*fail_reason);
3615                                 },
3616                         }
3617                 }
3618
3619                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3620                 for update in self.holding_cell_htlc_updates.iter() {
3621                         match update {
3622                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3623                                         0u8.write(writer)?;
3624                                         amount_msat.write(writer)?;
3625                                         cltv_expiry.write(writer)?;
3626                                         payment_hash.write(writer)?;
3627                                         source.write(writer)?;
3628                                         onion_routing_packet.write(writer)?;
3629                                 },
3630                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3631                                         1u8.write(writer)?;
3632                                         payment_preimage.write(writer)?;
3633                                         htlc_id.write(writer)?;
3634                                 },
3635                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3636                                         2u8.write(writer)?;
3637                                         htlc_id.write(writer)?;
3638                                         err_packet.write(writer)?;
3639                                 }
3640                         }
3641                 }
3642
3643                 match self.resend_order {
3644                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3645                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3646                 }
3647
3648                 self.monitor_pending_revoke_and_ack.write(writer)?;
3649                 self.monitor_pending_commitment_signed.write(writer)?;
3650
3651                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3652                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3653                         pending_forward.write(writer)?;
3654                         htlc_id.write(writer)?;
3655                 }
3656
3657                 (self.monitor_pending_failures.len() as u64).write(writer)?;
3658                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3659                         htlc_source.write(writer)?;
3660                         payment_hash.write(writer)?;
3661                         fail_reason.write(writer)?;
3662                 }
3663
3664                 write_option!(self.pending_update_fee);
3665                 write_option!(self.holding_cell_update_fee);
3666
3667                 self.next_local_htlc_id.write(writer)?;
3668                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3669                 self.channel_update_count.write(writer)?;
3670                 self.feerate_per_kw.write(writer)?;
3671
3672                 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3673                 for tx in self.last_local_commitment_txn.iter() {
3674                         if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3675                                 match e {
3676                                         encode::Error::Io(e) => return Err(e),
3677                                         _ => panic!("last_local_commitment_txn must have been well-formed!"),
3678                                 }
3679                         }
3680                 }
3681
3682                 match self.last_sent_closing_fee {
3683                         Some((feerate, fee)) => {
3684                                 1u8.write(writer)?;
3685                                 feerate.write(writer)?;
3686                                 fee.write(writer)?;
3687                         },
3688                         None => 0u8.write(writer)?,
3689                 }
3690
3691                 write_option!(self.funding_tx_confirmed_in);
3692                 write_option!(self.short_channel_id);
3693
3694                 self.last_block_connected.write(writer)?;
3695                 self.funding_tx_confirmations.write(writer)?;
3696
3697                 self.their_dust_limit_satoshis.write(writer)?;
3698                 self.our_dust_limit_satoshis.write(writer)?;
3699                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3700                 self.their_channel_reserve_satoshis.write(writer)?;
3701                 self.their_htlc_minimum_msat.write(writer)?;
3702                 self.our_htlc_minimum_msat.write(writer)?;
3703                 self.their_to_self_delay.write(writer)?;
3704                 self.their_max_accepted_htlcs.write(writer)?;
3705                 self.minimum_depth.write(writer)?;
3706
3707                 write_option!(self.their_funding_pubkey);
3708                 write_option!(self.their_revocation_basepoint);
3709                 write_option!(self.their_payment_basepoint);
3710                 write_option!(self.their_delayed_payment_basepoint);
3711                 write_option!(self.their_htlc_basepoint);
3712                 write_option!(self.their_cur_commitment_point);
3713
3714                 write_option!(self.their_prev_commitment_point);
3715                 self.their_node_id.write(writer)?;
3716
3717                 write_option!(self.their_shutdown_scriptpubkey);
3718
3719                 self.channel_monitor.write_for_disk(writer)?;
3720                 Ok(())
3721         }
3722 }
3723
3724 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3725         fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3726                 let _ver: u8 = Readable::read(reader)?;
3727                 let min_ver: u8 = Readable::read(reader)?;
3728                 if min_ver > SERIALIZATION_VERSION {
3729                         return Err(DecodeError::UnknownVersion);
3730                 }
3731
3732                 let user_id = Readable::read(reader)?;
3733                 let config: ChannelConfig = Readable::read(reader)?;
3734
3735                 let channel_id = Readable::read(reader)?;
3736                 let channel_state = Readable::read(reader)?;
3737                 let channel_outbound = Readable::read(reader)?;
3738                 let channel_value_satoshis = Readable::read(reader)?;
3739
3740                 let local_keys = Readable::read(reader)?;
3741                 let shutdown_pubkey = Readable::read(reader)?;
3742
3743                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3744                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3745                 let value_to_self_msat = Readable::read(reader)?;
3746
3747                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3748                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3749                 for _ in 0..pending_inbound_htlc_count {
3750                         pending_inbound_htlcs.push(InboundHTLCOutput {
3751                                 htlc_id: Readable::read(reader)?,
3752                                 amount_msat: Readable::read(reader)?,
3753                                 cltv_expiry: Readable::read(reader)?,
3754                                 payment_hash: Readable::read(reader)?,
3755                                 state: match <u8 as Readable<R>>::read(reader)? {
3756                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3757                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3758                                         3 => InboundHTLCState::Committed,
3759                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3760                                         _ => return Err(DecodeError::InvalidValue),
3761                                 },
3762                         });
3763                 }
3764
3765                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3766                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3767                 for _ in 0..pending_outbound_htlc_count {
3768                         pending_outbound_htlcs.push(OutboundHTLCOutput {
3769                                 htlc_id: Readable::read(reader)?,
3770                                 amount_msat: Readable::read(reader)?,
3771                                 cltv_expiry: Readable::read(reader)?,
3772                                 payment_hash: Readable::read(reader)?,
3773                                 source: Readable::read(reader)?,
3774                                 state: match <u8 as Readable<R>>::read(reader)? {
3775                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3776                                         1 => OutboundHTLCState::Committed,
3777                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
3778                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
3779                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
3780                                         _ => return Err(DecodeError::InvalidValue),
3781                                 },
3782                         });
3783                 }
3784
3785                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3786                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3787                 for _ in 0..holding_cell_htlc_update_count {
3788                         holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3789                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
3790                                         amount_msat: Readable::read(reader)?,
3791                                         cltv_expiry: Readable::read(reader)?,
3792                                         payment_hash: Readable::read(reader)?,
3793                                         source: Readable::read(reader)?,
3794                                         onion_routing_packet: Readable::read(reader)?,
3795                                 },
3796                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3797                                         payment_preimage: Readable::read(reader)?,
3798                                         htlc_id: Readable::read(reader)?,
3799                                 },
3800                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
3801                                         htlc_id: Readable::read(reader)?,
3802                                         err_packet: Readable::read(reader)?,
3803                                 },
3804                                 _ => return Err(DecodeError::InvalidValue),
3805                         });
3806                 }
3807
3808                 let resend_order = match <u8 as Readable<R>>::read(reader)? {
3809                         0 => RAACommitmentOrder::CommitmentFirst,
3810                         1 => RAACommitmentOrder::RevokeAndACKFirst,
3811                         _ => return Err(DecodeError::InvalidValue),
3812                 };
3813
3814                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3815                 let monitor_pending_commitment_signed = Readable::read(reader)?;
3816
3817                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3818                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3819                 for _ in 0..monitor_pending_forwards_count {
3820                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3821                 }
3822
3823                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3824                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3825                 for _ in 0..monitor_pending_failures_count {
3826                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3827                 }
3828
3829                 let pending_update_fee = Readable::read(reader)?;
3830                 let holding_cell_update_fee = Readable::read(reader)?;
3831
3832                 let next_local_htlc_id = Readable::read(reader)?;
3833                 let next_remote_htlc_id = Readable::read(reader)?;
3834                 let channel_update_count = Readable::read(reader)?;
3835                 let feerate_per_kw = Readable::read(reader)?;
3836
3837                 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3838                 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3839                 for _ in 0..last_local_commitment_txn_count {
3840                         last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3841                                 Ok(tx) => tx,
3842                                 Err(_) => return Err(DecodeError::InvalidValue),
3843                         });
3844                 }
3845
3846                 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3847                         0 => None,
3848                         1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3849                         _ => return Err(DecodeError::InvalidValue),
3850                 };
3851
3852                 let funding_tx_confirmed_in = Readable::read(reader)?;
3853                 let short_channel_id = Readable::read(reader)?;
3854
3855                 let last_block_connected = Readable::read(reader)?;
3856                 let funding_tx_confirmations = Readable::read(reader)?;
3857
3858                 let their_dust_limit_satoshis = Readable::read(reader)?;
3859                 let our_dust_limit_satoshis = Readable::read(reader)?;
3860                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3861                 let their_channel_reserve_satoshis = Readable::read(reader)?;
3862                 let their_htlc_minimum_msat = Readable::read(reader)?;
3863                 let our_htlc_minimum_msat = Readable::read(reader)?;
3864                 let their_to_self_delay = Readable::read(reader)?;
3865                 let their_max_accepted_htlcs = Readable::read(reader)?;
3866                 let minimum_depth = Readable::read(reader)?;
3867
3868                 let their_funding_pubkey = Readable::read(reader)?;
3869                 let their_revocation_basepoint = Readable::read(reader)?;
3870                 let their_payment_basepoint = Readable::read(reader)?;
3871                 let their_delayed_payment_basepoint = Readable::read(reader)?;
3872                 let their_htlc_basepoint = Readable::read(reader)?;
3873                 let their_cur_commitment_point = Readable::read(reader)?;
3874
3875                 let their_prev_commitment_point = Readable::read(reader)?;
3876                 let their_node_id = Readable::read(reader)?;
3877
3878                 let their_shutdown_scriptpubkey = Readable::read(reader)?;
3879                 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3880                 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3881                 // doing full block connection operations on the internal CHannelMonitor copies
3882                 if monitor_last_block != last_block_connected {
3883                         return Err(DecodeError::InvalidValue);
3884                 }
3885
3886                 Ok(Channel {
3887                         user_id,
3888
3889                         config,
3890                         channel_id,
3891                         channel_state,
3892                         channel_outbound,
3893                         secp_ctx: Secp256k1::new(),
3894                         channel_value_satoshis,
3895
3896                         local_keys,
3897                         shutdown_pubkey,
3898
3899                         cur_local_commitment_transaction_number,
3900                         cur_remote_commitment_transaction_number,
3901                         value_to_self_msat,
3902
3903                         pending_inbound_htlcs,
3904                         pending_outbound_htlcs,
3905                         holding_cell_htlc_updates,
3906
3907                         resend_order,
3908
3909                         monitor_pending_revoke_and_ack,
3910                         monitor_pending_commitment_signed,
3911                         monitor_pending_forwards,
3912                         monitor_pending_failures,
3913
3914                         pending_update_fee,
3915                         holding_cell_update_fee,
3916                         next_local_htlc_id,
3917                         next_remote_htlc_id,
3918                         channel_update_count,
3919                         feerate_per_kw,
3920
3921                         #[cfg(debug_assertions)]
3922                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3923                         #[cfg(debug_assertions)]
3924                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3925
3926                         last_local_commitment_txn,
3927
3928                         last_sent_closing_fee,
3929
3930                         funding_tx_confirmed_in,
3931                         short_channel_id,
3932                         last_block_connected,
3933                         funding_tx_confirmations,
3934
3935                         their_dust_limit_satoshis,
3936                         our_dust_limit_satoshis,
3937                         their_max_htlc_value_in_flight_msat,
3938                         their_channel_reserve_satoshis,
3939                         their_htlc_minimum_msat,
3940                         our_htlc_minimum_msat,
3941                         their_to_self_delay,
3942                         their_max_accepted_htlcs,
3943                         minimum_depth,
3944
3945                         their_funding_pubkey,
3946                         their_revocation_basepoint,
3947                         their_payment_basepoint,
3948                         their_delayed_payment_basepoint,
3949                         their_htlc_basepoint,
3950                         their_cur_commitment_point,
3951
3952                         their_prev_commitment_point,
3953                         their_node_id,
3954
3955                         their_shutdown_scriptpubkey,
3956
3957                         channel_monitor,
3958
3959                         logger,
3960                 })
3961         }
3962 }
3963
3964 #[cfg(test)]
3965 mod tests {
3966         use bitcoin::util::bip143;
3967         use bitcoin::consensus::encode::serialize;
3968         use bitcoin::blockdata::script::{Script, Builder};
3969         use bitcoin::blockdata::transaction::Transaction;
3970         use bitcoin::blockdata::opcodes;
3971         use bitcoin_hashes::hex::FromHex;
3972         use hex;
3973         use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
3974         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3975         use ln::channel::MAX_FUNDING_SATOSHIS;
3976         use ln::chan_utils;
3977         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3978         use chain::keysinterface::KeysInterface;
3979         use chain::transaction::OutPoint;
3980         use util::config::UserConfig;
3981         use util::test_utils;
3982         use util::logger::Logger;
3983         use secp256k1::{Secp256k1,Message,Signature};
3984         use secp256k1::key::{SecretKey,PublicKey};
3985         use bitcoin_hashes::sha256::Hash as Sha256;
3986         use bitcoin_hashes::sha256d::Hash as Sha256dHash;
3987         use bitcoin_hashes::hash160::Hash as Hash160;
3988         use bitcoin_hashes::Hash;
3989         use std::sync::Arc;
3990
3991         struct TestFeeEstimator {
3992                 fee_est: u64
3993         }
3994         impl FeeEstimator for TestFeeEstimator {
3995                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3996                         self.fee_est
3997                 }
3998         }
3999
4000         #[test]
4001         fn test_max_funding_satoshis() {
4002                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4003                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4004         }
4005
4006         struct Keys {
4007                 chan_keys: ChannelKeys,
4008         }
4009         impl KeysInterface for Keys {
4010                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4011                 fn get_destination_script(&self) -> Script {
4012                         let secp_ctx = Secp256k1::signing_only();
4013                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4014                         let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4015                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4016                 }
4017
4018                 fn get_shutdown_pubkey(&self) -> PublicKey {
4019                         let secp_ctx = Secp256k1::signing_only();
4020                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4021                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4022                 }
4023
4024                 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
4025                 fn get_session_key(&self) -> SecretKey { panic!(); }
4026                 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4027         }
4028
4029         #[test]
4030         fn outbound_commitment_test() {
4031                 // Test vectors from BOLT 3 Appendix C:
4032                 let feeest = TestFeeEstimator{fee_est: 15000};
4033                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4034                 let secp_ctx = Secp256k1::new();
4035
4036                 let chan_keys = ChannelKeys {
4037                         funding_key: SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4038                         payment_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4039                         delayed_payment_base_key: SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4040                         htlc_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4041
4042                         // These aren't set in the test vectors:
4043                         revocation_base_key: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4044                         commitment_seed: [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],
4045                 };
4046                 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
4047                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4048                 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
4049
4050                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4051                 let mut config = UserConfig::new();
4052                 config.channel_options.announced_channel = false;
4053                 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4054                 chan.their_to_self_delay = 144;
4055                 chan.our_dust_limit_satoshis = 546;
4056
4057                 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4058                 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
4059
4060                 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4061                 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
4062                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4063
4064                 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
4065                 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
4066                                 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4067
4068                 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4069                 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
4070                                 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4071
4072                 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
4073
4074                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4075                 // derived from a commitment_seed, so instead we copy it here and call
4076                 // build_commitment_transaction.
4077                 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
4078                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4079                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4080                 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
4081                 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
4082
4083                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4084
4085                 macro_rules! test_commitment {
4086                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
4087                                 unsigned_tx = {
4088                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4089                                         let htlcs = res.2.drain(..)
4090                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4091                                                 .collect();
4092                                         (res.0, htlcs)
4093                                 };
4094                                 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4095                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &chan.get_funding_redeemscript(), chan.channel_value_satoshis)[..]).unwrap();
4096                                 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
4097
4098                                 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
4099
4100                                 assert_eq!(serialize(&unsigned_tx.0)[..],
4101                                                 hex::decode($tx_hex).unwrap()[..]);
4102                         };
4103                 }
4104
4105                 macro_rules! test_htlc_output {
4106                         ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4107                                 let remote_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4108
4109                                 let ref htlc = unsigned_tx.1[$htlc_idx];
4110                                 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4111                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4112                                 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4113                                 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4114
4115                                 let mut preimage: Option<PaymentPreimage> = None;
4116                                 if !htlc.offered {
4117                                         for i in 0..5 {
4118                                                 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4119                                                 if out == htlc.payment_hash {
4120                                                         preimage = Some(PaymentPreimage([i; 32]));
4121                                                 }
4122                                         }
4123
4124                                         assert!(preimage.is_some());
4125                                 }
4126
4127                                 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
4128                                 assert_eq!(serialize(&htlc_tx)[..],
4129                                                 hex::decode($tx_hex).unwrap()[..]);
4130                         };
4131                 }
4132
4133                 {
4134                         // simple commitment tx with no HTLCs
4135                         chan.value_to_self_msat = 7000000000;
4136
4137                         test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4138                                          "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4139                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4140                 }
4141
4142                 chan.pending_inbound_htlcs.push({
4143                         let mut out = InboundHTLCOutput{
4144                                 htlc_id: 0,
4145                                 amount_msat: 1000000,
4146                                 cltv_expiry: 500,
4147                                 payment_hash: PaymentHash([0; 32]),
4148                                 state: InboundHTLCState::Committed,
4149                         };
4150                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4151                         out
4152                 });
4153                 chan.pending_inbound_htlcs.push({
4154                         let mut out = InboundHTLCOutput{
4155                                 htlc_id: 1,
4156                                 amount_msat: 2000000,
4157                                 cltv_expiry: 501,
4158                                 payment_hash: PaymentHash([0; 32]),
4159                                 state: InboundHTLCState::Committed,
4160                         };
4161                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4162                         out
4163                 });
4164                 chan.pending_outbound_htlcs.push({
4165                         let mut out = OutboundHTLCOutput{
4166                                 htlc_id: 2,
4167                                 amount_msat: 2000000,
4168                                 cltv_expiry: 502,
4169                                 payment_hash: PaymentHash([0; 32]),
4170                                 state: OutboundHTLCState::Committed,
4171                                 source: HTLCSource::dummy(),
4172                         };
4173                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4174                         out
4175                 });
4176                 chan.pending_outbound_htlcs.push({
4177                         let mut out = OutboundHTLCOutput{
4178                                 htlc_id: 3,
4179                                 amount_msat: 3000000,
4180                                 cltv_expiry: 503,
4181                                 payment_hash: PaymentHash([0; 32]),
4182                                 state: OutboundHTLCState::Committed,
4183                                 source: HTLCSource::dummy(),
4184                         };
4185                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4186                         out
4187                 });
4188                 chan.pending_inbound_htlcs.push({
4189                         let mut out = InboundHTLCOutput{
4190                                 htlc_id: 4,
4191                                 amount_msat: 4000000,
4192                                 cltv_expiry: 504,
4193                                 payment_hash: PaymentHash([0; 32]),
4194                                 state: InboundHTLCState::Committed,
4195                         };
4196                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4197                         out
4198                 });
4199
4200                 {
4201                         // commitment tx with all five HTLCs untrimmed (minimum feerate)
4202                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4203                         chan.feerate_per_kw = 0;
4204
4205                         test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4206                                          "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4207                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4208
4209                         assert_eq!(unsigned_tx.1.len(), 5);
4210
4211                         test_htlc_output!(0,
4212                                           "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4213                                           "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4214                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4215
4216                         test_htlc_output!(1,
4217                                           "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4218                                           "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4219                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4220
4221                         test_htlc_output!(2,
4222                                           "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4223                                           "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4224                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4225
4226                         test_htlc_output!(3,
4227                                           "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4228                                           "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4229                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4230
4231                         test_htlc_output!(4,
4232                                           "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4233                                           "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4234                                           "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4235                 }
4236
4237                 {
4238                         // commitment tx with seven outputs untrimmed (maximum feerate)
4239                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4240                         chan.feerate_per_kw = 647;
4241
4242                         test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4243                                          "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4244                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4245
4246                         assert_eq!(unsigned_tx.1.len(), 5);
4247
4248                         test_htlc_output!(0,
4249                                           "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4250                                           "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4251                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4252
4253                         test_htlc_output!(1,
4254                                           "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4255                                           "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4256                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4257
4258                         test_htlc_output!(2,
4259                                           "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4260                                           "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4261                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4262
4263                         test_htlc_output!(3,
4264                                           "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4265                                           "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4266                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4267
4268                         test_htlc_output!(4,
4269                                           "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4270                                           "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4271                                           "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4272                 }
4273
4274                 {
4275                         // commitment tx with six outputs untrimmed (minimum feerate)
4276                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4277                         chan.feerate_per_kw = 648;
4278
4279                         test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4280                                          "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4281                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4282
4283                         assert_eq!(unsigned_tx.1.len(), 4);
4284
4285                         test_htlc_output!(0,
4286                                           "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4287                                           "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4288                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4289
4290                         test_htlc_output!(1,
4291                                           "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4292                                           "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4293                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4294
4295                         test_htlc_output!(2,
4296                                           "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4297                                           "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4298                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4299
4300                         test_htlc_output!(3,
4301                                           "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4302                                           "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4303                                           "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4304                 }
4305
4306                 {
4307                         // commitment tx with six outputs untrimmed (maximum feerate)
4308                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4309                         chan.feerate_per_kw = 2069;
4310
4311                         test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4312                                          "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4313                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4314
4315                         assert_eq!(unsigned_tx.1.len(), 4);
4316
4317                         test_htlc_output!(0,
4318                                           "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4319                                           "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4320                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4321
4322                         test_htlc_output!(1,
4323                                           "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4324                                           "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4325                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4326
4327                         test_htlc_output!(2,
4328                                           "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4329                                           "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4330                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4331
4332                         test_htlc_output!(3,
4333                                           "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4334                                           "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4335                                           "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4336                 }
4337
4338                 {
4339                         // commitment tx with five outputs untrimmed (minimum feerate)
4340                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4341                         chan.feerate_per_kw = 2070;
4342
4343                         test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4344                                          "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4345                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4346
4347                         assert_eq!(unsigned_tx.1.len(), 3);
4348
4349                         test_htlc_output!(0,
4350                                           "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4351                                           "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4352                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4353
4354                         test_htlc_output!(1,
4355                                           "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4356                                           "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4357                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4358
4359                         test_htlc_output!(2,
4360                                           "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4361                                           "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4362                                           "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4363                 }
4364
4365                 {
4366                         // commitment tx with five outputs untrimmed (maximum feerate)
4367                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4368                         chan.feerate_per_kw = 2194;
4369
4370                         test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4371                                          "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4372                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4373
4374                         assert_eq!(unsigned_tx.1.len(), 3);
4375
4376                         test_htlc_output!(0,
4377                                           "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4378                                           "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4379                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4380
4381                         test_htlc_output!(1,
4382                                           "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4383                                           "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4384                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4385
4386                         test_htlc_output!(2,
4387                                           "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4388                                           "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4389                                           "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4390                 }
4391
4392                 {
4393                         // commitment tx with four outputs untrimmed (minimum feerate)
4394                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4395                         chan.feerate_per_kw = 2195;
4396
4397                         test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4398                                          "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4399                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4400
4401                         assert_eq!(unsigned_tx.1.len(), 2);
4402
4403                         test_htlc_output!(0,
4404                                           "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4405                                           "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4406                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4407
4408                         test_htlc_output!(1,
4409                                           "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4410                                           "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4411                                           "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4412                 }
4413
4414                 {
4415                         // commitment tx with four outputs untrimmed (maximum feerate)
4416                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4417                         chan.feerate_per_kw = 3702;
4418
4419                         test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4420                                          "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4421                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4422
4423                         assert_eq!(unsigned_tx.1.len(), 2);
4424
4425                         test_htlc_output!(0,
4426                                           "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4427                                           "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4428                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4429
4430                         test_htlc_output!(1,
4431                                           "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4432                                           "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4433                                           "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4434                 }
4435
4436                 {
4437                         // commitment tx with three outputs untrimmed (minimum feerate)
4438                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4439                         chan.feerate_per_kw = 3703;
4440
4441                         test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4442                                          "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4443                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4444
4445                         assert_eq!(unsigned_tx.1.len(), 1);
4446
4447                         test_htlc_output!(0,
4448                                           "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4449                                           "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4450                                           "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4451                 }
4452
4453                 {
4454                         // commitment tx with three outputs untrimmed (maximum feerate)
4455                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4456                         chan.feerate_per_kw = 4914;
4457
4458                         test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4459                                          "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4460                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4461
4462                         assert_eq!(unsigned_tx.1.len(), 1);
4463
4464                         test_htlc_output!(0,
4465                                           "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4466                                           "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4467                                           "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4468                 }
4469
4470                 {
4471                         // commitment tx with two outputs untrimmed (minimum feerate)
4472                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4473                         chan.feerate_per_kw = 4915;
4474
4475                         test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4476                                          "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4477                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4478
4479                         assert_eq!(unsigned_tx.1.len(), 0);
4480                 }
4481
4482                 {
4483                         // commitment tx with two outputs untrimmed (maximum feerate)
4484                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4485                         chan.feerate_per_kw = 9651180;
4486
4487                         test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4488                                          "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4489                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4490
4491                         assert_eq!(unsigned_tx.1.len(), 0);
4492                 }
4493
4494                 {
4495                         // commitment tx with one output untrimmed (minimum feerate)
4496                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4497                         chan.feerate_per_kw = 9651181;
4498
4499                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4500                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4501                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4502
4503                         assert_eq!(unsigned_tx.1.len(), 0);
4504                 }
4505
4506                 {
4507                         // commitment tx with fee greater than funder amount
4508                         chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4509                         chan.feerate_per_kw = 9651936;
4510
4511                         test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4512                                          "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4513                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4514
4515                         assert_eq!(unsigned_tx.1.len(), 0);
4516                 }
4517         }
4518
4519         #[test]
4520         fn test_per_commitment_secret_gen() {
4521                 // Test vectors from BOLT 3 Appendix D:
4522
4523                 let mut seed = [0; 32];
4524                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4525                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4526                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4527
4528                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4529                 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4530                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4531
4532                 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4533                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4534
4535                 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4536                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4537
4538                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4539                 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4540                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4541         }
4542
4543         #[test]
4544         fn test_key_derivation() {
4545                 // Test vectors from BOLT 3 Appendix E:
4546                 let secp_ctx = Secp256k1::new();
4547
4548                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4549                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4550
4551                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4552                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4553
4554                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4555                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4556
4557                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4558                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4559
4560                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4561                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4562
4563                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4564                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4565
4566                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4567                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
4568         }
4569 }