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};
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 fn new_from_seed(seed: &[u8; 32]) -> Result<ChannelKeys, secp256k1::Error> {
49 let mut prk = [0; 32];
50 hkdf_extract(Sha256::new(), b"rust-lightning key gen salt", seed, &mut prk);
51 let secp_ctx = Secp256k1::without_caps();
53 let mut okm = [0; 32];
54 hkdf_expand(Sha256::new(), &prk, b"rust-lightning funding key info", &mut okm);
55 let funding_key = SecretKey::from_slice(&secp_ctx, &okm)?;
57 hkdf_expand(Sha256::new(), &prk, b"rust-lightning revocation base key info", &mut okm);
58 let revocation_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
60 hkdf_expand(Sha256::new(), &prk, b"rust-lightning payment base key info", &mut okm);
61 let payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
63 hkdf_expand(Sha256::new(), &prk, b"rust-lightning delayed payment base key info", &mut okm);
64 let delayed_payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
66 hkdf_expand(Sha256::new(), &prk, b"rust-lightning htlc base key info", &mut okm);
67 let htlc_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
69 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel close key info", &mut okm);
70 let channel_close_key = SecretKey::from_slice(&secp_ctx, &okm)?;
72 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel monitor claim key info", &mut okm);
73 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &okm)?;
75 hkdf_expand(Sha256::new(), &prk, b"rust-lightning local commitment seed info", &mut okm);
78 funding_key: funding_key,
79 revocation_base_key: revocation_base_key,
80 payment_base_key: payment_base_key,
81 delayed_payment_base_key: delayed_payment_base_key,
82 htlc_base_key: htlc_base_key,
83 channel_close_key: channel_close_key,
84 channel_monitor_claim_key: channel_monitor_claim_key,
91 enum InboundHTLCState {
92 /// Added by remote, to be included in next local commitment tx.
94 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
95 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
96 /// accept this HTLC. Implies AwaitingRemoteRevoke.
97 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
98 /// a remote revoke_and_ack on a previous state before we can do so.
99 AwaitingRemoteRevokeToAnnounce,
100 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
101 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
102 /// accept this HTLC. Implies AwaitingRemoteRevoke.
103 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
105 AwaitingAnnouncedRemoteRevoke,
107 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
108 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
110 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
111 /// commitment transaction without it as otherwise we'll have to force-close the channel to
112 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
113 /// anyway). That said, ChannelMonitor does this for us (see
114 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
115 /// local state before then, once we're sure that the next commitment_signed and
116 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
120 struct InboundHTLCOutput {
124 payment_hash: [u8; 32],
125 state: InboundHTLCState,
126 /// If we're in LocalRemoved, set to true if we fulfilled the HTLC, and can claim money
127 local_removed_fulfilled: bool,
128 /// state pre-Committed implies pending_forward_state, otherwise it must be None
129 pending_forward_state: Option<PendingHTLCStatus>,
133 enum OutboundHTLCState {
134 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
135 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
136 /// we will promote to Committed (note that they may not accept it until the next time we
137 /// revoke, but we dont really care about that:
138 /// * they've revoked, so worst case we can announce an old state and get our (option on)
139 /// money back (though we wont), and,
140 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
141 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
142 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
143 /// we'll never get out of sync).
146 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
147 /// the change (though they'll need to revoke before we fail the payment).
149 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
150 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
151 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
152 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
153 /// remote revoke_and_ack on a previous state before we can do so.
154 AwaitingRemoteRevokeToRemove,
155 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
156 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
157 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
158 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
159 /// revoke_and_ack to drop completely.
160 AwaitingRemovedRemoteRevoke,
163 struct OutboundHTLCOutput {
167 payment_hash: [u8; 32],
168 state: OutboundHTLCState,
170 /// If we're in a removed state, set if they failed, otherwise None
171 fail_reason: Option<HTLCFailReason>,
174 macro_rules! get_htlc_in_commitment {
175 ($htlc: expr, $offered: expr) => {
176 HTLCOutputInCommitment {
178 amount_msat: $htlc.amount_msat,
179 cltv_expiry: $htlc.cltv_expiry,
180 payment_hash: $htlc.payment_hash,
181 transaction_output_index: 0
186 /// See AwaitingRemoteRevoke ChannelState for more info
187 enum HTLCUpdateAwaitingACK {
192 payment_hash: [u8; 32],
194 onion_routing_packet: msgs::OnionPacket,
195 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
198 payment_preimage: [u8; 32],
203 err_packet: msgs::OnionErrorPacket,
207 /// There are a few "states" and then a number of flags which can be applied:
208 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
209 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
210 /// move on to ChannelFunded.
211 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
212 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
213 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
215 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
216 OurInitSent = (1 << 0),
217 /// Implies we have received their open_channel/accept_channel message
218 TheirInitSent = (1 << 1),
219 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
220 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
221 /// upon receipt of funding_created, so simply skip this state.
223 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
224 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
225 /// and our counterparty consider the funding transaction confirmed.
227 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
228 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
229 TheirFundingLocked = (1 << 4),
230 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
231 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
232 OurFundingLocked = (1 << 5),
234 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
235 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
237 PeerDisconnected = (1 << 7),
238 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
239 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
240 /// messages as then we will be unable to determine which HTLCs they included in their
241 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
243 /// Flag is set on ChannelFunded.
244 AwaitingRemoteRevoke = (1 << 8),
245 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
246 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
247 /// to respond with our own shutdown message when possible.
248 RemoteShutdownSent = (1 << 9),
249 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
250 /// point, we may not add any new HTLCs to the channel.
251 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
252 /// us their shutdown.
253 LocalShutdownSent = (1 << 10),
254 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
255 /// to drop us, but we store this anyway.
256 ShutdownComplete = 2048,
258 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
260 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
262 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
263 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
264 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
266 pub(super) struct Channel {
269 channel_id: [u8; 32],
271 channel_outbound: bool,
272 secp_ctx: Secp256k1<secp256k1::All>,
273 announce_publicly: bool,
274 channel_value_satoshis: u64,
276 local_keys: ChannelKeys,
278 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
279 // generation start at 0 and count up...this simplifies some parts of implementation at the
280 // cost of others, but should really just be changed.
282 cur_local_commitment_transaction_number: u64,
283 cur_remote_commitment_transaction_number: u64,
284 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
285 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
286 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
287 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
288 next_local_htlc_id: u64,
289 next_remote_htlc_id: u64,
290 channel_update_count: u32,
294 // Used in ChannelManager's tests to send a revoked transaction
295 pub last_local_commitment_txn: Vec<Transaction>,
297 last_local_commitment_txn: Vec<Transaction>,
299 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
301 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
302 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
303 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
304 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
305 funding_tx_confirmed_in: Option<Sha256dHash>,
306 short_channel_id: Option<u64>,
307 /// Used to deduplicate block_connected callbacks
308 last_block_connected: Sha256dHash,
309 funding_tx_confirmations: u64,
311 their_dust_limit_satoshis: u64,
312 our_dust_limit_satoshis: u64,
313 their_max_htlc_value_in_flight_msat: u64,
314 //get_our_max_htlc_value_in_flight_msat(): u64,
315 their_channel_reserve_satoshis: u64,
316 //get_our_channel_reserve_satoshis(): u64,
317 their_htlc_minimum_msat: u64,
318 our_htlc_minimum_msat: u64,
319 their_to_self_delay: u16,
320 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
321 their_max_accepted_htlcs: u16,
322 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
324 their_funding_pubkey: Option<PublicKey>,
325 their_revocation_basepoint: Option<PublicKey>,
326 their_payment_basepoint: Option<PublicKey>,
327 their_delayed_payment_basepoint: Option<PublicKey>,
328 their_htlc_basepoint: Option<PublicKey>,
329 their_cur_commitment_point: Option<PublicKey>,
331 their_prev_commitment_point: Option<PublicKey>,
332 their_node_id: PublicKey,
334 their_shutdown_scriptpubkey: Option<Script>,
336 channel_monitor: ChannelMonitor,
341 const OUR_MAX_HTLCS: u16 = 5; //TODO
342 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
343 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
344 /// really allow for this, so instead we're stuck closing it out at that point.
345 const UNCONF_THRESHOLD: u32 = 6;
346 /// The amount of time we require our counterparty wait to claim their money (ie time between when
347 /// we, or our watchtower, must check for them having broadcast a theft transaction).
348 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
349 /// The amount of time we're willing to wait to claim money back to us
350 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
351 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
352 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
353 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
354 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?)
355 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
357 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
359 macro_rules! secp_call {
360 ( $res: expr, $err: expr, $chan_id: expr ) => {
363 Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
368 macro_rules! secp_derived_key {
369 ( $res: expr, $chan_id: expr ) => {
370 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
374 // Convert constants + channel value to limits:
375 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
376 channel_value_satoshis * 1000 / 10 //TODO
379 /// Guaranteed to return a value no larger than channel_value_satoshis
380 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
381 let (q, _) = channel_value_satoshis.overflowing_div(100);
382 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
385 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
386 at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000 //TODO
389 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
393 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
394 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
396 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
400 fn derive_maximum_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
401 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
406 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> {
407 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
408 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
411 if push_msat > channel_value_satoshis * 1000 {
412 return Err(APIError::APIMisuseError{err: "push value > channel value"});
416 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
417 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
418 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
421 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
423 let secp_ctx = Secp256k1::new();
424 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
425 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();
426 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
427 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
428 &chan_keys.htlc_base_key,
429 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
434 channel_id: rng::rand_u832(),
435 channel_state: ChannelState::OurInitSent as u32,
436 channel_outbound: true,
438 announce_publicly: announce_publicly,
439 channel_value_satoshis: channel_value_satoshis,
441 local_keys: chan_keys,
442 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
443 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
444 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
445 pending_inbound_htlcs: Vec::new(),
446 pending_outbound_htlcs: Vec::new(),
447 holding_cell_htlc_updates: Vec::new(),
448 next_local_htlc_id: 0,
449 next_remote_htlc_id: 0,
450 channel_update_count: 1,
452 last_local_commitment_txn: Vec::new(),
454 last_sent_closing_fee: None,
456 funding_tx_confirmed_in: None,
457 short_channel_id: None,
458 last_block_connected: Default::default(),
459 funding_tx_confirmations: 0,
461 feerate_per_kw: feerate,
462 their_dust_limit_satoshis: 0,
463 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
464 their_max_htlc_value_in_flight_msat: 0,
465 their_channel_reserve_satoshis: 0,
466 their_htlc_minimum_msat: 0,
467 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
468 their_to_self_delay: 0,
469 their_max_accepted_htlcs: 0,
471 their_funding_pubkey: None,
472 their_revocation_basepoint: None,
473 their_payment_basepoint: None,
474 their_delayed_payment_basepoint: None,
475 their_htlc_basepoint: None,
476 their_cur_commitment_point: None,
478 their_prev_commitment_point: None,
479 their_node_id: their_node_id,
481 their_shutdown_scriptpubkey: None,
483 channel_monitor: channel_monitor,
489 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), HandleError> {
490 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
491 return Err(HandleError{err: "Peer's feerate much too low", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
493 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
494 return Err(HandleError{err: "Peer's feerate much too high", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
499 /// Creates a new channel from a remote sides' request for one.
500 /// Assumes chain_hash has already been checked and corresponds with what we expect!
501 /// Generally prefers to take the DisconnectPeer action on failure, as a notice to the sender
502 /// that we're rejecting the new channel.
503 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, HandleError> {
504 macro_rules! return_error_message {
506 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
510 // Check sanity of message fields:
511 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
512 return_error_message!("funding value > 2^24");
514 if msg.channel_reserve_satoshis > msg.funding_satoshis {
515 return_error_message!("Bogus channel_reserve_satoshis");
517 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
518 return_error_message!("push_msat larger than funding value");
520 if msg.dust_limit_satoshis > msg.funding_satoshis {
521 return_error_message!("Peer never wants payout outputs?");
523 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
524 return_error_message!("Bogus; channel reserve is less than dust limit");
526 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
527 return_error_message!("Miminum htlc value is full channel value");
529 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw).map_err(|e|
530 HandleError{err: e.err, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: e.err.to_string() }})}
533 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
534 return_error_message!("They wanted our payments to be delayed by a needlessly long period");
536 if msg.max_accepted_htlcs < 1 {
537 return_error_message!("0 max_accpted_htlcs makes for a useless channel");
539 if msg.max_accepted_htlcs > 483 {
540 return_error_message!("max_accpted_htlcs > 483");
543 // Convert things into internal flags and prep our state:
545 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
546 if require_announce && !their_announce {
547 return_error_message!("Peer tried to open unannounced channel, but we require public ones");
549 if !allow_announce && their_announce {
550 return_error_message!("Peer tried to open announced channel, but we require private ones");
553 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
555 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
556 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
557 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
558 return_error_message!("Suitalbe channel reserve not found. aborting");
560 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
561 return_error_message!("channel_reserve_satoshis too small");
563 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
564 return_error_message!("Dust limit too high for our channel reserve");
567 // check if the funder's amount for the initial commitment tx is sufficient
568 // for full fee payment
569 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
570 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
571 return_error_message!("Insufficient funding amount for initial commitment");
574 let to_local_msat = msg.push_msat;
575 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
576 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
577 return_error_message!("Insufficient funding amount for initial commitment");
580 let secp_ctx = Secp256k1::new();
581 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
582 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();
583 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
584 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
585 &chan_keys.htlc_base_key,
586 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
587 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
588 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
590 let mut chan = Channel {
593 channel_id: msg.temporary_channel_id,
594 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
595 channel_outbound: false,
597 announce_publicly: their_announce,
599 local_keys: chan_keys,
600 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
601 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
602 value_to_self_msat: msg.push_msat,
603 pending_inbound_htlcs: Vec::new(),
604 pending_outbound_htlcs: Vec::new(),
605 holding_cell_htlc_updates: Vec::new(),
606 next_local_htlc_id: 0,
607 next_remote_htlc_id: 0,
608 channel_update_count: 1,
610 last_local_commitment_txn: Vec::new(),
612 last_sent_closing_fee: None,
614 funding_tx_confirmed_in: None,
615 short_channel_id: None,
616 last_block_connected: Default::default(),
617 funding_tx_confirmations: 0,
619 feerate_per_kw: msg.feerate_per_kw as u64,
620 channel_value_satoshis: msg.funding_satoshis,
621 their_dust_limit_satoshis: msg.dust_limit_satoshis,
622 our_dust_limit_satoshis: our_dust_limit_satoshis,
623 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
624 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
625 their_htlc_minimum_msat: msg.htlc_minimum_msat,
626 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
627 their_to_self_delay: msg.to_self_delay,
628 their_max_accepted_htlcs: msg.max_accepted_htlcs,
630 their_funding_pubkey: Some(msg.funding_pubkey),
631 their_revocation_basepoint: Some(msg.revocation_basepoint),
632 their_payment_basepoint: Some(msg.payment_basepoint),
633 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
634 their_htlc_basepoint: Some(msg.htlc_basepoint),
635 their_cur_commitment_point: Some(msg.first_per_commitment_point),
637 their_prev_commitment_point: None,
638 their_node_id: their_node_id,
640 their_shutdown_scriptpubkey: None,
642 channel_monitor: channel_monitor,
647 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
648 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
653 // Utilities to derive keys:
655 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
656 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
657 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
660 // Utilities to build transactions:
662 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
663 let mut sha = Sha256::new();
664 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
666 if self.channel_outbound {
667 sha.input(&our_payment_basepoint.serialize());
668 sha.input(&self.their_payment_basepoint.unwrap().serialize());
670 sha.input(&self.their_payment_basepoint.unwrap().serialize());
671 sha.input(&our_payment_basepoint.serialize());
673 let mut res = [0; 32];
674 sha.result(&mut res);
676 ((res[26] as u64) << 5*8) |
677 ((res[27] as u64) << 4*8) |
678 ((res[28] as u64) << 3*8) |
679 ((res[29] as u64) << 2*8) |
680 ((res[30] as u64) << 1*8) |
681 ((res[31] as u64) << 0*8)
684 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
685 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
686 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
687 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
688 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
690 /// @local is used only to convert relevant internal structures which refer to remote vs local
691 /// to decide value of outputs and direction of HTLCs.
692 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
693 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
694 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
695 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
696 /// which peer generated this transaction and "to whom" this transaction flows.
698 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool) -> (Transaction, Vec<HTLCOutputInCommitment>) {
699 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
702 let mut ins: Vec<TxIn> = Vec::new();
704 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
705 script_sig: Script::new(),
706 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
712 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
714 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
715 let mut remote_htlc_total_msat = 0;
716 let mut local_htlc_total_msat = 0;
717 let mut value_to_self_msat_offset = 0;
719 macro_rules! add_htlc_output {
720 ($htlc: expr, $outbound: expr) => {
721 if $outbound == local { // "offered HTLC output"
722 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
723 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
725 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
726 value: $htlc.amount_msat / 1000
727 }, Some(htlc_in_tx)));
730 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
731 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
732 txouts.push((TxOut { // "received HTLC output"
733 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
734 value: $htlc.amount_msat / 1000
735 }, Some(htlc_in_tx)));
741 for ref htlc in self.pending_inbound_htlcs.iter() {
742 let include = match htlc.state {
743 InboundHTLCState::RemoteAnnounced => !generated_by_local,
744 InboundHTLCState::AwaitingRemoteRevokeToAnnounce => !generated_by_local,
745 InboundHTLCState::AwaitingAnnouncedRemoteRevoke => true,
746 InboundHTLCState::Committed => true,
747 InboundHTLCState::LocalRemoved => !generated_by_local,
751 add_htlc_output!(htlc, false);
752 remote_htlc_total_msat += htlc.amount_msat;
755 InboundHTLCState::LocalRemoved => {
756 if generated_by_local && htlc.local_removed_fulfilled {
757 value_to_self_msat_offset += htlc.amount_msat as i64;
765 for ref htlc in self.pending_outbound_htlcs.iter() {
766 let include = match htlc.state {
767 OutboundHTLCState::LocalAnnounced => generated_by_local,
768 OutboundHTLCState::Committed => true,
769 OutboundHTLCState::RemoteRemoved => generated_by_local,
770 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
771 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
775 add_htlc_output!(htlc, true);
776 local_htlc_total_msat += htlc.amount_msat;
779 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
780 if htlc.fail_reason.is_none() {
781 value_to_self_msat_offset -= htlc.amount_msat as i64;
784 OutboundHTLCState::RemoteRemoved => {
785 if !generated_by_local && htlc.fail_reason.is_none() {
786 value_to_self_msat_offset -= htlc.amount_msat as i64;
794 let total_fee: u64 = self.feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
795 let value_to_self: i64 = ((self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset) / 1000 - if self.channel_outbound { total_fee as i64 } else { 0 };
796 let value_to_remote: i64 = (((self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset) / 1000) - if self.channel_outbound { 0 } else { total_fee as i64 };
798 let value_to_a = if local { value_to_self } else { value_to_remote };
799 let value_to_b = if local { value_to_remote } else { value_to_self };
801 if value_to_a >= (dust_limit_satoshis as i64) {
803 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
804 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
805 &keys.a_delayed_payment_key).to_v0_p2wsh(),
806 value: value_to_a as u64
810 if value_to_b >= (dust_limit_satoshis as i64) {
812 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
813 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
815 value: value_to_b as u64
819 transaction_utils::sort_outputs(&mut txouts);
821 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
822 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
823 for (idx, out) in txouts.drain(..).enumerate() {
825 if let Some(out_htlc) = out.1 {
826 htlcs_used.push(out_htlc);
827 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
833 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
840 fn get_closing_scriptpubkey(&self) -> Script {
841 let our_channel_close_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.channel_close_key).serialize());
842 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
846 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
847 (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)
851 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
853 let mut ins: Vec<TxIn> = Vec::new();
855 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
856 script_sig: Script::new(),
857 sequence: 0xffffffff,
863 assert!(self.pending_inbound_htlcs.is_empty());
864 assert!(self.pending_outbound_htlcs.is_empty());
865 let mut txouts: Vec<(TxOut, ())> = Vec::new();
867 let mut total_fee_satoshis = proposed_total_fee_satoshis;
868 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
869 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 };
871 if value_to_self < 0 {
872 assert!(self.channel_outbound);
873 total_fee_satoshis += (-value_to_self) as u64;
874 } else if value_to_remote < 0 {
875 assert!(!self.channel_outbound);
876 total_fee_satoshis += (-value_to_remote) as u64;
879 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
881 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
882 value: value_to_remote as u64
886 if value_to_self as u64 > self.our_dust_limit_satoshis {
888 script_pubkey: self.get_closing_scriptpubkey(),
889 value: value_to_self as u64
893 transaction_utils::sort_outputs(&mut txouts);
895 let mut outputs: Vec<TxOut> = Vec::new();
896 for out in txouts.drain(..) {
905 }, total_fee_satoshis)
909 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
910 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
911 /// our counterparty!)
912 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
913 /// TODO Some magic rust shit to compile-time check this?
914 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
915 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
916 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
917 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
919 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()))
923 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
924 /// will sign and send to our counterparty.
925 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
926 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
927 //may see payments to it!
928 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
929 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
930 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
932 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()))
935 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
936 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
937 /// Panics if called before accept_channel/new_from_req
938 pub fn get_funding_redeemscript(&self) -> Script {
939 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
940 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
941 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
942 if our_funding_key[..] < their_funding_key[..] {
943 builder.push_slice(&our_funding_key)
944 .push_slice(&their_funding_key)
946 builder.push_slice(&their_funding_key)
947 .push_slice(&our_funding_key)
948 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
951 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
952 if tx.input.len() != 1 {
953 panic!("Tried to sign commitment transaction that had input count != 1!");
955 if tx.input[0].witness.len() != 0 {
956 panic!("Tried to re-sign commitment transaction");
959 let funding_redeemscript = self.get_funding_redeemscript();
961 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
962 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
964 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
966 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
967 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
968 if our_funding_key[..] < their_funding_key[..] {
969 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
970 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
972 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
973 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
975 tx.input[0].witness[1].push(SigHashType::All as u8);
976 tx.input[0].witness[2].push(SigHashType::All as u8);
978 tx.input[0].witness.push(funding_redeemscript.into_bytes());
983 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
984 /// @local is used only to convert relevant internal structures which refer to remote vs local
985 /// to decide value of outputs and direction of HTLCs.
986 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys) -> Transaction {
987 chan_utils::build_htlc_transaction(prev_hash, self.feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
990 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
991 if tx.input.len() != 1 {
992 panic!("Tried to sign HTLC transaction that had input count != 1!");
995 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
997 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());
998 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
999 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1000 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1003 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1004 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1005 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1006 if tx.input.len() != 1 {
1007 panic!("Tried to sign HTLC transaction that had input count != 1!");
1009 if tx.input[0].witness.len() != 0 {
1010 panic!("Tried to re-sign HTLC transaction");
1013 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1015 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1017 if local_tx { // b, then a
1018 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1019 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1021 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1022 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1024 tx.input[0].witness[1].push(SigHashType::All as u8);
1025 tx.input[0].witness[2].push(SigHashType::All as u8);
1028 tx.input[0].witness.push(Vec::new());
1030 tx.input[0].witness.push(preimage.unwrap().to_vec());
1033 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1038 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1039 /// debug_assertions are turned on
1040 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1041 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1042 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1043 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1045 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1046 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1048 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1050 let mut sha = Sha256::new();
1051 sha.input(&payment_preimage_arg);
1052 let mut payment_hash_calc = [0; 32];
1053 sha.result(&mut payment_hash_calc);
1055 let mut pending_idx = std::usize::MAX;
1056 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1057 if htlc.htlc_id == htlc_id_arg {
1058 assert_eq!(htlc.payment_hash, payment_hash_calc);
1059 if htlc.state != InboundHTLCState::Committed {
1060 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1061 // Don't return in release mode here so that we can update channel_monitor
1067 if pending_idx == std::usize::MAX {
1068 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1069 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1072 // Now update local state:
1074 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1075 // can claim it even if the channel hits the chain before we see their next commitment.
1076 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1078 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1079 for pending_update in self.holding_cell_htlc_updates.iter() {
1080 match pending_update {
1081 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1082 if htlc_id_arg == htlc_id {
1083 debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1084 return Ok((None, None));
1087 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1088 if htlc_id_arg == htlc_id {
1089 debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1090 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1096 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1097 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1099 return Ok((None, Some(self.channel_monitor.clone())));
1103 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1104 if htlc.state != InboundHTLCState::Committed {
1105 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1106 return Ok((None, Some(self.channel_monitor.clone())));
1108 htlc.state = InboundHTLCState::LocalRemoved;
1109 htlc.local_removed_fulfilled = true;
1112 Ok((Some(msgs::UpdateFulfillHTLC {
1113 channel_id: self.channel_id(),
1114 htlc_id: htlc_id_arg,
1115 payment_preimage: payment_preimage_arg,
1116 }), Some(self.channel_monitor.clone())))
1119 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> {
1120 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1121 (Some(update_fulfill_htlc), _) => {
1122 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1123 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1125 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1126 (None, None) => Ok((None, None))
1130 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1131 /// debug_assertions are turned on
1132 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1133 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1134 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1136 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1138 let mut pending_idx = std::usize::MAX;
1139 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1140 if htlc.htlc_id == htlc_id_arg {
1141 if htlc.state != InboundHTLCState::Committed {
1142 debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1143 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1148 if pending_idx == std::usize::MAX {
1149 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1150 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1153 // Now update local state:
1154 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1155 for pending_update in self.holding_cell_htlc_updates.iter() {
1156 match pending_update {
1157 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1158 if htlc_id_arg == htlc_id {
1159 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1160 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1163 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1164 if htlc_id_arg == htlc_id {
1165 debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1172 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1173 htlc_id: htlc_id_arg,
1180 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1181 htlc.state = InboundHTLCState::LocalRemoved;
1182 htlc.local_removed_fulfilled = false;
1185 Ok(Some(msgs::UpdateFailHTLC {
1186 channel_id: self.channel_id(),
1187 htlc_id: htlc_id_arg,
1192 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> {
1193 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1194 Some(update_fail_htlc) => {
1195 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1196 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1202 // Message handlers:
1204 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1205 macro_rules! return_error_message {
1207 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
1210 // Check sanity of message fields:
1211 if !self.channel_outbound {
1212 return_error_message!("Got an accept_channel message from an inbound peer");
1214 if self.channel_state != ChannelState::OurInitSent as u32 {
1215 return_error_message!("Got an accept_channel message at a strange time");
1217 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1218 return_error_message!("Peer never wants payout outputs?");
1220 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1221 return_error_message!("Bogus channel_reserve_satoshis");
1223 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1224 return_error_message!("Bogus channel_reserve and dust_limit");
1226 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1227 return_error_message!("Peer never wants payout outputs?");
1229 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1230 return_error_message!("Dust limit is bigger than our channel reverse");
1232 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1233 return_error_message!("Minimum htlc value is full channel value");
1235 if msg.minimum_depth > Channel::derive_maximum_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) {
1236 return_error_message!("minimum_depth too large");
1238 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1239 return_error_message!("They wanted our payments to be delayed by a needlessly long period");
1241 if msg.max_accepted_htlcs < 1 {
1242 return_error_message!("0 max_accpted_htlcs makes for a useless channel");
1244 if msg.max_accepted_htlcs > 483 {
1245 return_error_message!("max_accpted_htlcs > 483");
1248 // TODO: Optional additional constraints mentioned in the spec
1249 // MAY fail the channel if
1250 // funding_satoshi is too small
1251 // htlc_minimum_msat too large
1252 // max_htlc_value_in_flight_msat too small
1253 // channel_reserve_satoshis too large
1254 // max_accepted_htlcs too small
1255 // dust_limit_satoshis too small
1257 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1259 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1260 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1261 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1262 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1263 self.their_to_self_delay = msg.to_self_delay;
1264 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1265 self.their_funding_pubkey = Some(msg.funding_pubkey);
1266 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1267 self.their_payment_basepoint = Some(msg.payment_basepoint);
1268 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1269 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1270 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1272 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1273 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1274 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1276 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1281 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1282 let funding_script = self.get_funding_redeemscript();
1284 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1285 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1286 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();
1288 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1289 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1291 let remote_keys = self.build_remote_transaction_keys()?;
1292 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
1293 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();
1295 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1296 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key)))
1299 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1300 if self.channel_outbound {
1301 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()}})});
1303 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1304 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1305 // remember the channel, so its safe to just send an error_message here and drop the
1307 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()}})});
1309 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1310 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1311 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1312 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1315 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1316 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1317 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1319 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1322 self.channel_monitor.unset_funding_info();
1327 // Now that we're past error-generating stuff, update our local state:
1329 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1330 self.channel_state = ChannelState::FundingSent as u32;
1331 self.channel_id = funding_txo.to_channel_id();
1332 self.cur_remote_commitment_transaction_number -= 1;
1333 self.cur_local_commitment_transaction_number -= 1;
1335 Ok((msgs::FundingSigned {
1336 channel_id: self.channel_id,
1337 signature: our_signature
1338 }, self.channel_monitor.clone()))
1341 /// Handles a funding_signed message from the remote end.
1342 /// If this call is successful, broadcast the funding transaction (and not before!)
1343 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1344 if !self.channel_outbound {
1345 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1347 if self.channel_state != ChannelState::FundingCreated as u32 {
1348 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1350 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1351 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1352 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1353 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1356 let funding_script = self.get_funding_redeemscript();
1358 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1359 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1360 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();
1362 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1363 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1365 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1366 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1367 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1368 self.channel_state = ChannelState::FundingSent as u32;
1369 self.cur_local_commitment_transaction_number -= 1;
1371 Ok(self.channel_monitor.clone())
1374 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
1375 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1376 return Err(HandleError{err: "Peer sent funding_locked when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent funding_locked when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1378 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
1379 if non_shutdown_state == ChannelState::FundingSent as u32 {
1380 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1381 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1382 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
1383 self.channel_update_count += 1;
1384 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1385 // Note that funding_signed/funding_created will have decremented both by 1!
1386 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1387 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1388 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1389 return Err(HandleError{err: "Peer sent a reconnect funding_locked with a different point", action: None});
1391 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1394 return Err(HandleError{err: "Peer sent a funding_locked at a strange time", action: None});
1397 self.their_prev_commitment_point = self.their_cur_commitment_point;
1398 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1402 /// Returns (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1403 /// If its for a remote update check, we need to be more lax about checking against messages we
1404 /// sent but they may not have received/processed before they sent this message. Further, for
1405 /// our own sends, we're more conservative and even consider things they've removed against
1406 /// totals, though there is little reason to outside of further avoiding any race condition
1408 fn get_pending_htlc_stats(&self, for_remote_update_check: bool) -> (u32, u32, u64, u64) {
1409 //TODO: Can probably split this into inbound/outbound
1410 let mut inbound_htlc_count: u32 = 0;
1411 let mut outbound_htlc_count: u32 = 0;
1412 let mut htlc_outbound_value_msat = 0;
1413 let mut htlc_inbound_value_msat = 0;
1414 for ref htlc in self.pending_inbound_htlcs.iter() {
1416 InboundHTLCState::RemoteAnnounced => {},
1417 InboundHTLCState::AwaitingRemoteRevokeToAnnounce => {},
1418 InboundHTLCState::AwaitingAnnouncedRemoteRevoke => {},
1419 InboundHTLCState::Committed => {},
1420 InboundHTLCState::LocalRemoved => {},
1422 inbound_htlc_count += 1;
1423 htlc_inbound_value_msat += htlc.amount_msat;
1425 for ref htlc in self.pending_outbound_htlcs.iter() {
1427 OutboundHTLCState::LocalAnnounced => { if for_remote_update_check { continue; } },
1428 OutboundHTLCState::Committed => {},
1429 OutboundHTLCState::RemoteRemoved => { if for_remote_update_check { continue; } },
1430 OutboundHTLCState::AwaitingRemoteRevokeToRemove => { if for_remote_update_check { continue; } },
1431 OutboundHTLCState::AwaitingRemovedRemoteRevoke => { if for_remote_update_check { continue; } },
1433 outbound_htlc_count += 1;
1434 htlc_outbound_value_msat += htlc.amount_msat;
1437 (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1440 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1441 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1442 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1444 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1445 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}})});
1447 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1448 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1450 if msg.amount_msat < self.our_htlc_minimum_msat {
1451 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1454 let (inbound_htlc_count, _, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(true);
1455 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1456 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1458 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1459 // Check our_max_htlc_value_in_flight_msat
1460 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1461 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1463 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1464 // the reserve_satoshis we told them to always have as direct payment so that they lose
1465 // something if we punish them for broadcasting an old state).
1466 if htlc_inbound_value_msat + htlc_outbound_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 {
1467 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1469 if self.next_remote_htlc_id != msg.htlc_id {
1470 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1472 if msg.cltv_expiry >= 500000000 {
1473 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1476 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1478 // Now update local state:
1479 self.next_remote_htlc_id += 1;
1480 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1481 htlc_id: msg.htlc_id,
1482 amount_msat: msg.amount_msat,
1483 payment_hash: msg.payment_hash,
1484 cltv_expiry: msg.cltv_expiry,
1485 state: InboundHTLCState::RemoteAnnounced,
1486 local_removed_fulfilled: false,
1487 pending_forward_state: Some(pending_forward_state),
1493 /// Removes an outbound HTLC which has been commitment_signed by the remote end
1495 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, HandleError> {
1496 for htlc in self.pending_outbound_htlcs.iter_mut() {
1497 if htlc.htlc_id == htlc_id {
1498 match check_preimage {
1500 Some(payment_hash) =>
1501 if payment_hash != htlc.payment_hash {
1502 return Err(HandleError{err: "Remote tried to fulfill HTLC with an incorrect preimage", action: None});
1506 OutboundHTLCState::LocalAnnounced =>
1507 return Err(HandleError{err: "Remote tried to fulfill HTLC before it had been committed", action: None}),
1508 OutboundHTLCState::Committed => {
1509 htlc.state = OutboundHTLCState::RemoteRemoved;
1510 htlc.fail_reason = fail_reason;
1512 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1513 return Err(HandleError{err: "Remote tried to fulfill HTLC that they'd already fulfilled", action: None}),
1515 return Ok(&htlc.source);
1518 Err(HandleError{err: "Remote tried to fulfill/fail an HTLC we couldn't find", action: None})
1521 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, HandleError> {
1522 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1523 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1525 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1526 return Err(HandleError{err: "Peer sent update_fulfill_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1529 let mut sha = Sha256::new();
1530 sha.input(&msg.payment_preimage);
1531 let mut payment_hash = [0; 32];
1532 sha.result(&mut payment_hash);
1534 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1537 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, HandleError> {
1538 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1539 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1541 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1542 return Err(HandleError{err: "Peer sent update_fail_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fail_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1545 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1548 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, HandleError> {
1549 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1550 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1552 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1553 return Err(HandleError{err: "Peer sent update_fail_malformed_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1556 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1559 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1560 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1561 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1563 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1564 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}})});
1567 let funding_script = self.get_funding_redeemscript();
1569 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1570 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false);
1571 let local_commitment_txid = local_commitment_tx.0.txid();
1572 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();
1573 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1575 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1576 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1579 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1580 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1581 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1583 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1584 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1585 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys);
1586 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1587 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1588 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());
1589 let htlc_sig = if htlc.offered {
1590 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1591 new_local_commitment_txn.push(htlc_tx);
1594 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1596 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1599 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1600 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1602 // Update state now that we've passed all the can-fail calls...
1603 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1605 let mut need_our_commitment = false;
1606 for htlc in self.pending_inbound_htlcs.iter_mut() {
1607 if htlc.state == InboundHTLCState::RemoteAnnounced {
1608 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce;
1609 need_our_commitment = true;
1612 for htlc in self.pending_outbound_htlcs.iter_mut() {
1613 if htlc.state == OutboundHTLCState::RemoteRemoved {
1614 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1615 need_our_commitment = true;
1619 self.cur_local_commitment_transaction_number -= 1;
1620 self.last_local_commitment_txn = new_local_commitment_txn;
1622 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1623 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1624 // we'll send one right away when we get the revoke_and_ack when we
1625 // free_holding_cell_htlcs().
1626 let (msg, monitor) = self.send_commitment_no_status_check()?;
1627 (Some(msg), monitor)
1628 } else { (None, self.channel_monitor.clone()) };
1630 Ok((msgs::RevokeAndACK {
1631 channel_id: self.channel_id,
1632 per_commitment_secret: per_commitment_secret,
1633 next_per_commitment_point: next_per_commitment_point,
1634 }, our_commitment_signed, monitor_update))
1637 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1638 /// fulfilling or failing the last pending HTLC)
1639 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1640 if self.holding_cell_htlc_updates.len() != 0 {
1641 let mut htlc_updates = Vec::new();
1642 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1643 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1644 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1645 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1647 for htlc_update in htlc_updates.drain(..) {
1648 // Note that this *can* fail, though it should be due to rather-rare conditions on
1649 // fee races with adding too many outputs which push our total payments just over
1650 // the limit. In case its less rare than I anticipate, we may want to revisit
1651 // handling this case better and maybe fufilling some of the HTLCs while attempting
1652 // to rebalance channels.
1653 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1654 self.holding_cell_htlc_updates.push(htlc_update);
1656 match &htlc_update {
1657 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1658 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1659 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1665 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1666 match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1667 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1669 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1671 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1676 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1677 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1678 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1680 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1682 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1689 self.holding_cell_htlc_updates.push(htlc_update);
1693 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1694 //fail it back the route, if its a temporary issue we can ignore it...
1697 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() {
1698 // This should never actually happen and indicates we got some Errs back
1699 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1700 // case there is some strange way to hit duplicate HTLC removes.
1703 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1704 Ok(Some((msgs::CommitmentUpdate {
1706 update_fulfill_htlcs,
1708 update_fail_malformed_htlcs: Vec::new(),
1710 }, monitor_update)))
1719 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1720 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1721 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1722 /// generating an appropriate error *after* the channel state has been updated based on the
1723 /// revoke_and_ack message.
1724 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1725 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1726 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1728 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1729 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}})});
1731 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1732 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 {
1733 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1736 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)))?;
1738 // Update state now that we've passed all the can-fail calls...
1739 // (note that we may still fail to generate the new commitment_signed message, but that's
1740 // OK, we step the channel here and *then* if the new generation fails we can fail the
1741 // channel based on that, but stepping stuff here should be safe either way.
1742 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1743 self.their_prev_commitment_point = self.their_cur_commitment_point;
1744 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1745 self.cur_remote_commitment_transaction_number -= 1;
1747 let mut to_forward_infos = Vec::new();
1748 let mut revoked_htlcs = Vec::new();
1749 let mut update_fail_htlcs = Vec::new();
1750 let mut update_fail_malformed_htlcs = Vec::new();
1751 let mut require_commitment = false;
1752 let mut value_to_self_msat_diff: i64 = 0;
1753 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1754 self.pending_inbound_htlcs.retain(|htlc| {
1755 if htlc.state == InboundHTLCState::LocalRemoved {
1756 if htlc.local_removed_fulfilled {
1757 value_to_self_msat_diff += htlc.amount_msat as i64;
1762 self.pending_outbound_htlcs.retain(|htlc| {
1763 if htlc.state == OutboundHTLCState::AwaitingRemovedRemoteRevoke {
1764 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1765 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1767 // They fulfilled, so we sent them money
1768 value_to_self_msat_diff -= htlc.amount_msat as i64;
1773 for htlc in self.pending_inbound_htlcs.iter_mut() {
1774 if htlc.state == InboundHTLCState::AwaitingRemoteRevokeToAnnounce {
1775 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke;
1776 require_commitment = true;
1777 } else if htlc.state == InboundHTLCState::AwaitingAnnouncedRemoteRevoke {
1778 match htlc.pending_forward_state.take().unwrap() {
1779 PendingHTLCStatus::Fail(fail_msg) => {
1780 htlc.state = InboundHTLCState::LocalRemoved;
1781 require_commitment = true;
1783 HTLCFailureMsg::Relay(msg) => update_fail_htlcs.push(msg),
1784 HTLCFailureMsg::Malformed(msg) => update_fail_malformed_htlcs.push(msg),
1787 PendingHTLCStatus::Forward(forward_info) => {
1788 to_forward_infos.push((forward_info, htlc.htlc_id));
1789 htlc.state = InboundHTLCState::Committed;
1794 for htlc in self.pending_outbound_htlcs.iter_mut() {
1795 if htlc.state == OutboundHTLCState::LocalAnnounced {
1796 htlc.state = OutboundHTLCState::Committed;
1797 } else if htlc.state == OutboundHTLCState::AwaitingRemoteRevokeToRemove {
1798 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1799 require_commitment = true;
1802 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1804 match self.free_holding_cell_htlcs()? {
1805 Some(mut commitment_update) => {
1806 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
1807 for fail_msg in update_fail_htlcs.drain(..) {
1808 commitment_update.0.update_fail_htlcs.push(fail_msg);
1810 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
1811 for fail_msg in update_fail_malformed_htlcs.drain(..) {
1812 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
1814 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
1817 if require_commitment {
1818 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1819 Ok((Some(msgs::CommitmentUpdate {
1820 update_add_htlcs: Vec::new(),
1821 update_fulfill_htlcs: Vec::new(),
1823 update_fail_malformed_htlcs,
1825 }), to_forward_infos, revoked_htlcs, monitor_update))
1827 Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
1833 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
1834 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
1835 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
1836 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
1837 /// No further message handling calls may be made until a channel_reestablish dance has
1839 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
1840 let mut outbound_drops = Vec::new();
1842 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1843 if self.channel_state < ChannelState::FundingSent as u32 {
1844 self.channel_state = ChannelState::ShutdownComplete as u32;
1845 return outbound_drops;
1848 let mut inbound_drop_count = 0;
1849 self.pending_inbound_htlcs.retain(|htlc| {
1851 InboundHTLCState::RemoteAnnounced => {
1852 // They sent us an update_add_htlc but we never got the commitment_signed.
1853 // We'll tell them what commitment_signed we're expecting next and they'll drop
1854 // this HTLC accordingly
1855 inbound_drop_count += 1;
1858 InboundHTLCState::AwaitingRemoteRevokeToAnnounce|InboundHTLCState::AwaitingAnnouncedRemoteRevoke => {
1859 // Same goes for AwaitingRemoteRevokeToRemove and AwaitingRemovedRemoteRevoke
1860 // We received a commitment_signed updating this HTLC and (at least hopefully)
1861 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
1862 // in response to it yet, so don't touch it.
1865 InboundHTLCState::Committed => true,
1866 InboundHTLCState::LocalRemoved => { // Same goes for LocalAnnounced
1867 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
1868 // re-transmit if needed) and they may have even sent a revoke_and_ack back
1869 // (that we missed). Keep this around for now and if they tell us they missed
1870 // the commitment_signed we can re-transmit the update then.
1876 for htlc in self.pending_outbound_htlcs.iter_mut() {
1877 if htlc.state == OutboundHTLCState::RemoteRemoved {
1878 // They sent us an update to remove this but haven't yet sent the corresponding
1879 // commitment_signed, we need to move it back to Committed and they can re-send
1880 // the update upon reconnection.
1881 htlc.state = OutboundHTLCState::Committed;
1885 self.holding_cell_htlc_updates.retain(|htlc_update| {
1887 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
1888 outbound_drops.push((source.clone(), payment_hash.clone()));
1891 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
1894 self.channel_state |= ChannelState::PeerDisconnected as u32;
1895 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()));
1899 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1900 if self.channel_outbound {
1901 return Err(HandleError{err: "Non-funding remote tried to update channel fee", action: None});
1903 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1904 return Err(HandleError{err: "Peer sent update_fee when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_fee when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1906 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
1907 self.channel_update_count += 1;
1908 self.feerate_per_kw = msg.feerate_per_kw as u64;
1912 /// May panic if some calls other than message-handling calls (which will all Err immediately)
1913 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
1914 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>), HandleError> {
1915 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
1916 return Err(HandleError{err: "Peer sent a loose channel_reestablish not after reconnect", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent a loose channel_reestablish not after reconnect".to_string(), channel_id: msg.channel_id}})});
1919 if msg.next_local_commitment_number == 0 || msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
1920 msg.next_remote_commitment_number == 0 || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
1921 return Err(HandleError{err: "Peer send garbage channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer send garbage channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1924 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
1925 // remaining cases either succeed or ErrorMessage-fail).
1926 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
1928 let mut required_revoke = None;
1929 if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
1930 // Remote isn't waiting on any RevokeAndACK from us!
1931 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
1932 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
1933 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
1934 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
1935 required_revoke = Some(msgs::RevokeAndACK {
1936 channel_id: self.channel_id,
1937 per_commitment_secret,
1938 next_per_commitment_point,
1941 return Err(HandleError{err: "Peer attempted to reestablish channel with a very old local commitment transaction", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer attempted to reestablish channel with a very old remote commitment transaction".to_string(), channel_id: msg.channel_id}})});
1944 if msg.next_local_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number {
1945 if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
1946 log_debug!(self, "Reconnected channel {} with no lost commitment txn", log_bytes!(self.channel_id()));
1947 if msg.next_local_commitment_number == 1 && msg.next_remote_commitment_number == 1 {
1948 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
1949 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
1950 return Ok((Some(msgs::FundingLocked {
1951 channel_id: self.channel_id(),
1952 next_per_commitment_point: next_per_commitment_point,
1953 }), None, None, None));
1957 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1958 // We're up-to-date and not waiting on a remote revoke (if we are our
1959 // channel_reestablish should result in them sending a revoke_and_ack), but we may
1960 // have received some updates while we were disconnected. Free the holding cell
1962 match self.free_holding_cell_htlcs() {
1964 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
1965 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
1967 panic!("Got non-channel-failing result from free_holding_cell_htlcs");
1971 Ok(Some((commitment_update, channel_monitor))) => return Ok((None, required_revoke, Some(commitment_update), Some(channel_monitor))),
1972 Ok(None) => return Ok((None, required_revoke, None, None)),
1975 return Ok((None, required_revoke, None, None));
1977 } else if msg.next_local_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_remote_commitment_transaction_number {
1978 return Ok((None, required_revoke,
1979 Some(msgs::CommitmentUpdate {
1980 update_add_htlcs: Vec::new(),
1981 update_fulfill_htlcs: Vec::new(),
1982 update_fail_htlcs: Vec::new(),
1983 update_fail_malformed_htlcs: Vec::new(),
1984 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,
1987 return Err(HandleError{err: "Peer attempted to reestablish channel with a very old remote commitment transaction", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer attempted to reestablish channel with a very old remote commitment transaction".to_string(), channel_id: msg.channel_id}})});
1991 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), HandleError> {
1992 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1993 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}})});
1995 if self.channel_state < ChannelState::FundingSent as u32 {
1996 self.channel_state = ChannelState::ShutdownComplete as u32;
1997 self.channel_update_count += 1;
1998 return Ok((None, None, Vec::new()));
2000 for htlc in self.pending_inbound_htlcs.iter() {
2001 if htlc.state == InboundHTLCState::RemoteAnnounced {
2002 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
2005 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
2006 return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
2008 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2010 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2011 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2012 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2013 return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
2015 //TODO: Check shutdown_scriptpubkey form as BOLT says we must? WHYYY
2017 if self.their_shutdown_scriptpubkey.is_some() {
2018 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2019 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
2022 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2025 let our_closing_script = self.get_closing_scriptpubkey();
2027 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() {
2028 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2029 if self.feerate_per_kw > proposed_feerate {
2030 proposed_feerate = self.feerate_per_kw;
2032 let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
2033 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2035 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2036 let funding_redeemscript = self.get_funding_redeemscript();
2037 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2039 (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key)))
2040 } else { (None, None, None) };
2042 // From here on out, we may not fail!
2044 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2045 self.channel_update_count += 1;
2047 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2048 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2049 // cell HTLCs and return them to fail the payment.
2050 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2051 self.holding_cell_htlc_updates.retain(|htlc_update| {
2053 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2054 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2060 for htlc in self.pending_outbound_htlcs.iter() {
2061 if htlc.state == OutboundHTLCState::LocalAnnounced {
2062 return Ok((None, None, dropped_outbound_htlcs));
2066 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2069 Some(msgs::Shutdown {
2070 channel_id: self.channel_id,
2071 scriptpubkey: our_closing_script,
2075 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2076 self.channel_update_count += 1;
2077 if self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() && self.channel_outbound {
2078 // There are no more HTLCs and we're the funder, this means we start the closing_signed
2079 // dance with an initial fee proposal!
2080 self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
2081 Ok((our_shutdown, Some(msgs::ClosingSigned {
2082 channel_id: self.channel_id,
2083 fee_satoshis: proposed_fee.unwrap(),
2084 signature: our_sig.unwrap(),
2085 }), dropped_outbound_htlcs))
2087 Ok((our_shutdown, None, dropped_outbound_htlcs))
2091 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2092 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2093 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2095 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2096 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}})});
2098 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2099 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2101 if msg.fee_satoshis > 21000000 * 10000000 {
2102 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2105 let funding_redeemscript = self.get_funding_redeemscript();
2106 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2107 if used_total_fee != msg.fee_satoshis {
2108 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2110 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2112 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2115 // The remote end may have decided to revoke their output due to inconsistent dust
2116 // limits, so check for that case by re-checking the signature here.
2117 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2118 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2119 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2123 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2124 if last_fee == msg.fee_satoshis {
2125 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2126 self.channel_state = ChannelState::ShutdownComplete as u32;
2127 self.channel_update_count += 1;
2128 return Ok((None, Some(closing_tx)));
2132 macro_rules! propose_new_feerate {
2133 ($new_feerate: expr) => {
2134 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2135 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2136 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2137 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2138 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2139 return Ok((Some(msgs::ClosingSigned {
2140 channel_id: self.channel_id,
2141 fee_satoshis: used_total_fee,
2147 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2148 if self.channel_outbound {
2149 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2150 if proposed_sat_per_kw > our_max_feerate {
2151 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2152 if our_max_feerate <= last_feerate {
2153 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2156 propose_new_feerate!(our_max_feerate);
2159 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2160 if proposed_sat_per_kw < our_min_feerate {
2161 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2162 if our_min_feerate >= last_feerate {
2163 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2166 propose_new_feerate!(our_min_feerate);
2170 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2171 self.channel_state = ChannelState::ShutdownComplete as u32;
2172 self.channel_update_count += 1;
2174 Ok((Some(msgs::ClosingSigned {
2175 channel_id: self.channel_id,
2176 fee_satoshis: msg.fee_satoshis,
2178 }), Some(closing_tx)))
2181 // Public utilities:
2183 pub fn channel_id(&self) -> [u8; 32] {
2187 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2188 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2189 pub fn get_user_id(&self) -> u64 {
2193 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2194 pub fn channel_monitor(&self) -> ChannelMonitor {
2195 if self.channel_state < ChannelState::FundingCreated as u32 {
2196 panic!("Can't get a channel monitor until funding has been created");
2198 self.channel_monitor.clone()
2201 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2202 /// is_usable() returns true).
2203 /// Allowed in any state (including after shutdown)
2204 pub fn get_short_channel_id(&self) -> Option<u64> {
2205 self.short_channel_id
2208 /// Returns the funding_txo we either got from our peer, or were given by
2209 /// get_outbound_funding_created.
2210 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2211 self.channel_monitor.get_funding_txo()
2214 /// Allowed in any state (including after shutdown)
2215 pub fn get_their_node_id(&self) -> PublicKey {
2219 /// Allowed in any state (including after shutdown)
2220 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2221 self.our_htlc_minimum_msat
2224 pub fn get_value_satoshis(&self) -> u64 {
2225 self.channel_value_satoshis
2228 //TODO: Testing purpose only, should be changed in another way after #81
2230 pub fn get_local_keys(&self) -> &ChannelKeys {
2234 /// Allowed in any state (including after shutdown)
2235 pub fn get_channel_update_count(&self) -> u32 {
2236 self.channel_update_count
2239 pub fn should_announce(&self) -> bool {
2240 self.announce_publicly
2243 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2244 /// Allowed in any state (including after shutdown)
2245 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2246 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2247 // output value back into a transaction with the regular channel output:
2249 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2250 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2252 if self.channel_outbound {
2253 // + the marginal fee increase cost to us in the commitment transaction:
2254 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2257 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2258 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2263 /// Returns true if we've ever received a message from the remote end for this Channel
2264 pub fn have_received_message(&self) -> bool {
2265 self.channel_state > (ChannelState::OurInitSent as u32)
2268 /// Returns true if this channel is fully established and not known to be closing.
2269 /// Allowed in any state (including after shutdown)
2270 pub fn is_usable(&self) -> bool {
2271 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2272 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2275 /// Returns true if this channel is currently available for use. This is a superset of
2276 /// is_usable() and considers things like the channel being temporarily disabled.
2277 /// Allowed in any state (including after shutdown)
2278 pub fn is_live(&self) -> bool {
2279 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
2282 /// Returns true if funding_created was sent/received.
2283 pub fn is_funding_initiated(&self) -> bool {
2284 self.channel_state >= ChannelState::FundingCreated as u32
2287 /// Returns true if this channel is fully shut down. True here implies that no further actions
2288 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2289 /// will be handled appropriately by the chain monitor.
2290 pub fn is_shutdown(&self) -> bool {
2291 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2292 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2297 /// Called by channelmanager based on chain blocks being connected.
2298 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2299 /// the channel_monitor.
2300 /// In case of Err, the channel may have been closed, at which point the standard requirements
2301 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2302 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2303 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2304 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
2305 if self.funding_tx_confirmations > 0 {
2306 if header.bitcoin_hash() != self.last_block_connected {
2307 self.last_block_connected = header.bitcoin_hash();
2308 self.funding_tx_confirmations += 1;
2309 if self.funding_tx_confirmations == Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 {
2310 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2311 self.channel_state |= ChannelState::OurFundingLocked as u32;
2313 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2314 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
2315 self.channel_update_count += 1;
2317 } else if self.channel_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2318 // We got a reorg but not enough to trigger a force close, just update
2319 // funding_tx_confirmed_in and return.
2321 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2322 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2324 // We got a reorg but not enough to trigger a force close, just update
2325 // funding_tx_confirmed_in and return.
2328 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2330 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2331 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2332 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2333 //a protocol oversight, but I assume I'm just missing something.
2334 if need_commitment_update {
2335 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2336 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2337 return Ok(Some(msgs::FundingLocked {
2338 channel_id: self.channel_id,
2339 next_per_commitment_point: next_per_commitment_point,
2345 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2346 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2347 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2348 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2349 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2350 tx.output[txo_idx].value != self.channel_value_satoshis {
2351 if self.channel_outbound {
2352 // If we generated the funding transaction and it doesn't match what it
2353 // should, the client is really broken and we should just panic and
2354 // tell them off. That said, because hash collisions happen with high
2355 // probability in fuzztarget mode, if we're fuzzing we just close the
2356 // channel and move on.
2357 #[cfg(not(feature = "fuzztarget"))]
2358 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2360 self.channel_state = ChannelState::ShutdownComplete as u32;
2361 self.channel_update_count += 1;
2362 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2364 self.funding_tx_confirmations = 1;
2365 self.short_channel_id = Some(((height as u64) << (5*8)) |
2366 ((*index_in_block as u64) << (2*8)) |
2367 ((txo_idx as u64) << (0*8)));
2375 /// Called by channelmanager based on chain blocks being disconnected.
2376 /// Returns true if we need to close the channel now due to funding transaction
2377 /// unconfirmation/reorg.
2378 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2379 if self.funding_tx_confirmations > 0 {
2380 self.funding_tx_confirmations -= 1;
2381 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2385 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2386 self.funding_tx_confirmations = Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 - 1;
2391 // Methods to get unprompted messages to send to the remote end (or where we already returned
2392 // something in the handler for the message that prompted this message):
2394 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2395 if !self.channel_outbound {
2396 panic!("Tried to open a channel for an inbound channel?");
2398 if self.channel_state != ChannelState::OurInitSent as u32 {
2399 panic!("Cannot generate an open_channel after we've moved forward");
2402 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2403 panic!("Tried to send an open_channel for a channel that has already advanced");
2406 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2409 chain_hash: chain_hash,
2410 temporary_channel_id: self.channel_id,
2411 funding_satoshis: self.channel_value_satoshis,
2412 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2413 dust_limit_satoshis: self.our_dust_limit_satoshis,
2414 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2415 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2416 htlc_minimum_msat: self.our_htlc_minimum_msat,
2417 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2418 to_self_delay: BREAKDOWN_TIMEOUT,
2419 max_accepted_htlcs: OUR_MAX_HTLCS,
2420 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2421 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2422 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2423 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2424 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2425 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2426 channel_flags: if self.announce_publicly {1} else {0},
2427 shutdown_scriptpubkey: None,
2431 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2432 if self.channel_outbound {
2433 panic!("Tried to send accept_channel for an outbound channel?");
2435 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2436 panic!("Tried to send accept_channel after channel had moved forward");
2438 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2439 panic!("Tried to send an accept_channel for a channel that has already advanced");
2442 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2444 msgs::AcceptChannel {
2445 temporary_channel_id: self.channel_id,
2446 dust_limit_satoshis: self.our_dust_limit_satoshis,
2447 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2448 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2449 htlc_minimum_msat: self.our_htlc_minimum_msat,
2450 minimum_depth: Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat),
2451 to_self_delay: BREAKDOWN_TIMEOUT,
2452 max_accepted_htlcs: OUR_MAX_HTLCS,
2453 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2454 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2455 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2456 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2457 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2458 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2459 shutdown_scriptpubkey: None,
2463 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2464 let funding_script = self.get_funding_redeemscript();
2466 let remote_keys = self.build_remote_transaction_keys()?;
2467 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
2468 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();
2470 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2471 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2474 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2475 /// a funding_created message for the remote peer.
2476 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2477 /// or if called on an inbound channel.
2478 /// Note that channel_id changes during this call!
2479 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2480 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2481 if !self.channel_outbound {
2482 panic!("Tried to create outbound funding_created message on an inbound channel!");
2484 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2485 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)");
2487 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2488 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2489 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2490 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2493 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2494 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2496 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2499 log_error!(self, "Got bad signatures: {}!", e.err);
2500 self.channel_monitor.unset_funding_info();
2505 let temporary_channel_id = self.channel_id;
2507 // Now that we're past error-generating stuff, update our local state:
2508 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2509 self.channel_state = ChannelState::FundingCreated as u32;
2510 self.channel_id = funding_txo.to_channel_id();
2511 self.cur_remote_commitment_transaction_number -= 1;
2513 Ok((msgs::FundingCreated {
2514 temporary_channel_id: temporary_channel_id,
2515 funding_txid: funding_txo.txid,
2516 funding_output_index: funding_txo.index,
2517 signature: our_signature
2518 }, self.channel_monitor.clone()))
2521 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2522 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2523 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
2524 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2525 /// Will only fail if we're not in a state where channel_announcement may be sent (including
2527 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
2528 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
2529 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), HandleError> {
2530 if !self.announce_publicly {
2531 return Err(HandleError{err: "Channel is not available for public announcements", action: Some(msgs::ErrorAction::IgnoreError)});
2533 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
2534 return Err(HandleError{err: "Cannot get a ChannelAnnouncement until the channel funding has been locked", action: Some(msgs::ErrorAction::IgnoreError)});
2536 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
2537 return Err(HandleError{err: "Cannot get a ChannelAnnouncement once the channel is closing", action: Some(msgs::ErrorAction::IgnoreError)});
2540 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2541 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
2543 let msg = msgs::UnsignedChannelAnnouncement {
2544 features: msgs::GlobalFeatures::new(),
2545 chain_hash: chain_hash,
2546 short_channel_id: self.get_short_channel_id().unwrap(),
2547 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2548 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2549 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
2550 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
2551 excess_data: Vec::new(),
2554 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2555 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
2560 /// May panic if called on a channel that wasn't immediately-previously
2561 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
2562 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
2563 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
2564 msgs::ChannelReestablish {
2565 channel_id: self.channel_id(),
2566 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
2567 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number,
2568 data_loss_protect: None,
2573 // Send stuff to our remote peers:
2575 /// Adds a pending outbound HTLC to this channel, note that you probably want
2576 /// send_htlc_and_commit instead cause you'll want both messages at once.
2577 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2578 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
2579 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
2580 /// You MUST call send_commitment prior to any other calls on this Channel
2581 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> {
2582 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
2583 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
2586 if amount_msat > self.channel_value_satoshis * 1000 {
2587 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
2589 if amount_msat < self.their_htlc_minimum_msat {
2590 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
2593 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2594 // Note that this should never really happen, if we're !is_live() on receipt of an
2595 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
2596 // the user to send directly into a !is_live() channel. However, if we
2597 // disconnected during the time the previous hop was doing the commitment dance we may
2598 // end up getting here after the forwarding delay. In any case, returning an
2599 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
2600 return Err(HandleError{err: "Cannot send an HTLC while disconnected", action: Some(ErrorAction::IgnoreError)});
2603 let (_, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(false);
2604 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
2605 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
2607 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
2608 // Check their_max_htlc_value_in_flight_msat
2609 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
2610 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
2612 // Check their_channel_reserve_satoshis:
2613 if htlc_inbound_value_msat + htlc_outbound_value_msat + amount_msat + (self.channel_value_satoshis * 1000 - self.value_to_self_msat) > (self.channel_value_satoshis - self.their_channel_reserve_satoshis) * 1000 {
2614 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
2617 //TODO: Check cltv_expiry? Do this in channel manager?
2619 // Now update local state:
2620 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2621 //TODO: Check the limits *including* other pending holding cell HTLCs!
2622 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
2623 amount_msat: amount_msat,
2624 payment_hash: payment_hash,
2625 cltv_expiry: cltv_expiry,
2627 onion_routing_packet: onion_routing_packet,
2628 time_created: Instant::now(),
2633 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
2634 htlc_id: self.next_local_htlc_id,
2635 amount_msat: amount_msat,
2636 payment_hash: payment_hash.clone(),
2637 cltv_expiry: cltv_expiry,
2638 state: OutboundHTLCState::LocalAnnounced,
2643 let res = msgs::UpdateAddHTLC {
2644 channel_id: self.channel_id,
2645 htlc_id: self.next_local_htlc_id,
2646 amount_msat: amount_msat,
2647 payment_hash: payment_hash,
2648 cltv_expiry: cltv_expiry,
2649 onion_routing_packet: onion_routing_packet,
2651 self.next_local_htlc_id += 1;
2656 /// Creates a signed commitment transaction to send to the remote peer.
2657 /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
2658 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
2659 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
2660 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2661 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2662 panic!("Cannot create commitment tx until channel is fully established");
2664 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2665 panic!("Cannot create commitment tx until remote revokes their previous commitment");
2667 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2668 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
2670 let mut have_updates = false; // TODO initialize with "have we sent a fee update?"
2671 for htlc in self.pending_outbound_htlcs.iter() {
2672 if htlc.state == OutboundHTLCState::LocalAnnounced {
2673 have_updates = true;
2675 if have_updates { break; }
2678 panic!("Cannot create commitment tx until we have some updates to send");
2680 self.send_commitment_no_status_check()
2682 /// Only fails in case of bad keys
2683 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2684 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
2685 // fail to generate this, we still are at least at a position where upgrading their status
2687 for htlc in self.pending_inbound_htlcs.iter_mut() {
2688 if htlc.state == InboundHTLCState::AwaitingRemoteRevokeToAnnounce {
2689 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke;
2692 for htlc in self.pending_outbound_htlcs.iter_mut() {
2693 if htlc.state == OutboundHTLCState::AwaitingRemoteRevokeToRemove {
2694 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
2698 match self.send_commitment_no_state_update() {
2699 Ok((res, remote_commitment_tx)) => {
2700 // Update state now that we've passed all the can-fail calls...
2701 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
2702 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
2703 Ok((res, self.channel_monitor.clone()))
2709 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
2710 /// when we shouldn't change HTLC/channel state.
2711 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
2712 let funding_script = self.get_funding_redeemscript();
2714 let remote_keys = self.build_remote_transaction_keys()?;
2715 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true);
2716 let remote_commitment_txid = remote_commitment_tx.0.txid();
2717 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();
2718 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
2720 let mut htlc_sigs = Vec::new();
2722 for ref htlc in remote_commitment_tx.1.iter() {
2723 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys);
2724 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
2725 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2726 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());
2727 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
2730 Ok((msgs::CommitmentSigned {
2731 channel_id: self.channel_id,
2733 htlc_signatures: htlc_sigs,
2734 }, remote_commitment_tx))
2737 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
2738 /// to send to the remote peer in one go.
2739 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
2741 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> {
2742 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
2743 Some(update_add_htlc) => {
2744 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2745 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
2751 /// Begins the shutdown process, getting a message for the remote peer and returning all
2752 /// holding cell HTLCs for payment failure.
2753 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), HandleError> {
2754 for htlc in self.pending_outbound_htlcs.iter() {
2755 if htlc.state == OutboundHTLCState::LocalAnnounced {
2756 return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", action: None});
2759 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
2760 return Err(HandleError{err: "Shutdown already in progress", action: None});
2762 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2763 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2764 return Err(HandleError{err: "Cannot begin shutdown while peer is disconnected, maybe force-close instead?", action: None});
2767 let our_closing_script = self.get_closing_scriptpubkey();
2769 // From here on out, we may not fail!
2770 if self.channel_state < ChannelState::FundingSent as u32 {
2771 self.channel_state = ChannelState::ShutdownComplete as u32;
2773 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2775 self.channel_update_count += 1;
2777 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2778 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2779 // cell HTLCs and return them to fail the payment.
2780 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2781 self.holding_cell_htlc_updates.retain(|htlc_update| {
2783 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2784 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2791 Ok((msgs::Shutdown {
2792 channel_id: self.channel_id,
2793 scriptpubkey: our_closing_script,
2794 }, dropped_outbound_htlcs))
2797 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
2798 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
2799 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
2800 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
2801 /// immediately (others we will have to allow to time out).
2802 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
2803 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
2805 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
2806 // return them to fail the payment.
2807 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2808 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
2810 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
2811 dropped_outbound_htlcs.push((source, payment_hash));
2817 for _htlc in self.pending_outbound_htlcs.drain(..) {
2818 //TODO: Do something with the remaining HTLCs
2819 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
2823 self.channel_state = ChannelState::ShutdownComplete as u32;
2824 self.channel_update_count += 1;
2825 let mut res = Vec::new();
2826 mem::swap(&mut res, &mut self.last_local_commitment_txn);
2827 (res, dropped_outbound_htlcs)
2833 use bitcoin::util::hash::Sha256dHash;
2834 use bitcoin::util::bip143;
2835 use bitcoin::network::serialize::serialize;
2836 use bitcoin::blockdata::script::Script;
2837 use bitcoin::blockdata::transaction::Transaction;
2839 use ln::channelmanager::HTLCSource;
2840 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
2841 use ln::channel::MAX_FUNDING_SATOSHIS;
2843 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
2844 use chain::transaction::OutPoint;
2845 use util::test_utils;
2846 use util::logger::Logger;
2847 use secp256k1::{Secp256k1,Message,Signature};
2848 use secp256k1::key::{SecretKey,PublicKey};
2849 use crypto::sha2::Sha256;
2850 use crypto::digest::Digest;
2853 struct TestFeeEstimator {
2856 impl FeeEstimator for TestFeeEstimator {
2857 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
2863 fn test_max_funding_satoshis() {
2864 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
2865 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
2869 fn outbound_commitment_test() {
2870 // Test vectors from BOLT 3 Appendix C:
2871 let feeest = TestFeeEstimator{fee_est: 15000};
2872 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2873 let secp_ctx = Secp256k1::new();
2875 let chan_keys = ChannelKeys {
2876 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
2877 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2878 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
2879 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2881 // These aren't set in the test vectors:
2882 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2883 channel_close_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2884 channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2885 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],
2887 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
2888 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
2890 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
2891 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
2892 chan.their_to_self_delay = 144;
2893 chan.our_dust_limit_satoshis = 546;
2895 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
2896 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
2898 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
2899 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
2900 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2902 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
2903 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
2904 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
2906 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
2907 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
2908 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2910 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
2912 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
2913 // derived from a commitment_seed, so instead we copy it here and call
2914 // build_commitment_transaction.
2915 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
2916 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
2917 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
2918 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
2919 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();
2921 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
2923 macro_rules! test_commitment {
2924 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
2925 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false);
2926 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2927 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();
2928 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
2930 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
2932 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
2933 hex::decode($tx_hex).unwrap()[..]);
2937 macro_rules! test_htlc_output {
2938 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
2939 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2941 let ref htlc = unsigned_tx.1[$htlc_idx];
2942 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys);
2943 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2944 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2945 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
2947 let mut preimage: Option<[u8; 32]> = None;
2950 let mut sha = Sha256::new();
2951 sha.input(&[i; 32]);
2953 let mut out = [0; 32];
2954 sha.result(&mut out);
2956 if out == htlc.payment_hash {
2957 preimage = Some([i; 32]);
2961 assert!(preimage.is_some());
2964 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
2965 assert_eq!(serialize(&htlc_tx).unwrap()[..],
2966 hex::decode($tx_hex).unwrap()[..]);
2971 // simple commitment tx with no HTLCs
2972 chan.value_to_self_msat = 7000000000;
2974 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
2975 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
2976 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2979 chan.pending_inbound_htlcs.push({
2980 let mut out = InboundHTLCOutput{
2982 amount_msat: 1000000,
2984 payment_hash: [0; 32],
2985 state: InboundHTLCState::Committed,
2986 local_removed_fulfilled: false,
2987 pending_forward_state: None,
2989 let mut sha = Sha256::new();
2990 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
2991 sha.result(&mut out.payment_hash);
2994 chan.pending_inbound_htlcs.push({
2995 let mut out = InboundHTLCOutput{
2997 amount_msat: 2000000,
2999 payment_hash: [0; 32],
3000 state: InboundHTLCState::Committed,
3001 local_removed_fulfilled: false,
3002 pending_forward_state: None,
3004 let mut sha = Sha256::new();
3005 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3006 sha.result(&mut out.payment_hash);
3009 chan.pending_outbound_htlcs.push({
3010 let mut out = OutboundHTLCOutput{
3012 amount_msat: 2000000,
3014 payment_hash: [0; 32],
3015 state: OutboundHTLCState::Committed,
3016 source: HTLCSource::dummy(),
3019 let mut sha = Sha256::new();
3020 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3021 sha.result(&mut out.payment_hash);
3024 chan.pending_outbound_htlcs.push({
3025 let mut out = OutboundHTLCOutput{
3027 amount_msat: 3000000,
3029 payment_hash: [0; 32],
3030 state: OutboundHTLCState::Committed,
3031 source: HTLCSource::dummy(),
3034 let mut sha = Sha256::new();
3035 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
3036 sha.result(&mut out.payment_hash);
3039 chan.pending_inbound_htlcs.push({
3040 let mut out = InboundHTLCOutput{
3042 amount_msat: 4000000,
3044 payment_hash: [0; 32],
3045 state: InboundHTLCState::Committed,
3046 local_removed_fulfilled: false,
3047 pending_forward_state: None,
3049 let mut sha = Sha256::new();
3050 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
3051 sha.result(&mut out.payment_hash);
3056 // commitment tx with all five HTLCs untrimmed (minimum feerate)
3057 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3058 chan.feerate_per_kw = 0;
3060 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
3061 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
3062 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3064 assert_eq!(unsigned_tx.1.len(), 5);
3066 test_htlc_output!(0,
3067 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
3068 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
3069 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3071 test_htlc_output!(1,
3072 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
3073 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
3074 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3076 test_htlc_output!(2,
3077 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
3078 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
3079 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3081 test_htlc_output!(3,
3082 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
3083 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
3084 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3086 test_htlc_output!(4,
3087 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
3088 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
3089 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3093 // commitment tx with seven outputs untrimmed (maximum feerate)
3094 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3095 chan.feerate_per_kw = 647;
3097 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
3098 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
3099 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3101 assert_eq!(unsigned_tx.1.len(), 5);
3103 test_htlc_output!(0,
3104 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
3105 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
3106 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3108 test_htlc_output!(1,
3109 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
3110 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
3111 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3113 test_htlc_output!(2,
3114 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
3115 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
3116 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3118 test_htlc_output!(3,
3119 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
3120 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
3121 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3123 test_htlc_output!(4,
3124 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
3125 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
3126 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3130 // commitment tx with six outputs untrimmed (minimum feerate)
3131 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3132 chan.feerate_per_kw = 648;
3134 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
3135 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
3136 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3138 assert_eq!(unsigned_tx.1.len(), 4);
3140 test_htlc_output!(0,
3141 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
3142 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
3143 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3145 test_htlc_output!(1,
3146 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
3147 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
3148 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3150 test_htlc_output!(2,
3151 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
3152 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
3153 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3155 test_htlc_output!(3,
3156 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
3157 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
3158 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3162 // commitment tx with six outputs untrimmed (maximum feerate)
3163 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3164 chan.feerate_per_kw = 2069;
3166 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
3167 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
3168 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3170 assert_eq!(unsigned_tx.1.len(), 4);
3172 test_htlc_output!(0,
3173 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
3174 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
3175 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3177 test_htlc_output!(1,
3178 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
3179 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
3180 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3182 test_htlc_output!(2,
3183 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
3184 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
3185 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3187 test_htlc_output!(3,
3188 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
3189 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
3190 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3194 // commitment tx with five outputs untrimmed (minimum feerate)
3195 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3196 chan.feerate_per_kw = 2070;
3198 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
3199 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
3200 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3202 assert_eq!(unsigned_tx.1.len(), 3);
3204 test_htlc_output!(0,
3205 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
3206 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
3207 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3209 test_htlc_output!(1,
3210 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
3211 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
3212 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3214 test_htlc_output!(2,
3215 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
3216 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
3217 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3221 // commitment tx with five outputs untrimmed (maximum feerate)
3222 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3223 chan.feerate_per_kw = 2194;
3225 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
3226 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
3227 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3229 assert_eq!(unsigned_tx.1.len(), 3);
3231 test_htlc_output!(0,
3232 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
3233 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
3234 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3236 test_htlc_output!(1,
3237 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
3238 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
3239 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3241 test_htlc_output!(2,
3242 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
3243 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
3244 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3248 // commitment tx with four outputs untrimmed (minimum feerate)
3249 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3250 chan.feerate_per_kw = 2195;
3252 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
3253 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
3254 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3256 assert_eq!(unsigned_tx.1.len(), 2);
3258 test_htlc_output!(0,
3259 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
3260 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
3261 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3263 test_htlc_output!(1,
3264 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
3265 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
3266 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3270 // commitment tx with four outputs untrimmed (maximum feerate)
3271 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3272 chan.feerate_per_kw = 3702;
3274 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
3275 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
3276 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3278 assert_eq!(unsigned_tx.1.len(), 2);
3280 test_htlc_output!(0,
3281 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
3282 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
3283 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3285 test_htlc_output!(1,
3286 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
3287 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
3288 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3292 // commitment tx with three outputs untrimmed (minimum feerate)
3293 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3294 chan.feerate_per_kw = 3703;
3296 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
3297 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
3298 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3300 assert_eq!(unsigned_tx.1.len(), 1);
3302 test_htlc_output!(0,
3303 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
3304 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
3305 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3309 // commitment tx with three outputs untrimmed (maximum feerate)
3310 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3311 chan.feerate_per_kw = 4914;
3313 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
3314 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
3315 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3317 assert_eq!(unsigned_tx.1.len(), 1);
3319 test_htlc_output!(0,
3320 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
3321 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
3322 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3326 // commitment tx with two outputs untrimmed (minimum feerate)
3327 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3328 chan.feerate_per_kw = 4915;
3330 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
3331 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
3332 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3334 assert_eq!(unsigned_tx.1.len(), 0);
3338 // commitment tx with two outputs untrimmed (maximum feerate)
3339 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3340 chan.feerate_per_kw = 9651180;
3342 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
3343 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
3344 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3346 assert_eq!(unsigned_tx.1.len(), 0);
3350 // commitment tx with one output untrimmed (minimum feerate)
3351 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3352 chan.feerate_per_kw = 9651181;
3354 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3355 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3356 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3358 assert_eq!(unsigned_tx.1.len(), 0);
3362 // commitment tx with fee greater than funder amount
3363 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3364 chan.feerate_per_kw = 9651936;
3366 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3367 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3368 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3370 assert_eq!(unsigned_tx.1.len(), 0);
3375 fn test_per_commitment_secret_gen() {
3376 // Test vectors from BOLT 3 Appendix D:
3378 let mut seed = [0; 32];
3379 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3380 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3381 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
3383 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
3384 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3385 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
3387 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
3388 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
3390 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
3391 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
3393 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3394 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
3395 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
3399 fn test_key_derivation() {
3400 // Test vectors from BOLT 3 Appendix E:
3401 let secp_ctx = Secp256k1::new();
3403 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
3404 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3406 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
3407 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
3409 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3410 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
3412 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3413 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
3415 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
3416 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
3418 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3419 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
3421 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
3422 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());