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