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