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