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