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;
9 use secp256k1::key::{PublicKey,SecretKey};
10 use secp256k1::{Secp256k1,Message,Signature};
13 use crypto::digest::Digest;
14 use crypto::hkdf::{hkdf_extract,hkdf_expand};
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};
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;
31 use std::default::Default;
33 use std::time::Instant;
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],
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
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();
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)?;
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)?;
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)?;
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)?;
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)?;
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)?;
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)?;
86 hkdf_expand(Sha256::new(), &prk, b"rust-lightning local commitment seed info", &mut okm);
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,
101 enum InboundHTLCRemovalReason {
102 FailRelay(msgs::OnionErrorPacket),
103 FailMalformed(([u8; 32], u16)),
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
121 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
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
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),
136 struct InboundHTLCOutput {
140 payment_hash: [u8; 32],
141 state: InboundHTLCState,
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>),
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).
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,
176 struct OutboundHTLCOutput {
180 payment_hash: [u8; 32],
181 state: OutboundHTLCState,
183 /// If we're in a removed state, set if they failed, otherwise None
184 fail_reason: Option<HTLCFailReason>,
187 macro_rules! get_htlc_in_commitment {
188 ($htlc: expr, $offered: expr) => {
189 HTLCOutputInCommitment {
191 amount_msat: $htlc.amount_msat,
192 cltv_expiry: $htlc.cltv_expiry,
193 payment_hash: $htlc.payment_hash,
194 transaction_output_index: 0
199 /// See AwaitingRemoteRevoke ChannelState for more info
200 enum HTLCUpdateAwaitingACK {
205 payment_hash: [u8; 32],
207 onion_routing_packet: msgs::OnionPacket,
208 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
211 payment_preimage: [u8; 32],
216 err_packet: msgs::OnionErrorPacket,
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.
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.
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.
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),
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
250 PeerDisconnected = (1 << 7),
251 /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
252 /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
253 /// messages until they've managed to do so.
254 MonitorUpdateFailed = (1 << 8),
255 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
256 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
257 /// messages as then we will be unable to determine which HTLCs they included in their
258 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
260 /// Flag is set on ChannelFunded.
261 AwaitingRemoteRevoke = (1 << 9),
262 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
263 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
264 /// to respond with our own shutdown message when possible.
265 RemoteShutdownSent = (1 << 10),
266 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
267 /// point, we may not add any new HTLCs to the channel.
268 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
269 /// us their shutdown.
270 LocalShutdownSent = (1 << 11),
271 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
272 /// to drop us, but we store this anyway.
273 ShutdownComplete = 4096,
275 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
276 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
278 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
280 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
281 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
282 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
284 pub(super) struct Channel {
287 channel_id: [u8; 32],
289 channel_outbound: bool,
290 secp_ctx: Secp256k1<secp256k1::All>,
291 announce_publicly: bool,
292 channel_value_satoshis: u64,
294 local_keys: ChannelKeys,
296 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
297 // generation start at 0 and count up...this simplifies some parts of implementation at the
298 // cost of others, but should really just be changed.
300 cur_local_commitment_transaction_number: u64,
301 cur_remote_commitment_transaction_number: u64,
302 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
303 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
304 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
305 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
306 /// remote revoke when we received the latest commitment update from the remote we have to make
307 /// sure that commitment update gets resent first.
308 received_commitment_while_awaiting_raa: bool,
309 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
310 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
311 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
313 monitor_pending_revoke_and_ack: bool,
314 monitor_pending_commitment_signed: bool,
315 monitor_pending_order: Option<RAACommitmentOrder>,
316 monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
317 monitor_pending_failures: Vec<(HTLCSource, [u8; 32], HTLCFailReason)>,
319 // pending_update_fee is filled when sending and receiving update_fee
320 // For outbound channel, feerate_per_kw is updated with the value from
321 // pending_update_fee when revoke_and_ack is received
323 // For inbound channel, feerate_per_kw is updated when it receives
324 // commitment_signed and revoke_and_ack is generated
325 // The pending value is kept when another pair of update_fee and commitment_signed
326 // is received during AwaitingRemoteRevoke and relieved when the expected
327 // revoke_and_ack is received and new commitment_signed is generated to be
328 // sent to the funder. Otherwise, the pending value is removed when receiving
329 // commitment_signed.
330 pending_update_fee: Option<u64>,
331 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
332 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
333 // is received. holding_cell_update_fee is updated when there are additional
334 // update_fee() during ChannelState::AwaitingRemoteRevoke.
335 holding_cell_update_fee: Option<u64>,
336 next_local_htlc_id: u64,
337 next_remote_htlc_id: u64,
338 channel_update_count: u32,
341 #[cfg(debug_assertions)]
342 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
343 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
344 #[cfg(debug_assertions)]
345 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
346 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
349 // Used in ChannelManager's tests to send a revoked transaction
350 pub last_local_commitment_txn: Vec<Transaction>,
352 last_local_commitment_txn: Vec<Transaction>,
354 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
356 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
357 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
358 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
359 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
360 funding_tx_confirmed_in: Option<Sha256dHash>,
361 short_channel_id: Option<u64>,
362 /// Used to deduplicate block_connected callbacks
363 last_block_connected: Sha256dHash,
364 funding_tx_confirmations: u64,
366 their_dust_limit_satoshis: u64,
367 our_dust_limit_satoshis: u64,
368 their_max_htlc_value_in_flight_msat: u64,
369 //get_our_max_htlc_value_in_flight_msat(): u64,
370 /// minimum channel reserve for **self** to maintain - set by them.
371 their_channel_reserve_satoshis: u64,
372 //get_our_channel_reserve_satoshis(): u64,
373 their_htlc_minimum_msat: u64,
374 our_htlc_minimum_msat: u64,
375 their_to_self_delay: u16,
376 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
377 their_max_accepted_htlcs: u16,
378 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
380 their_funding_pubkey: Option<PublicKey>,
381 their_revocation_basepoint: Option<PublicKey>,
382 their_payment_basepoint: Option<PublicKey>,
383 their_delayed_payment_basepoint: Option<PublicKey>,
384 their_htlc_basepoint: Option<PublicKey>,
385 their_cur_commitment_point: Option<PublicKey>,
387 their_prev_commitment_point: Option<PublicKey>,
388 their_node_id: PublicKey,
390 their_shutdown_scriptpubkey: Option<Script>,
392 channel_monitor: ChannelMonitor,
397 const OUR_MAX_HTLCS: u16 = 5; //TODO
398 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
399 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
400 /// really allow for this, so instead we're stuck closing it out at that point.
401 const UNCONF_THRESHOLD: u32 = 6;
402 /// The amount of time we require our counterparty wait to claim their money (ie time between when
403 /// we, or our watchtower, must check for them having broadcast a theft transaction).
404 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
405 /// The amount of time we're willing to wait to claim money back to us
406 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
407 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
408 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
409 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
410 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?)
411 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
413 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
415 /// Used to return a simple Error back to ChannelManager. Will get converted to a
416 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
417 /// channel_id in ChannelManager.
418 pub(super) enum ChannelError {
419 Ignore(&'static str),
423 macro_rules! secp_call {
424 ( $res: expr, $err: expr, $chan_id: expr ) => {
427 Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
432 macro_rules! secp_derived_key {
433 ( $res: expr, $chan_id: expr ) => {
434 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
438 // Convert constants + channel value to limits:
439 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
440 channel_value_satoshis * 1000 / 10 //TODO
443 /// Returns a minimum channel reserve value **they** need to maintain
445 /// Guaranteed to return a value no larger than channel_value_satoshis
446 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
447 let (q, _) = channel_value_satoshis.overflowing_div(100);
448 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
451 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
452 at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000 //TODO
455 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
459 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
460 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
462 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
466 fn derive_maximum_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
467 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
472 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> {
473 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
474 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
477 if push_msat > channel_value_satoshis * 1000 {
478 return Err(APIError::APIMisuseError{err: "push value > channel value"});
482 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
483 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
484 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
487 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
489 let secp_ctx = Secp256k1::new();
490 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
491 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();
492 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
493 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
494 &chan_keys.htlc_base_key,
495 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
500 channel_id: rng::rand_u832(),
501 channel_state: ChannelState::OurInitSent as u32,
502 channel_outbound: true,
504 announce_publicly: announce_publicly,
505 channel_value_satoshis: channel_value_satoshis,
507 local_keys: chan_keys,
508 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
509 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
510 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
511 received_commitment_while_awaiting_raa: false,
513 pending_inbound_htlcs: Vec::new(),
514 pending_outbound_htlcs: Vec::new(),
515 holding_cell_htlc_updates: Vec::new(),
516 pending_update_fee: None,
517 holding_cell_update_fee: None,
518 next_local_htlc_id: 0,
519 next_remote_htlc_id: 0,
520 channel_update_count: 1,
522 monitor_pending_revoke_and_ack: false,
523 monitor_pending_commitment_signed: false,
524 monitor_pending_order: None,
525 monitor_pending_forwards: Vec::new(),
526 monitor_pending_failures: Vec::new(),
528 #[cfg(debug_assertions)]
529 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
530 #[cfg(debug_assertions)]
531 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
533 last_local_commitment_txn: Vec::new(),
535 last_sent_closing_fee: None,
537 funding_tx_confirmed_in: None,
538 short_channel_id: None,
539 last_block_connected: Default::default(),
540 funding_tx_confirmations: 0,
542 feerate_per_kw: feerate,
543 their_dust_limit_satoshis: 0,
544 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
545 their_max_htlc_value_in_flight_msat: 0,
546 their_channel_reserve_satoshis: 0,
547 their_htlc_minimum_msat: 0,
548 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
549 their_to_self_delay: 0,
550 their_max_accepted_htlcs: 0,
552 their_funding_pubkey: None,
553 their_revocation_basepoint: None,
554 their_payment_basepoint: None,
555 their_delayed_payment_basepoint: None,
556 their_htlc_basepoint: None,
557 their_cur_commitment_point: None,
559 their_prev_commitment_point: None,
560 their_node_id: their_node_id,
562 their_shutdown_scriptpubkey: None,
564 channel_monitor: channel_monitor,
570 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
571 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
572 return Err(ChannelError::Close("Peer's feerate much too low"));
574 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
575 return Err(ChannelError::Close("Peer's feerate much too high"));
580 /// Creates a new channel from a remote sides' request for one.
581 /// Assumes chain_hash has already been checked and corresponds with what we expect!
582 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> {
583 // Check sanity of message fields:
584 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
585 return Err(ChannelError::Close("funding value > 2^24"));
587 if msg.channel_reserve_satoshis > msg.funding_satoshis {
588 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
590 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
591 return Err(ChannelError::Close("push_msat larger than funding value"));
593 if msg.dust_limit_satoshis > msg.funding_satoshis {
594 return Err(ChannelError::Close("Peer never wants payout outputs?"));
596 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
597 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
599 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
600 return Err(ChannelError::Close("Miminum htlc value is full channel value"));
602 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
604 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
605 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
607 if msg.max_accepted_htlcs < 1 {
608 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
610 if msg.max_accepted_htlcs > 483 {
611 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
614 // Convert things into internal flags and prep our state:
616 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
617 if require_announce && !their_announce {
618 return Err(ChannelError::Close("Peer tried to open unannounced channel, but we require public ones"));
620 if !allow_announce && their_announce {
621 return Err(ChannelError::Close("Peer tried to open announced channel, but we require private ones"));
624 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
626 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
627 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
628 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
629 return Err(ChannelError::Close("Suitalbe channel reserve not found. aborting"));
631 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
632 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
634 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
635 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
638 // check if the funder's amount for the initial commitment tx is sufficient
639 // for full fee payment
640 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
641 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
642 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
645 let to_local_msat = msg.push_msat;
646 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
647 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
648 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
651 let secp_ctx = Secp256k1::new();
652 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
653 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();
654 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
655 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
656 &chan_keys.htlc_base_key,
657 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
658 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
659 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
661 let mut chan = Channel {
664 channel_id: msg.temporary_channel_id,
665 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
666 channel_outbound: false,
668 announce_publicly: their_announce,
670 local_keys: chan_keys,
671 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
672 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
673 value_to_self_msat: msg.push_msat,
674 received_commitment_while_awaiting_raa: false,
676 pending_inbound_htlcs: Vec::new(),
677 pending_outbound_htlcs: Vec::new(),
678 holding_cell_htlc_updates: Vec::new(),
679 pending_update_fee: None,
680 holding_cell_update_fee: None,
681 next_local_htlc_id: 0,
682 next_remote_htlc_id: 0,
683 channel_update_count: 1,
685 monitor_pending_revoke_and_ack: false,
686 monitor_pending_commitment_signed: false,
687 monitor_pending_order: None,
688 monitor_pending_forwards: Vec::new(),
689 monitor_pending_failures: Vec::new(),
691 #[cfg(debug_assertions)]
692 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
693 #[cfg(debug_assertions)]
694 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
696 last_local_commitment_txn: Vec::new(),
698 last_sent_closing_fee: None,
700 funding_tx_confirmed_in: None,
701 short_channel_id: None,
702 last_block_connected: Default::default(),
703 funding_tx_confirmations: 0,
705 feerate_per_kw: msg.feerate_per_kw as u64,
706 channel_value_satoshis: msg.funding_satoshis,
707 their_dust_limit_satoshis: msg.dust_limit_satoshis,
708 our_dust_limit_satoshis: our_dust_limit_satoshis,
709 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
710 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
711 their_htlc_minimum_msat: msg.htlc_minimum_msat,
712 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
713 their_to_self_delay: msg.to_self_delay,
714 their_max_accepted_htlcs: msg.max_accepted_htlcs,
716 their_funding_pubkey: Some(msg.funding_pubkey),
717 their_revocation_basepoint: Some(msg.revocation_basepoint),
718 their_payment_basepoint: Some(msg.payment_basepoint),
719 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
720 their_htlc_basepoint: Some(msg.htlc_basepoint),
721 their_cur_commitment_point: Some(msg.first_per_commitment_point),
723 their_prev_commitment_point: None,
724 their_node_id: their_node_id,
726 their_shutdown_scriptpubkey: None,
728 channel_monitor: channel_monitor,
733 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
734 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
739 // Utilities to derive keys:
741 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
742 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
743 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
746 // Utilities to build transactions:
748 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
749 let mut sha = Sha256::new();
750 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
752 if self.channel_outbound {
753 sha.input(&our_payment_basepoint.serialize());
754 sha.input(&self.their_payment_basepoint.unwrap().serialize());
756 sha.input(&self.their_payment_basepoint.unwrap().serialize());
757 sha.input(&our_payment_basepoint.serialize());
759 let mut res = [0; 32];
760 sha.result(&mut res);
762 ((res[26] as u64) << 5*8) |
763 ((res[27] as u64) << 4*8) |
764 ((res[28] as u64) << 3*8) |
765 ((res[29] as u64) << 2*8) |
766 ((res[30] as u64) << 1*8) |
767 ((res[31] as u64) << 0*8)
770 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
771 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
772 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
773 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
774 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
776 /// @local is used only to convert relevant internal structures which refer to remote vs local
777 /// to decide value of outputs and direction of HTLCs.
778 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
779 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
780 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
781 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
782 /// which peer generated this transaction and "to whom" this transaction flows.
784 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>) {
785 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
788 let mut ins: Vec<TxIn> = Vec::new();
790 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
791 script_sig: Script::new(),
792 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
798 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
800 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
801 let mut remote_htlc_total_msat = 0;
802 let mut local_htlc_total_msat = 0;
803 let mut value_to_self_msat_offset = 0;
805 macro_rules! add_htlc_output {
806 ($htlc: expr, $outbound: expr) => {
807 if $outbound == local { // "offered HTLC output"
808 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
809 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
811 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
812 value: $htlc.amount_msat / 1000
813 }, Some(htlc_in_tx)));
816 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
817 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
818 txouts.push((TxOut { // "received HTLC output"
819 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
820 value: $htlc.amount_msat / 1000
821 }, Some(htlc_in_tx)));
827 for ref htlc in self.pending_inbound_htlcs.iter() {
828 let include = match htlc.state {
829 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
830 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
831 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
832 InboundHTLCState::Committed => true,
833 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
837 add_htlc_output!(htlc, false);
838 remote_htlc_total_msat += htlc.amount_msat;
841 &InboundHTLCState::LocalRemoved(ref reason) => {
842 if generated_by_local {
843 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
844 value_to_self_msat_offset += htlc.amount_msat as i64;
853 for ref htlc in self.pending_outbound_htlcs.iter() {
854 let include = match htlc.state {
855 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
856 OutboundHTLCState::Committed => true,
857 OutboundHTLCState::RemoteRemoved => generated_by_local,
858 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
859 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
863 add_htlc_output!(htlc, true);
864 local_htlc_total_msat += htlc.amount_msat;
867 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
868 if htlc.fail_reason.is_none() {
869 value_to_self_msat_offset -= htlc.amount_msat as i64;
872 OutboundHTLCState::RemoteRemoved => {
873 if !generated_by_local && htlc.fail_reason.is_none() {
874 value_to_self_msat_offset -= htlc.amount_msat as i64;
883 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
884 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;
886 #[cfg(debug_assertions)]
888 // Make sure that the to_self/to_remote is always either past the appropriate
889 // channel_reserve *or* it is making progress towards it.
890 // TODO: This should happen after fee calculation, but we don't handle that correctly
892 let mut max_commitment_tx_output = if generated_by_local {
893 self.max_commitment_tx_output_local.lock().unwrap()
895 self.max_commitment_tx_output_remote.lock().unwrap()
897 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);
898 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
899 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);
900 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
903 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
904 let (value_to_self, value_to_remote) = if self.channel_outbound {
905 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
907 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
910 let value_to_a = if local { value_to_self } else { value_to_remote };
911 let value_to_b = if local { value_to_remote } else { value_to_self };
913 if value_to_a >= (dust_limit_satoshis as i64) {
915 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
916 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
917 &keys.a_delayed_payment_key).to_v0_p2wsh(),
918 value: value_to_a as u64
922 if value_to_b >= (dust_limit_satoshis as i64) {
924 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
925 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
927 value: value_to_b as u64
931 transaction_utils::sort_outputs(&mut txouts);
933 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
934 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
935 for (idx, out) in txouts.drain(..).enumerate() {
937 if let Some(out_htlc) = out.1 {
938 htlcs_used.push(out_htlc);
939 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
945 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
952 fn get_closing_scriptpubkey(&self) -> Script {
953 let our_channel_close_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.channel_close_key).serialize());
954 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
958 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
959 (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)
963 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
965 let mut ins: Vec<TxIn> = Vec::new();
967 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
968 script_sig: Script::new(),
969 sequence: 0xffffffff,
975 assert!(self.pending_inbound_htlcs.is_empty());
976 assert!(self.pending_outbound_htlcs.is_empty());
977 let mut txouts: Vec<(TxOut, ())> = Vec::new();
979 let mut total_fee_satoshis = proposed_total_fee_satoshis;
980 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
981 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 };
983 if value_to_self < 0 {
984 assert!(self.channel_outbound);
985 total_fee_satoshis += (-value_to_self) as u64;
986 } else if value_to_remote < 0 {
987 assert!(!self.channel_outbound);
988 total_fee_satoshis += (-value_to_remote) as u64;
991 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
993 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
994 value: value_to_remote as u64
998 if value_to_self as u64 > self.our_dust_limit_satoshis {
1000 script_pubkey: self.get_closing_scriptpubkey(),
1001 value: value_to_self as u64
1005 transaction_utils::sort_outputs(&mut txouts);
1007 let mut outputs: Vec<TxOut> = Vec::new();
1008 for out in txouts.drain(..) {
1009 outputs.push(out.0);
1017 }, total_fee_satoshis)
1021 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1022 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1023 /// our counterparty!)
1024 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1025 /// TODO Some magic rust shit to compile-time check this?
1026 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
1027 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1028 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1029 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1031 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()))
1035 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1036 /// will sign and send to our counterparty.
1037 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
1038 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1039 //may see payments to it!
1040 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1041 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1042 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1044 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()))
1047 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1048 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1049 /// Panics if called before accept_channel/new_from_req
1050 pub fn get_funding_redeemscript(&self) -> Script {
1051 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1052 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1053 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1054 if our_funding_key[..] < their_funding_key[..] {
1055 builder.push_slice(&our_funding_key)
1056 .push_slice(&their_funding_key)
1058 builder.push_slice(&their_funding_key)
1059 .push_slice(&our_funding_key)
1060 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1063 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1064 if tx.input.len() != 1 {
1065 panic!("Tried to sign commitment transaction that had input count != 1!");
1067 if tx.input[0].witness.len() != 0 {
1068 panic!("Tried to re-sign commitment transaction");
1071 let funding_redeemscript = self.get_funding_redeemscript();
1073 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1074 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1076 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1078 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1079 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1080 if our_funding_key[..] < their_funding_key[..] {
1081 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1082 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1084 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1085 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1087 tx.input[0].witness[1].push(SigHashType::All as u8);
1088 tx.input[0].witness[2].push(SigHashType::All as u8);
1090 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1095 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1096 /// @local is used only to convert relevant internal structures which refer to remote vs local
1097 /// to decide value of outputs and direction of HTLCs.
1098 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1099 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)
1102 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
1103 if tx.input.len() != 1 {
1104 panic!("Tried to sign HTLC transaction that had input count != 1!");
1107 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1109 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());
1110 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1111 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1112 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1115 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1116 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1117 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1118 if tx.input.len() != 1 {
1119 panic!("Tried to sign HTLC transaction that had input count != 1!");
1121 if tx.input[0].witness.len() != 0 {
1122 panic!("Tried to re-sign HTLC transaction");
1125 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1127 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1129 if local_tx { // b, then a
1130 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1131 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1133 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1134 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1136 tx.input[0].witness[1].push(SigHashType::All as u8);
1137 tx.input[0].witness[2].push(SigHashType::All as u8);
1140 tx.input[0].witness.push(Vec::new());
1142 tx.input[0].witness.push(preimage.unwrap().to_vec());
1145 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1150 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1151 /// debug_assertions are turned on
1152 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1153 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1154 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1155 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1157 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1158 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1160 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1162 let mut sha = Sha256::new();
1163 sha.input(&payment_preimage_arg);
1164 let mut payment_hash_calc = [0; 32];
1165 sha.result(&mut payment_hash_calc);
1167 let mut pending_idx = std::usize::MAX;
1168 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1169 if htlc.htlc_id == htlc_id_arg {
1170 assert_eq!(htlc.payment_hash, payment_hash_calc);
1171 if let InboundHTLCState::Committed = htlc.state {
1173 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1174 // Don't return in release mode here so that we can update channel_monitor
1180 if pending_idx == std::usize::MAX {
1181 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1182 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1185 // Now update local state:
1187 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1188 // can claim it even if the channel hits the chain before we see their next commitment.
1189 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1191 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1192 for pending_update in self.holding_cell_htlc_updates.iter() {
1193 match pending_update {
1194 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1195 if htlc_id_arg == htlc_id {
1196 debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1197 return Ok((None, None));
1200 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1201 if htlc_id_arg == htlc_id {
1202 debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1203 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1209 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1210 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1212 return Ok((None, Some(self.channel_monitor.clone())));
1216 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1217 if let InboundHTLCState::Committed = htlc.state {
1219 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1220 return Ok((None, Some(self.channel_monitor.clone())));
1222 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1225 Ok((Some(msgs::UpdateFulfillHTLC {
1226 channel_id: self.channel_id(),
1227 htlc_id: htlc_id_arg,
1228 payment_preimage: payment_preimage_arg,
1229 }), Some(self.channel_monitor.clone())))
1232 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> {
1233 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1234 (Some(update_fulfill_htlc), _) => {
1235 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1236 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1238 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1239 (None, None) => Ok((None, None))
1243 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1244 /// debug_assertions are turned on
1245 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1246 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1247 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1249 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1251 let mut pending_idx = std::usize::MAX;
1252 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1253 if htlc.htlc_id == htlc_id_arg {
1254 if let InboundHTLCState::Committed = htlc.state {
1256 debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1257 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1262 if pending_idx == std::usize::MAX {
1263 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1264 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1267 // Now update local state:
1268 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1269 for pending_update in self.holding_cell_htlc_updates.iter() {
1270 match pending_update {
1271 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1272 if htlc_id_arg == htlc_id {
1273 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1274 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1277 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1278 if htlc_id_arg == htlc_id {
1279 debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1286 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1287 htlc_id: htlc_id_arg,
1294 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1295 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1298 Ok(Some(msgs::UpdateFailHTLC {
1299 channel_id: self.channel_id(),
1300 htlc_id: htlc_id_arg,
1305 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> {
1306 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1307 Some(update_fail_htlc) => {
1308 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1309 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1315 // Message handlers:
1317 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), ChannelError> {
1318 // Check sanity of message fields:
1319 if !self.channel_outbound {
1320 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1322 if self.channel_state != ChannelState::OurInitSent as u32 {
1323 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1325 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1326 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1328 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1329 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1331 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1332 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1334 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1335 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1337 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1338 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1340 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1341 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1343 if msg.minimum_depth > Channel::derive_maximum_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) {
1344 return Err(ChannelError::Close("minimum_depth too large"));
1346 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1347 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1349 if msg.max_accepted_htlcs < 1 {
1350 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1352 if msg.max_accepted_htlcs > 483 {
1353 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1356 // TODO: Optional additional constraints mentioned in the spec
1357 // MAY fail the channel if
1358 // funding_satoshi is too small
1359 // htlc_minimum_msat too large
1360 // max_htlc_value_in_flight_msat too small
1361 // channel_reserve_satoshis too large
1362 // max_accepted_htlcs too small
1363 // dust_limit_satoshis too small
1365 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1367 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1368 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1369 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1370 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1371 self.their_to_self_delay = msg.to_self_delay;
1372 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1373 self.their_funding_pubkey = Some(msg.funding_pubkey);
1374 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1375 self.their_payment_basepoint = Some(msg.payment_basepoint);
1376 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1377 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1378 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1380 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1381 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1382 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1384 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1389 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1390 let funding_script = self.get_funding_redeemscript();
1392 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1393 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1394 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();
1396 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1397 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1399 let remote_keys = self.build_remote_transaction_keys()?;
1400 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1401 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();
1403 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1404 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key)))
1407 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1408 if self.channel_outbound {
1409 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()}})});
1411 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1412 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1413 // remember the channel, so its safe to just send an error_message here and drop the
1415 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()}})});
1417 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1418 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1419 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1420 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1423 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1424 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1425 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1427 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1430 self.channel_monitor.unset_funding_info();
1435 // Now that we're past error-generating stuff, update our local state:
1437 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1438 self.channel_state = ChannelState::FundingSent as u32;
1439 self.channel_id = funding_txo.to_channel_id();
1440 self.cur_remote_commitment_transaction_number -= 1;
1441 self.cur_local_commitment_transaction_number -= 1;
1443 Ok((msgs::FundingSigned {
1444 channel_id: self.channel_id,
1445 signature: our_signature
1446 }, self.channel_monitor.clone()))
1449 /// Handles a funding_signed message from the remote end.
1450 /// If this call is successful, broadcast the funding transaction (and not before!)
1451 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1452 if !self.channel_outbound {
1453 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1455 if self.channel_state != ChannelState::FundingCreated as u32 {
1456 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1458 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1459 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1460 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1461 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1464 let funding_script = self.get_funding_redeemscript();
1466 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1467 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;
1468 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();
1470 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1471 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1473 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1474 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1475 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1476 self.channel_state = ChannelState::FundingSent as u32;
1477 self.cur_local_commitment_transaction_number -= 1;
1479 Ok(self.channel_monitor.clone())
1482 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1483 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1484 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1487 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1489 if non_shutdown_state == ChannelState::FundingSent as u32 {
1490 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1491 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1492 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1493 self.channel_update_count += 1;
1494 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1495 // Note that funding_signed/funding_created will have decremented both by 1!
1496 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1497 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1498 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1499 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1501 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1504 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1507 self.their_prev_commitment_point = self.their_cur_commitment_point;
1508 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1512 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1513 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1514 let mut htlc_inbound_value_msat = 0;
1515 for ref htlc in self.pending_inbound_htlcs.iter() {
1516 htlc_inbound_value_msat += htlc.amount_msat;
1518 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1521 /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1522 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1523 let mut htlc_outbound_value_msat = 0;
1524 for ref htlc in self.pending_outbound_htlcs.iter() {
1525 htlc_outbound_value_msat += htlc.amount_msat;
1528 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1531 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1532 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1533 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1535 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1536 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}})});
1538 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1539 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1541 if msg.amount_msat < self.our_htlc_minimum_msat {
1542 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1545 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1546 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1547 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1549 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1550 // Check our_max_htlc_value_in_flight_msat
1551 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1552 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1554 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1555 // the reserve_satoshis we told them to always have as direct payment so that they lose
1556 // something if we punish them for broadcasting an old state).
1557 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 {
1558 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1560 if self.next_remote_htlc_id != msg.htlc_id {
1561 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1563 if msg.cltv_expiry >= 500000000 {
1564 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1567 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1569 // Now update local state:
1570 self.next_remote_htlc_id += 1;
1571 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1572 htlc_id: msg.htlc_id,
1573 amount_msat: msg.amount_msat,
1574 payment_hash: msg.payment_hash,
1575 cltv_expiry: msg.cltv_expiry,
1576 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1582 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1584 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1585 for htlc in self.pending_outbound_htlcs.iter_mut() {
1586 if htlc.htlc_id == htlc_id {
1587 match check_preimage {
1589 Some(payment_hash) =>
1590 if payment_hash != htlc.payment_hash {
1591 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1595 OutboundHTLCState::LocalAnnounced(_) =>
1596 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1597 OutboundHTLCState::Committed => {
1598 htlc.state = OutboundHTLCState::RemoteRemoved;
1599 htlc.fail_reason = fail_reason;
1601 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1602 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1604 return Ok(&htlc.source);
1607 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1610 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, ChannelError> {
1611 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1612 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1614 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1615 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1618 let mut sha = Sha256::new();
1619 sha.input(&msg.payment_preimage);
1620 let mut payment_hash = [0; 32];
1621 sha.result(&mut payment_hash);
1623 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1626 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1627 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1628 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1630 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1631 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1634 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1637 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1638 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1639 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1641 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1642 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1645 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1648 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1649 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1650 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1652 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1653 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}})});
1656 let funding_script = self.get_funding_redeemscript();
1658 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1660 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1661 self.pending_update_fee.unwrap()
1666 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1667 let local_commitment_txid = local_commitment_tx.0.txid();
1668 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();
1669 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1671 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1672 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1675 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1676 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1677 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1679 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1680 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1681 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
1682 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1683 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1684 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());
1685 let htlc_sig = if htlc.offered {
1686 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1687 new_local_commitment_txn.push(htlc_tx);
1690 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1692 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1695 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1696 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1698 // Update state now that we've passed all the can-fail calls...
1699 let mut need_our_commitment = false;
1700 if !self.channel_outbound {
1701 if let Some(fee_update) = self.pending_update_fee {
1702 self.feerate_per_kw = fee_update;
1703 // We later use the presence of pending_update_fee to indicate we should generate a
1704 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1705 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1706 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1707 need_our_commitment = true;
1708 self.pending_update_fee = None;
1712 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1713 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1714 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1715 self.monitor_pending_order = None;
1718 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1720 for htlc in self.pending_inbound_htlcs.iter_mut() {
1721 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1722 Some(forward_info.clone())
1724 if let Some(forward_info) = new_forward {
1725 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1726 need_our_commitment = true;
1729 for htlc in self.pending_outbound_htlcs.iter_mut() {
1730 if let OutboundHTLCState::RemoteRemoved = htlc.state {
1731 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1732 need_our_commitment = true;
1736 self.cur_local_commitment_transaction_number -= 1;
1737 self.last_local_commitment_txn = new_local_commitment_txn;
1738 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1740 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1741 self.monitor_pending_revoke_and_ack = true;
1742 self.monitor_pending_commitment_signed |= need_our_commitment;
1743 return Err(HandleError{err: "Previous monitor update failure prevented generation of RAA", action: Some(ErrorAction::IgnoreError)});
1746 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1747 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1748 // we'll send one right away when we get the revoke_and_ack when we
1749 // free_holding_cell_htlcs().
1750 let (msg, monitor) = self.send_commitment_no_status_check()?;
1751 (Some(msg), monitor)
1752 } else { (None, self.channel_monitor.clone()) };
1754 Ok((msgs::RevokeAndACK {
1755 channel_id: self.channel_id,
1756 per_commitment_secret: per_commitment_secret,
1757 next_per_commitment_point: next_per_commitment_point,
1758 }, our_commitment_signed, monitor_update))
1761 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1762 /// fulfilling or failing the last pending HTLC)
1763 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1764 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1765 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1766 let mut htlc_updates = Vec::new();
1767 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1768 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1769 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1770 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1772 for htlc_update in htlc_updates.drain(..) {
1773 // Note that this *can* fail, though it should be due to rather-rare conditions on
1774 // fee races with adding too many outputs which push our total payments just over
1775 // the limit. In case its less rare than I anticipate, we may want to revisit
1776 // handling this case better and maybe fufilling some of the HTLCs while attempting
1777 // to rebalance channels.
1778 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1779 self.holding_cell_htlc_updates.push(htlc_update);
1781 match &htlc_update {
1782 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1783 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1784 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1790 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1791 match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1792 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1794 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1796 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1801 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1802 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1803 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1805 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1807 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1814 self.holding_cell_htlc_updates.push(htlc_update);
1818 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1819 //fail it back the route, if its a temporary issue we can ignore it...
1822 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1823 // This should never actually happen and indicates we got some Errs back
1824 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1825 // case there is some strange way to hit duplicate HTLC removes.
1828 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1829 self.pending_update_fee = self.holding_cell_update_fee.take();
1830 Some(msgs::UpdateFee {
1831 channel_id: self.channel_id,
1832 feerate_per_kw: feerate as u32,
1837 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1838 Ok(Some((msgs::CommitmentUpdate {
1840 update_fulfill_htlcs,
1842 update_fail_malformed_htlcs: Vec::new(),
1843 update_fee: update_fee,
1845 }, monitor_update)))
1854 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1855 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1856 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1857 /// generating an appropriate error *after* the channel state has been updated based on the
1858 /// revoke_and_ack message.
1859 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1860 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1861 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1863 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1864 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}})});
1867 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1868 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 {
1869 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1872 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)))?;
1874 // Update state now that we've passed all the can-fail calls...
1875 // (note that we may still fail to generate the new commitment_signed message, but that's
1876 // OK, we step the channel here and *then* if the new generation fails we can fail the
1877 // channel based on that, but stepping stuff here should be safe either way.
1878 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1879 self.their_prev_commitment_point = self.their_cur_commitment_point;
1880 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1881 self.cur_remote_commitment_transaction_number -= 1;
1882 self.received_commitment_while_awaiting_raa = false;
1883 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1884 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1885 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1886 self.monitor_pending_order = None;
1889 let mut to_forward_infos = Vec::new();
1890 let mut revoked_htlcs = Vec::new();
1891 let mut update_fail_htlcs = Vec::new();
1892 let mut update_fail_malformed_htlcs = Vec::new();
1893 let mut require_commitment = false;
1894 let mut value_to_self_msat_diff: i64 = 0;
1895 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1896 self.pending_inbound_htlcs.retain(|htlc| {
1897 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1898 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1899 value_to_self_msat_diff += htlc.amount_msat as i64;
1904 self.pending_outbound_htlcs.retain(|htlc| {
1905 if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1906 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1907 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1909 // They fulfilled, so we sent them money
1910 value_to_self_msat_diff -= htlc.amount_msat as i64;
1915 for htlc in self.pending_inbound_htlcs.iter_mut() {
1916 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1918 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1922 let mut state = InboundHTLCState::Committed;
1923 mem::swap(&mut state, &mut htlc.state);
1925 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1926 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1927 require_commitment = true;
1928 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1929 match forward_info {
1930 PendingHTLCStatus::Fail(fail_msg) => {
1931 require_commitment = true;
1933 HTLCFailureMsg::Relay(msg) => {
1934 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1935 update_fail_htlcs.push(msg)
1937 HTLCFailureMsg::Malformed(msg) => {
1938 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
1939 update_fail_malformed_htlcs.push(msg)
1943 PendingHTLCStatus::Forward(forward_info) => {
1944 to_forward_infos.push((forward_info, htlc.htlc_id));
1945 htlc.state = InboundHTLCState::Committed;
1951 for htlc in self.pending_outbound_htlcs.iter_mut() {
1952 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
1953 htlc.state = OutboundHTLCState::Committed;
1954 } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
1955 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1956 require_commitment = true;
1959 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1961 if self.channel_outbound {
1962 if let Some(feerate) = self.pending_update_fee.take() {
1963 self.feerate_per_kw = feerate;
1966 if let Some(feerate) = self.pending_update_fee {
1967 // Because a node cannot send two commitment_signed's in a row without getting a
1968 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
1969 // it should use to create keys with) and because a node can't send a
1970 // commitment_signed without changes, checking if the feerate is equal to the
1971 // pending feerate update is sufficient to detect require_commitment.
1972 if feerate == self.feerate_per_kw {
1973 require_commitment = true;
1974 self.pending_update_fee = None;
1979 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
1980 // We can't actually generate a new commitment transaction (incl by freeing holding
1981 // cells) while we can't update the monitor, so we just return what we have.
1982 if require_commitment {
1983 self.monitor_pending_commitment_signed = true;
1985 self.monitor_pending_forwards.append(&mut to_forward_infos);
1986 self.monitor_pending_failures.append(&mut revoked_htlcs);
1987 return Ok((None, Vec::new(), Vec::new(), self.channel_monitor.clone()));
1990 match self.free_holding_cell_htlcs()? {
1991 Some(mut commitment_update) => {
1992 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
1993 for fail_msg in update_fail_htlcs.drain(..) {
1994 commitment_update.0.update_fail_htlcs.push(fail_msg);
1996 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
1997 for fail_msg in update_fail_malformed_htlcs.drain(..) {
1998 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2000 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
2003 if require_commitment {
2004 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2005 Ok((Some(msgs::CommitmentUpdate {
2006 update_add_htlcs: Vec::new(),
2007 update_fulfill_htlcs: Vec::new(),
2009 update_fail_malformed_htlcs,
2012 }), to_forward_infos, revoked_htlcs, monitor_update))
2014 Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
2021 /// Adds a pending update to this channel. See the doc for send_htlc for
2022 /// further details on the optionness of the return value.
2023 /// You MUST call send_commitment prior to any other calls on this Channel
2024 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2025 if !self.channel_outbound {
2026 panic!("Cannot send fee from inbound channel");
2028 if !self.is_usable() {
2029 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2031 if !self.is_live() {
2032 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2035 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2036 self.holding_cell_update_fee = Some(feerate_per_kw);
2040 debug_assert!(self.pending_update_fee.is_none());
2041 self.pending_update_fee = Some(feerate_per_kw);
2043 Some(msgs::UpdateFee {
2044 channel_id: self.channel_id,
2045 feerate_per_kw: feerate_per_kw as u32,
2049 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
2050 match self.send_update_fee(feerate_per_kw) {
2051 Some(update_fee) => {
2052 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2053 Ok(Some((update_fee, commitment_signed, monitor_update)))
2059 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2060 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2061 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2062 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2063 /// No further message handling calls may be made until a channel_reestablish dance has
2065 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
2066 let mut outbound_drops = Vec::new();
2068 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2069 if self.channel_state < ChannelState::FundingSent as u32 {
2070 self.channel_state = ChannelState::ShutdownComplete as u32;
2071 return outbound_drops;
2074 let mut inbound_drop_count = 0;
2075 self.pending_inbound_htlcs.retain(|htlc| {
2077 InboundHTLCState::RemoteAnnounced(_) => {
2078 // They sent us an update_add_htlc but we never got the commitment_signed.
2079 // We'll tell them what commitment_signed we're expecting next and they'll drop
2080 // this HTLC accordingly
2081 inbound_drop_count += 1;
2084 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2085 // We received a commitment_signed updating this HTLC and (at least hopefully)
2086 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2087 // in response to it yet, so don't touch it.
2090 InboundHTLCState::Committed => true,
2091 InboundHTLCState::LocalRemoved(_) => {
2092 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2093 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2094 // (that we missed). Keep this around for now and if they tell us they missed
2095 // the commitment_signed we can re-transmit the update then.
2101 for htlc in self.pending_outbound_htlcs.iter_mut() {
2102 if let OutboundHTLCState::RemoteRemoved = htlc.state {
2103 // They sent us an update to remove this but haven't yet sent the corresponding
2104 // commitment_signed, we need to move it back to Committed and they can re-send
2105 // the update upon reconnection.
2106 htlc.state = OutboundHTLCState::Committed;
2110 self.holding_cell_htlc_updates.retain(|htlc_update| {
2112 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2113 outbound_drops.push((source.clone(), payment_hash.clone()));
2116 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2119 self.channel_state |= ChannelState::PeerDisconnected as u32;
2120 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()));
2124 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2125 /// updates are partially paused.
2126 /// This must be called immediately after the call which generated the ChannelMonitor update
2127 /// which failed, with the order argument set to the type of call it represented (ie a
2128 /// commitment update or a revoke_and_ack generation). The messages which were generated from
2129 /// that original call must *not* have been sent to the remote end, and must instead have been
2130 /// dropped. They will be regenerated when monitor_updating_restored is called.
2131 pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder) {
2132 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2134 RAACommitmentOrder::CommitmentFirst => {
2135 self.monitor_pending_revoke_and_ack = false;
2136 self.monitor_pending_commitment_signed = true;
2138 RAACommitmentOrder::RevokeAndACKFirst => {
2139 self.monitor_pending_revoke_and_ack = true;
2140 self.monitor_pending_commitment_signed = false;
2143 self.monitor_pending_order = Some(order);
2144 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2147 /// Indicates that the latest ChannelMonitor update has been committed by the client
2148 /// successfully and we should restore normal operation. Returns messages which should be sent
2149 /// to the remote side.
2150 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>) {
2151 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2152 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2154 let mut forwards = Vec::new();
2155 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2156 let mut failures = Vec::new();
2157 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2159 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2160 // Leave monitor_pending_order so we can order our channel_reestablish responses
2161 self.monitor_pending_revoke_and_ack = false;
2162 self.monitor_pending_commitment_signed = false;
2163 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2166 let raa = if self.monitor_pending_revoke_and_ack {
2167 Some(self.get_last_revoke_and_ack())
2169 let commitment_update = if self.monitor_pending_commitment_signed {
2170 Some(self.get_last_commitment_update())
2173 self.monitor_pending_revoke_and_ack = false;
2174 self.monitor_pending_commitment_signed = false;
2175 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2178 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2179 if self.channel_outbound {
2180 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2182 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2183 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2185 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2187 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2188 self.channel_update_count += 1;
2192 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2193 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2194 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2195 msgs::RevokeAndACK {
2196 channel_id: self.channel_id,
2197 per_commitment_secret,
2198 next_per_commitment_point,
2202 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2203 let mut update_add_htlcs = Vec::new();
2204 let mut update_fulfill_htlcs = Vec::new();
2205 let mut update_fail_htlcs = Vec::new();
2206 let mut update_fail_malformed_htlcs = Vec::new();
2208 for htlc in self.pending_outbound_htlcs.iter() {
2209 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2210 update_add_htlcs.push(msgs::UpdateAddHTLC {
2211 channel_id: self.channel_id(),
2212 htlc_id: htlc.htlc_id,
2213 amount_msat: htlc.amount_msat,
2214 payment_hash: htlc.payment_hash,
2215 cltv_expiry: htlc.cltv_expiry,
2216 onion_routing_packet: (**onion_packet).clone(),
2221 for htlc in self.pending_inbound_htlcs.iter() {
2222 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2224 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2225 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2226 channel_id: self.channel_id(),
2227 htlc_id: htlc.htlc_id,
2228 reason: err_packet.clone()
2231 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2232 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2233 channel_id: self.channel_id(),
2234 htlc_id: htlc.htlc_id,
2235 sha256_of_onion: sha256_of_onion.clone(),
2236 failure_code: failure_code.clone(),
2239 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2240 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2241 channel_id: self.channel_id(),
2242 htlc_id: htlc.htlc_id,
2243 payment_preimage: payment_preimage.clone(),
2250 msgs::CommitmentUpdate {
2251 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2252 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2253 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,
2257 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2258 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2259 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder), ChannelError> {
2260 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2261 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2262 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2263 // just close here instead of trying to recover.
2264 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2267 if msg.next_local_commitment_number == 0 || msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2268 msg.next_remote_commitment_number == 0 || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
2269 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2272 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2273 // remaining cases either succeed or ErrorMessage-fail).
2274 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2276 let required_revoke = if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2277 // Remote isn't waiting on any RevokeAndACK from us!
2278 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2280 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2281 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2282 self.monitor_pending_revoke_and_ack = true;
2285 Some(self.get_last_revoke_and_ack())
2288 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2291 // We increment cur_remote_commitment_transaction_number only upon receipt of
2292 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2293 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2294 // the corresponding revoke_and_ack back yet.
2295 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 };
2297 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2298 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2299 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2300 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2301 Some(msgs::FundingLocked {
2302 channel_id: self.channel_id(),
2303 next_per_commitment_point: next_per_commitment_point,
2307 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2308 RAACommitmentOrder::CommitmentFirst
2310 RAACommitmentOrder::RevokeAndACKFirst
2313 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2314 if required_revoke.is_some() {
2315 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2317 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2320 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2321 self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2322 // We're up-to-date and not waiting on a remote revoke (if we are our
2323 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2324 // have received some updates while we were disconnected. Free the holding cell
2326 match self.free_holding_cell_htlcs() {
2328 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
2329 return Err(ChannelError::Close(e.err));
2330 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
2331 return Err(ChannelError::Close(e.err));
2333 panic!("Got non-channel-failing result from free_holding_cell_htlcs");
2336 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order)),
2337 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order)),
2340 return Ok((resend_funding_locked, required_revoke, None, None, order));
2342 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2343 if required_revoke.is_some() {
2344 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2346 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2349 // If monitor_pending_order is set, it must be CommitmentSigned if we have no RAA
2350 debug_assert!(self.monitor_pending_order != Some(RAACommitmentOrder::RevokeAndACKFirst) || required_revoke.is_some());
2352 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2353 self.monitor_pending_commitment_signed = true;
2354 return Ok((resend_funding_locked, None, None, None, order));
2357 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order));
2359 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2363 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), HandleError> {
2364 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2365 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}})});
2367 if self.channel_state < ChannelState::FundingSent as u32 {
2368 self.channel_state = ChannelState::ShutdownComplete as u32;
2369 self.channel_update_count += 1;
2370 return Ok((None, None, Vec::new()));
2372 for htlc in self.pending_inbound_htlcs.iter() {
2373 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2374 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
2377 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
2378 return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
2380 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2382 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2383 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2384 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2385 return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
2388 //Check shutdown_scriptpubkey form as BOLT says we must
2389 if !(msg.scriptpubkey.is_p2pkh()) && !(msg.scriptpubkey.is_p2sh())
2390 && !(msg.scriptpubkey.is_v0_p2wpkh()) && !(msg.scriptpubkey.is_v0_p2wsh()){
2391 return Err(HandleError{err: "Got an invalid scriptpubkey from remote peer", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
2394 if self.their_shutdown_scriptpubkey.is_some() {
2395 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2396 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
2399 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2402 let our_closing_script = self.get_closing_scriptpubkey();
2404 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() {
2405 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2406 if self.feerate_per_kw > proposed_feerate {
2407 proposed_feerate = self.feerate_per_kw;
2409 let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
2410 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2412 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2413 let funding_redeemscript = self.get_funding_redeemscript();
2414 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2416 (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key)))
2417 } else { (None, None, None) };
2419 // From here on out, we may not fail!
2421 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2422 self.channel_update_count += 1;
2424 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2425 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2426 // cell HTLCs and return them to fail the payment.
2427 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2428 self.holding_cell_htlc_updates.retain(|htlc_update| {
2430 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2431 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2437 for htlc in self.pending_outbound_htlcs.iter() {
2438 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2439 return Ok((None, None, dropped_outbound_htlcs));
2443 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2446 Some(msgs::Shutdown {
2447 channel_id: self.channel_id,
2448 scriptpubkey: our_closing_script,
2452 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2453 self.channel_update_count += 1;
2454 if self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() && self.channel_outbound {
2455 // There are no more HTLCs and we're the funder, this means we start the closing_signed
2456 // dance with an initial fee proposal!
2457 self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
2458 Ok((our_shutdown, Some(msgs::ClosingSigned {
2459 channel_id: self.channel_id,
2460 fee_satoshis: proposed_fee.unwrap(),
2461 signature: our_sig.unwrap(),
2462 }), dropped_outbound_htlcs))
2464 Ok((our_shutdown, None, dropped_outbound_htlcs))
2468 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2469 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2470 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2472 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2473 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}})});
2475 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2476 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2478 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2479 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2482 let funding_redeemscript = self.get_funding_redeemscript();
2483 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2484 if used_total_fee != msg.fee_satoshis {
2485 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2487 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2489 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2492 // The remote end may have decided to revoke their output due to inconsistent dust
2493 // limits, so check for that case by re-checking the signature here.
2494 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2495 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2496 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2500 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2501 if last_fee == msg.fee_satoshis {
2502 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2503 self.channel_state = ChannelState::ShutdownComplete as u32;
2504 self.channel_update_count += 1;
2505 return Ok((None, Some(closing_tx)));
2509 macro_rules! propose_new_feerate {
2510 ($new_feerate: expr) => {
2511 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2512 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2513 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2514 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2515 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2516 return Ok((Some(msgs::ClosingSigned {
2517 channel_id: self.channel_id,
2518 fee_satoshis: used_total_fee,
2524 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2525 if self.channel_outbound {
2526 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2527 if proposed_sat_per_kw > our_max_feerate {
2528 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2529 if our_max_feerate <= last_feerate {
2530 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2533 propose_new_feerate!(our_max_feerate);
2536 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2537 if proposed_sat_per_kw < our_min_feerate {
2538 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2539 if our_min_feerate >= last_feerate {
2540 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2543 propose_new_feerate!(our_min_feerate);
2547 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2548 self.channel_state = ChannelState::ShutdownComplete as u32;
2549 self.channel_update_count += 1;
2551 Ok((Some(msgs::ClosingSigned {
2552 channel_id: self.channel_id,
2553 fee_satoshis: msg.fee_satoshis,
2555 }), Some(closing_tx)))
2558 // Public utilities:
2560 pub fn channel_id(&self) -> [u8; 32] {
2564 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2565 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2566 pub fn get_user_id(&self) -> u64 {
2570 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2571 pub fn channel_monitor(&self) -> ChannelMonitor {
2572 if self.channel_state < ChannelState::FundingCreated as u32 {
2573 panic!("Can't get a channel monitor until funding has been created");
2575 self.channel_monitor.clone()
2578 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2579 /// is_usable() returns true).
2580 /// Allowed in any state (including after shutdown)
2581 pub fn get_short_channel_id(&self) -> Option<u64> {
2582 self.short_channel_id
2585 /// Returns the funding_txo we either got from our peer, or were given by
2586 /// get_outbound_funding_created.
2587 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2588 self.channel_monitor.get_funding_txo()
2591 /// Allowed in any state (including after shutdown)
2592 pub fn get_their_node_id(&self) -> PublicKey {
2596 /// Allowed in any state (including after shutdown)
2597 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2598 self.our_htlc_minimum_msat
2601 /// Allowed in any state (including after shutdown)
2602 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2603 self.our_htlc_minimum_msat
2606 pub fn get_value_satoshis(&self) -> u64 {
2607 self.channel_value_satoshis
2611 pub fn get_feerate(&self) -> u64 {
2615 //TODO: Testing purpose only, should be changed in another way after #81
2617 pub fn get_local_keys(&self) -> &ChannelKeys {
2622 pub fn get_value_stat(&self) -> ChannelValueStat {
2624 value_to_self_msat: self.value_to_self_msat,
2625 channel_value_msat: self.channel_value_satoshis * 1000,
2626 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2627 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2628 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2629 holding_cell_outbound_amount_msat: {
2631 for h in self.holding_cell_htlc_updates.iter() {
2633 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2641 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2645 /// Allowed in any state (including after shutdown)
2646 pub fn get_channel_update_count(&self) -> u32 {
2647 self.channel_update_count
2650 pub fn should_announce(&self) -> bool {
2651 self.announce_publicly
2654 pub fn is_outbound(&self) -> bool {
2655 self.channel_outbound
2658 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2659 /// Allowed in any state (including after shutdown)
2660 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2661 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2662 // output value back into a transaction with the regular channel output:
2664 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2665 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2667 if self.channel_outbound {
2668 // + the marginal fee increase cost to us in the commitment transaction:
2669 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2672 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2673 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2678 /// Returns true if we've ever received a message from the remote end for this Channel
2679 pub fn have_received_message(&self) -> bool {
2680 self.channel_state > (ChannelState::OurInitSent as u32)
2683 /// Returns true if this channel is fully established and not known to be closing.
2684 /// Allowed in any state (including after shutdown)
2685 pub fn is_usable(&self) -> bool {
2686 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2687 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2690 /// Returns true if this channel is currently available for use. This is a superset of
2691 /// is_usable() and considers things like the channel being temporarily disabled.
2692 /// Allowed in any state (including after shutdown)
2693 pub fn is_live(&self) -> bool {
2694 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2697 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2698 /// Allowed in any state (including after shutdown)
2699 pub fn is_awaiting_monitor_update(&self) -> bool {
2700 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2703 /// Returns true if funding_created was sent/received.
2704 pub fn is_funding_initiated(&self) -> bool {
2705 self.channel_state >= ChannelState::FundingCreated as u32
2708 /// Returns true if this channel is fully shut down. True here implies that no further actions
2709 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2710 /// will be handled appropriately by the chain monitor.
2711 pub fn is_shutdown(&self) -> bool {
2712 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2713 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2718 /// Called by channelmanager based on chain blocks being connected.
2719 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2720 /// the channel_monitor.
2721 /// In case of Err, the channel may have been closed, at which point the standard requirements
2722 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2723 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2724 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2725 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2726 if self.funding_tx_confirmations > 0 {
2727 if header.bitcoin_hash() != self.last_block_connected {
2728 self.last_block_connected = header.bitcoin_hash();
2729 self.funding_tx_confirmations += 1;
2730 if self.funding_tx_confirmations == Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 {
2731 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2732 self.channel_state |= ChannelState::OurFundingLocked as u32;
2734 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2735 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2736 self.channel_update_count += 1;
2738 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2739 // We got a reorg but not enough to trigger a force close, just update
2740 // funding_tx_confirmed_in and return.
2742 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2743 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2745 // We got a reorg but not enough to trigger a force close, just update
2746 // funding_tx_confirmed_in and return.
2749 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2751 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2752 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2753 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2754 //a protocol oversight, but I assume I'm just missing something.
2755 if need_commitment_update {
2756 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2757 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2758 return Ok(Some(msgs::FundingLocked {
2759 channel_id: self.channel_id,
2760 next_per_commitment_point: next_per_commitment_point,
2766 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2767 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2768 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2769 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2770 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2771 tx.output[txo_idx].value != self.channel_value_satoshis {
2772 if self.channel_outbound {
2773 // If we generated the funding transaction and it doesn't match what it
2774 // should, the client is really broken and we should just panic and
2775 // tell them off. That said, because hash collisions happen with high
2776 // probability in fuzztarget mode, if we're fuzzing we just close the
2777 // channel and move on.
2778 #[cfg(not(feature = "fuzztarget"))]
2779 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2781 self.channel_state = ChannelState::ShutdownComplete as u32;
2782 self.channel_update_count += 1;
2783 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2785 self.funding_tx_confirmations = 1;
2786 self.short_channel_id = Some(((height as u64) << (5*8)) |
2787 ((*index_in_block as u64) << (2*8)) |
2788 ((txo_idx as u64) << (0*8)));
2796 /// Called by channelmanager based on chain blocks being disconnected.
2797 /// Returns true if we need to close the channel now due to funding transaction
2798 /// unconfirmation/reorg.
2799 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2800 if self.funding_tx_confirmations > 0 {
2801 self.funding_tx_confirmations -= 1;
2802 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2806 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2807 self.funding_tx_confirmations = Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 - 1;
2812 // Methods to get unprompted messages to send to the remote end (or where we already returned
2813 // something in the handler for the message that prompted this message):
2815 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2816 if !self.channel_outbound {
2817 panic!("Tried to open a channel for an inbound channel?");
2819 if self.channel_state != ChannelState::OurInitSent as u32 {
2820 panic!("Cannot generate an open_channel after we've moved forward");
2823 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2824 panic!("Tried to send an open_channel for a channel that has already advanced");
2827 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2830 chain_hash: chain_hash,
2831 temporary_channel_id: self.channel_id,
2832 funding_satoshis: self.channel_value_satoshis,
2833 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2834 dust_limit_satoshis: self.our_dust_limit_satoshis,
2835 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2836 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2837 htlc_minimum_msat: self.our_htlc_minimum_msat,
2838 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2839 to_self_delay: BREAKDOWN_TIMEOUT,
2840 max_accepted_htlcs: OUR_MAX_HTLCS,
2841 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2842 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2843 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2844 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2845 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2846 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2847 channel_flags: if self.announce_publicly {1} else {0},
2848 shutdown_scriptpubkey: None,
2852 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2853 if self.channel_outbound {
2854 panic!("Tried to send accept_channel for an outbound channel?");
2856 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2857 panic!("Tried to send accept_channel after channel had moved forward");
2859 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2860 panic!("Tried to send an accept_channel for a channel that has already advanced");
2863 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2865 msgs::AcceptChannel {
2866 temporary_channel_id: self.channel_id,
2867 dust_limit_satoshis: self.our_dust_limit_satoshis,
2868 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2869 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2870 htlc_minimum_msat: self.our_htlc_minimum_msat,
2871 minimum_depth: Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat),
2872 to_self_delay: BREAKDOWN_TIMEOUT,
2873 max_accepted_htlcs: OUR_MAX_HTLCS,
2874 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2875 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2876 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2877 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2878 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2879 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2880 shutdown_scriptpubkey: None,
2884 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2885 let funding_script = self.get_funding_redeemscript();
2887 let remote_keys = self.build_remote_transaction_keys()?;
2888 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
2889 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();
2891 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2892 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2895 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2896 /// a funding_created message for the remote peer.
2897 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2898 /// or if called on an inbound channel.
2899 /// Note that channel_id changes during this call!
2900 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2901 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2902 if !self.channel_outbound {
2903 panic!("Tried to create outbound funding_created message on an inbound channel!");
2905 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2906 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)");
2908 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2909 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2910 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2911 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2914 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2915 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2917 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2920 log_error!(self, "Got bad signatures: {}!", e.err);
2921 self.channel_monitor.unset_funding_info();
2926 let temporary_channel_id = self.channel_id;
2928 // Now that we're past error-generating stuff, update our local state:
2929 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2930 self.channel_state = ChannelState::FundingCreated as u32;
2931 self.channel_id = funding_txo.to_channel_id();
2932 self.cur_remote_commitment_transaction_number -= 1;
2934 Ok((msgs::FundingCreated {
2935 temporary_channel_id: temporary_channel_id,
2936 funding_txid: funding_txo.txid,
2937 funding_output_index: funding_txo.index,
2938 signature: our_signature
2939 }, self.channel_monitor.clone()))
2942 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2943 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2944 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
2945 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2946 /// Will only fail if we're not in a state where channel_announcement may be sent (including
2948 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
2949 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
2950 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
2951 if !self.announce_publicly {
2952 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
2954 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
2955 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
2957 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
2958 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
2961 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2962 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
2964 let msg = msgs::UnsignedChannelAnnouncement {
2965 features: msgs::GlobalFeatures::new(),
2966 chain_hash: chain_hash,
2967 short_channel_id: self.get_short_channel_id().unwrap(),
2968 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2969 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2970 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
2971 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
2972 excess_data: Vec::new(),
2975 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2976 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
2981 /// May panic if called on a channel that wasn't immediately-previously
2982 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
2983 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
2984 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
2985 msgs::ChannelReestablish {
2986 channel_id: self.channel_id(),
2987 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
2988 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number,
2989 data_loss_protect: None,
2994 // Send stuff to our remote peers:
2996 /// Adds a pending outbound HTLC to this channel, note that you probably want
2997 /// send_htlc_and_commit instead cause you'll want both messages at once.
2998 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2999 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3000 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3001 /// You MUST call send_commitment prior to any other calls on this Channel
3002 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> {
3003 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3004 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
3007 if amount_msat > self.channel_value_satoshis * 1000 {
3008 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
3010 if amount_msat < self.their_htlc_minimum_msat {
3011 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
3014 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3015 // Note that this should never really happen, if we're !is_live() on receipt of an
3016 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3017 // the user to send directly into a !is_live() channel. However, if we
3018 // disconnected during the time the previous hop was doing the commitment dance we may
3019 // end up getting here after the forwarding delay. In any case, returning an
3020 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3021 return Err(HandleError{err: "Cannot send an HTLC while disconnected/frozen for channel monitor update", action: Some(ErrorAction::IgnoreError)});
3024 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3025 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3026 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
3028 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3029 // Check their_max_htlc_value_in_flight_msat
3030 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3031 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
3034 let mut holding_cell_outbound_amount_msat = 0;
3035 for holding_htlc in self.holding_cell_htlc_updates.iter() {
3036 match holding_htlc {
3037 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
3038 holding_cell_outbound_amount_msat += *amount_msat;
3044 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3045 // reserve for them to have something to claim if we misbehave)
3046 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
3047 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
3050 //TODO: Check cltv_expiry? Do this in channel manager?
3052 // Now update local state:
3053 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3054 //TODO: Check the limits *including* other pending holding cell HTLCs!
3055 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3056 amount_msat: amount_msat,
3057 payment_hash: payment_hash,
3058 cltv_expiry: cltv_expiry,
3060 onion_routing_packet: onion_routing_packet,
3061 time_created: Instant::now(),
3066 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3067 htlc_id: self.next_local_htlc_id,
3068 amount_msat: amount_msat,
3069 payment_hash: payment_hash.clone(),
3070 cltv_expiry: cltv_expiry,
3071 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3076 let res = msgs::UpdateAddHTLC {
3077 channel_id: self.channel_id,
3078 htlc_id: self.next_local_htlc_id,
3079 amount_msat: amount_msat,
3080 payment_hash: payment_hash,
3081 cltv_expiry: cltv_expiry,
3082 onion_routing_packet: onion_routing_packet,
3084 self.next_local_htlc_id += 1;
3089 /// Creates a signed commitment transaction to send to the remote peer.
3090 /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
3091 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3092 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3093 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3094 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3095 panic!("Cannot create commitment tx until channel is fully established");
3097 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3098 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3100 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3101 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3103 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::PeerDisconnected as u32) {
3104 panic!("Cannot create commitment tx while awaiting monitor update unfreeze, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3106 let mut have_updates = self.pending_update_fee.is_some();
3107 for htlc in self.pending_outbound_htlcs.iter() {
3108 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3109 have_updates = true;
3111 if have_updates { break; }
3114 panic!("Cannot create commitment tx until we have some updates to send");
3116 self.send_commitment_no_status_check()
3118 /// Only fails in case of bad keys
3119 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
3120 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3121 // fail to generate this, we still are at least at a position where upgrading their status
3123 for htlc in self.pending_inbound_htlcs.iter_mut() {
3124 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3125 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3127 if let Some(state) = new_state {
3131 for htlc in self.pending_outbound_htlcs.iter_mut() {
3132 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
3133 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
3137 match self.send_commitment_no_state_update() {
3138 Ok((res, remote_commitment_tx)) => {
3139 // Update state now that we've passed all the can-fail calls...
3140 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
3141 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3142 Ok((res, self.channel_monitor.clone()))
3148 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3149 /// when we shouldn't change HTLC/channel state.
3150 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
3151 let funding_script = self.get_funding_redeemscript();
3153 let mut feerate_per_kw = self.feerate_per_kw;
3154 if let Some(feerate) = self.pending_update_fee {
3155 if self.channel_outbound {
3156 feerate_per_kw = feerate;
3160 let remote_keys = self.build_remote_transaction_keys()?;
3161 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3162 let remote_commitment_txid = remote_commitment_tx.0.txid();
3163 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();
3164 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3166 let mut htlc_sigs = Vec::new();
3168 for ref htlc in remote_commitment_tx.1.iter() {
3169 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3170 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3171 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3172 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());
3173 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3176 Ok((msgs::CommitmentSigned {
3177 channel_id: self.channel_id,
3179 htlc_signatures: htlc_sigs,
3180 }, remote_commitment_tx))
3183 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3184 /// to send to the remote peer in one go.
3185 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3187 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> {
3188 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3189 Some(update_add_htlc) => {
3190 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3191 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3197 /// Begins the shutdown process, getting a message for the remote peer and returning all
3198 /// holding cell HTLCs for payment failure.
3199 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
3200 for htlc in self.pending_outbound_htlcs.iter() {
3201 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3202 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3205 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3206 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3207 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3209 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3210 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3213 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3214 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3215 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3218 let our_closing_script = self.get_closing_scriptpubkey();
3220 // From here on out, we may not fail!
3221 if self.channel_state < ChannelState::FundingSent as u32 {
3222 self.channel_state = ChannelState::ShutdownComplete as u32;
3224 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3226 self.channel_update_count += 1;
3228 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3229 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3230 // cell HTLCs and return them to fail the payment.
3231 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3232 self.holding_cell_htlc_updates.retain(|htlc_update| {
3234 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3235 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3242 Ok((msgs::Shutdown {
3243 channel_id: self.channel_id,
3244 scriptpubkey: our_closing_script,
3245 }, dropped_outbound_htlcs))
3248 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3249 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3250 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3251 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3252 /// immediately (others we will have to allow to time out).
3253 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
3254 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3256 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3257 // return them to fail the payment.
3258 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3259 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3261 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3262 dropped_outbound_htlcs.push((source, payment_hash));
3268 for _htlc in self.pending_outbound_htlcs.drain(..) {
3269 //TODO: Do something with the remaining HTLCs
3270 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3274 self.channel_state = ChannelState::ShutdownComplete as u32;
3275 self.channel_update_count += 1;
3276 let mut res = Vec::new();
3277 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3278 (res, dropped_outbound_htlcs)
3284 use bitcoin::util::hash::Sha256dHash;
3285 use bitcoin::util::bip143;
3286 use bitcoin::network::serialize::serialize;
3287 use bitcoin::blockdata::script::Script;
3288 use bitcoin::blockdata::transaction::Transaction;
3290 use ln::channelmanager::HTLCSource;
3291 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3292 use ln::channel::MAX_FUNDING_SATOSHIS;
3294 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3295 use chain::transaction::OutPoint;
3296 use util::test_utils;
3297 use util::logger::Logger;
3298 use secp256k1::{Secp256k1,Message,Signature};
3299 use secp256k1::key::{SecretKey,PublicKey};
3300 use crypto::sha2::Sha256;
3301 use crypto::digest::Digest;
3304 struct TestFeeEstimator {
3307 impl FeeEstimator for TestFeeEstimator {
3308 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3314 fn test_max_funding_satoshis() {
3315 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3316 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3320 fn outbound_commitment_test() {
3321 // Test vectors from BOLT 3 Appendix C:
3322 let feeest = TestFeeEstimator{fee_est: 15000};
3323 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3324 let secp_ctx = Secp256k1::new();
3326 let chan_keys = ChannelKeys {
3327 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3328 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3329 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3330 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3332 // These aren't set in the test vectors:
3333 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3334 channel_close_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3335 channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3336 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],
3338 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3339 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3341 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
3342 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
3343 chan.their_to_self_delay = 144;
3344 chan.our_dust_limit_satoshis = 546;
3346 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
3347 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
3349 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3350 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
3351 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3353 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
3354 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
3355 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
3357 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3358 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
3359 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3361 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
3363 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
3364 // derived from a commitment_seed, so instead we copy it here and call
3365 // build_commitment_transaction.
3366 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
3367 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3368 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3369 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
3370 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();
3372 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
3374 macro_rules! test_commitment {
3375 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
3376 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
3377 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3378 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();
3379 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
3381 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
3383 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
3384 hex::decode($tx_hex).unwrap()[..]);
3388 macro_rules! test_htlc_output {
3389 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
3390 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3392 let ref htlc = unsigned_tx.1[$htlc_idx];
3393 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
3394 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
3395 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3396 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
3398 let mut preimage: Option<[u8; 32]> = None;
3401 let mut sha = Sha256::new();
3402 sha.input(&[i; 32]);
3404 let mut out = [0; 32];
3405 sha.result(&mut out);
3407 if out == htlc.payment_hash {
3408 preimage = Some([i; 32]);
3412 assert!(preimage.is_some());
3415 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
3416 assert_eq!(serialize(&htlc_tx).unwrap()[..],
3417 hex::decode($tx_hex).unwrap()[..]);
3422 // simple commitment tx with no HTLCs
3423 chan.value_to_self_msat = 7000000000;
3425 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
3426 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
3427 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3430 chan.pending_inbound_htlcs.push({
3431 let mut out = InboundHTLCOutput{
3433 amount_msat: 1000000,
3435 payment_hash: [0; 32],
3436 state: InboundHTLCState::Committed,
3438 let mut sha = Sha256::new();
3439 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3440 sha.result(&mut out.payment_hash);
3443 chan.pending_inbound_htlcs.push({
3444 let mut out = InboundHTLCOutput{
3446 amount_msat: 2000000,
3448 payment_hash: [0; 32],
3449 state: InboundHTLCState::Committed,
3451 let mut sha = Sha256::new();
3452 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3453 sha.result(&mut out.payment_hash);
3456 chan.pending_outbound_htlcs.push({
3457 let mut out = OutboundHTLCOutput{
3459 amount_msat: 2000000,
3461 payment_hash: [0; 32],
3462 state: OutboundHTLCState::Committed,
3463 source: HTLCSource::dummy(),
3466 let mut sha = Sha256::new();
3467 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3468 sha.result(&mut out.payment_hash);
3471 chan.pending_outbound_htlcs.push({
3472 let mut out = OutboundHTLCOutput{
3474 amount_msat: 3000000,
3476 payment_hash: [0; 32],
3477 state: OutboundHTLCState::Committed,
3478 source: HTLCSource::dummy(),
3481 let mut sha = Sha256::new();
3482 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
3483 sha.result(&mut out.payment_hash);
3486 chan.pending_inbound_htlcs.push({
3487 let mut out = InboundHTLCOutput{
3489 amount_msat: 4000000,
3491 payment_hash: [0; 32],
3492 state: InboundHTLCState::Committed,
3494 let mut sha = Sha256::new();
3495 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
3496 sha.result(&mut out.payment_hash);
3501 // commitment tx with all five HTLCs untrimmed (minimum feerate)
3502 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3503 chan.feerate_per_kw = 0;
3505 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
3506 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
3507 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3509 assert_eq!(unsigned_tx.1.len(), 5);
3511 test_htlc_output!(0,
3512 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
3513 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
3514 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3516 test_htlc_output!(1,
3517 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
3518 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
3519 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3521 test_htlc_output!(2,
3522 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
3523 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
3524 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3526 test_htlc_output!(3,
3527 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
3528 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
3529 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3531 test_htlc_output!(4,
3532 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
3533 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
3534 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3538 // commitment tx with seven outputs untrimmed (maximum feerate)
3539 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3540 chan.feerate_per_kw = 647;
3542 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
3543 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
3544 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3546 assert_eq!(unsigned_tx.1.len(), 5);
3548 test_htlc_output!(0,
3549 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
3550 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
3551 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3553 test_htlc_output!(1,
3554 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
3555 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
3556 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3558 test_htlc_output!(2,
3559 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
3560 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
3561 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3563 test_htlc_output!(3,
3564 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
3565 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
3566 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3568 test_htlc_output!(4,
3569 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
3570 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
3571 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3575 // commitment tx with six outputs untrimmed (minimum feerate)
3576 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3577 chan.feerate_per_kw = 648;
3579 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
3580 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
3581 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3583 assert_eq!(unsigned_tx.1.len(), 4);
3585 test_htlc_output!(0,
3586 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
3587 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
3588 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3590 test_htlc_output!(1,
3591 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
3592 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
3593 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3595 test_htlc_output!(2,
3596 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
3597 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
3598 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3600 test_htlc_output!(3,
3601 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
3602 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
3603 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3607 // commitment tx with six outputs untrimmed (maximum feerate)
3608 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3609 chan.feerate_per_kw = 2069;
3611 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
3612 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
3613 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3615 assert_eq!(unsigned_tx.1.len(), 4);
3617 test_htlc_output!(0,
3618 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
3619 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
3620 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3622 test_htlc_output!(1,
3623 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
3624 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
3625 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3627 test_htlc_output!(2,
3628 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
3629 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
3630 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3632 test_htlc_output!(3,
3633 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
3634 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
3635 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3639 // commitment tx with five outputs untrimmed (minimum feerate)
3640 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3641 chan.feerate_per_kw = 2070;
3643 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
3644 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
3645 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3647 assert_eq!(unsigned_tx.1.len(), 3);
3649 test_htlc_output!(0,
3650 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
3651 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
3652 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3654 test_htlc_output!(1,
3655 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
3656 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
3657 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3659 test_htlc_output!(2,
3660 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
3661 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
3662 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3666 // commitment tx with five outputs untrimmed (maximum feerate)
3667 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3668 chan.feerate_per_kw = 2194;
3670 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
3671 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
3672 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3674 assert_eq!(unsigned_tx.1.len(), 3);
3676 test_htlc_output!(0,
3677 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
3678 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
3679 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3681 test_htlc_output!(1,
3682 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
3683 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
3684 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3686 test_htlc_output!(2,
3687 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
3688 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
3689 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3693 // commitment tx with four outputs untrimmed (minimum feerate)
3694 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3695 chan.feerate_per_kw = 2195;
3697 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
3698 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
3699 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3701 assert_eq!(unsigned_tx.1.len(), 2);
3703 test_htlc_output!(0,
3704 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
3705 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
3706 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3708 test_htlc_output!(1,
3709 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
3710 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
3711 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3715 // commitment tx with four outputs untrimmed (maximum feerate)
3716 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3717 chan.feerate_per_kw = 3702;
3719 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
3720 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
3721 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3723 assert_eq!(unsigned_tx.1.len(), 2);
3725 test_htlc_output!(0,
3726 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
3727 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
3728 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3730 test_htlc_output!(1,
3731 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
3732 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
3733 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3737 // commitment tx with three outputs untrimmed (minimum feerate)
3738 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3739 chan.feerate_per_kw = 3703;
3741 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
3742 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
3743 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3745 assert_eq!(unsigned_tx.1.len(), 1);
3747 test_htlc_output!(0,
3748 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
3749 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
3750 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3754 // commitment tx with three outputs untrimmed (maximum feerate)
3755 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3756 chan.feerate_per_kw = 4914;
3758 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
3759 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
3760 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3762 assert_eq!(unsigned_tx.1.len(), 1);
3764 test_htlc_output!(0,
3765 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
3766 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
3767 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3771 // commitment tx with two outputs untrimmed (minimum feerate)
3772 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3773 chan.feerate_per_kw = 4915;
3775 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
3776 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
3777 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3779 assert_eq!(unsigned_tx.1.len(), 0);
3783 // commitment tx with two outputs untrimmed (maximum feerate)
3784 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3785 chan.feerate_per_kw = 9651180;
3787 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
3788 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
3789 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3791 assert_eq!(unsigned_tx.1.len(), 0);
3795 // commitment tx with one output untrimmed (minimum feerate)
3796 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3797 chan.feerate_per_kw = 9651181;
3799 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3800 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3801 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3803 assert_eq!(unsigned_tx.1.len(), 0);
3807 // commitment tx with fee greater than funder amount
3808 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3809 chan.feerate_per_kw = 9651936;
3811 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3812 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3813 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3815 assert_eq!(unsigned_tx.1.len(), 0);
3820 fn test_per_commitment_secret_gen() {
3821 // Test vectors from BOLT 3 Appendix D:
3823 let mut seed = [0; 32];
3824 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3825 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3826 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
3828 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
3829 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3830 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
3832 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
3833 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
3835 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
3836 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
3838 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3839 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
3840 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
3844 fn test_key_derivation() {
3845 // Test vectors from BOLT 3 Appendix E:
3846 let secp_ctx = Secp256k1::new();
3848 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
3849 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3851 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
3852 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
3854 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3855 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
3857 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3858 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
3860 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
3861 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
3863 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3864 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
3866 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
3867 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());