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