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