1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::{Sha256dHash, Hash160};
6 use bitcoin::util::bip143;
7 use bitcoin::network::serialize::BitcoinHash;
9 use secp256k1::key::{PublicKey,SecretKey};
10 use secp256k1::{Secp256k1,Message,Signature};
13 use crypto::digest::Digest;
14 use crypto::hkdf::{hkdf_extract,hkdf_expand};
17 use ln::msgs::{ErrorAction, HandleError, RAACommitmentOrder};
18 use ln::channelmonitor::ChannelMonitor;
19 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, PendingForwardHTLCInfo, HTLCFailReason, HTLCFailureMsg};
20 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
22 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
23 use chain::transaction::OutPoint;
24 use util::{transaction_utils,rng};
25 use util::ser::Writeable;
26 use util::sha2::Sha256;
27 use util::logger::Logger;
28 use util::errors::APIError;
31 use std::default::Default;
33 use std::time::Instant;
36 pub struct ChannelKeys {
37 pub funding_key: SecretKey,
38 pub revocation_base_key: SecretKey,
39 pub payment_base_key: SecretKey,
40 pub delayed_payment_base_key: SecretKey,
41 pub htlc_base_key: SecretKey,
42 pub channel_close_key: SecretKey,
43 pub channel_monitor_claim_key: SecretKey,
44 pub commitment_seed: [u8; 32],
48 pub struct ChannelValueStat {
49 pub value_to_self_msat: u64,
50 pub channel_value_msat: u64,
51 pub channel_reserve_msat: u64,
52 pub pending_outbound_htlcs_amount_msat: u64,
53 pub pending_inbound_htlcs_amount_msat: u64,
54 pub holding_cell_outbound_amount_msat: u64,
55 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
59 pub fn new_from_seed(seed: &[u8; 32]) -> Result<ChannelKeys, secp256k1::Error> {
60 let mut prk = [0; 32];
61 hkdf_extract(Sha256::new(), b"rust-lightning key gen salt", seed, &mut prk);
62 let secp_ctx = Secp256k1::without_caps();
64 let mut okm = [0; 32];
65 hkdf_expand(Sha256::new(), &prk, b"rust-lightning funding key info", &mut okm);
66 let funding_key = SecretKey::from_slice(&secp_ctx, &okm)?;
68 hkdf_expand(Sha256::new(), &prk, b"rust-lightning revocation base key info", &mut okm);
69 let revocation_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
71 hkdf_expand(Sha256::new(), &prk, b"rust-lightning payment base key info", &mut okm);
72 let payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
74 hkdf_expand(Sha256::new(), &prk, b"rust-lightning delayed payment base key info", &mut okm);
75 let delayed_payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
77 hkdf_expand(Sha256::new(), &prk, b"rust-lightning htlc base key info", &mut okm);
78 let htlc_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
80 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel close key info", &mut okm);
81 let channel_close_key = SecretKey::from_slice(&secp_ctx, &okm)?;
83 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel monitor claim key info", &mut okm);
84 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &okm)?;
86 hkdf_expand(Sha256::new(), &prk, b"rust-lightning local commitment seed info", &mut okm);
89 funding_key: funding_key,
90 revocation_base_key: revocation_base_key,
91 payment_base_key: payment_base_key,
92 delayed_payment_base_key: delayed_payment_base_key,
93 htlc_base_key: htlc_base_key,
94 channel_close_key: channel_close_key,
95 channel_monitor_claim_key: channel_monitor_claim_key,
101 enum InboundHTLCRemovalReason {
102 FailRelay(msgs::OnionErrorPacket),
103 FailMalformed(([u8; 32], u16)),
107 enum InboundHTLCState {
108 /// Added by remote, to be included in next local commitment tx.
109 RemoteAnnounced(PendingHTLCStatus),
110 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
111 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112 /// accept this HTLC. Implies AwaitingRemoteRevoke.
113 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
114 /// a remote revoke_and_ack on a previous state before we can do so.
115 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
116 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
117 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118 /// accept this HTLC. Implies AwaitingRemoteRevoke.
119 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
121 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
123 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
124 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
126 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
127 /// commitment transaction without it as otherwise we'll have to force-close the channel to
128 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
129 /// anyway). That said, ChannelMonitor does this for us (see
130 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
131 /// local state before then, once we're sure that the next commitment_signed and
132 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
133 LocalRemoved(InboundHTLCRemovalReason),
136 struct InboundHTLCOutput {
140 payment_hash: [u8; 32],
141 state: InboundHTLCState,
144 enum OutboundHTLCState {
145 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
146 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
147 /// we will promote to Committed (note that they may not accept it until the next time we
148 /// revoke, but we dont really care about that:
149 /// * they've revoked, so worst case we can announce an old state and get our (option on)
150 /// money back (though we wont), and,
151 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
152 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
153 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
154 /// we'll never get out of sync).
155 /// Note that we Box the OnionPacket as its rather large and we don't want to blow up
156 /// OutboundHTLCOutput's size just for a temporary bit
157 LocalAnnounced(Box<msgs::OnionPacket>),
159 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
160 /// the change (though they'll need to revoke before we fail the payment).
162 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
163 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
164 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
165 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
166 /// remote revoke_and_ack on a previous state before we can do so.
167 AwaitingRemoteRevokeToRemove,
168 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
169 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
170 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
171 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
172 /// revoke_and_ack to drop completely.
173 AwaitingRemovedRemoteRevoke,
176 struct OutboundHTLCOutput {
180 payment_hash: [u8; 32],
181 state: OutboundHTLCState,
183 /// If we're in a removed state, set if they failed, otherwise None
184 fail_reason: Option<HTLCFailReason>,
187 macro_rules! get_htlc_in_commitment {
188 ($htlc: expr, $offered: expr) => {
189 HTLCOutputInCommitment {
191 amount_msat: $htlc.amount_msat,
192 cltv_expiry: $htlc.cltv_expiry,
193 payment_hash: $htlc.payment_hash,
194 transaction_output_index: 0
199 /// See AwaitingRemoteRevoke ChannelState for more info
200 enum HTLCUpdateAwaitingACK {
205 payment_hash: [u8; 32],
207 onion_routing_packet: msgs::OnionPacket,
208 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
211 payment_preimage: [u8; 32],
216 err_packet: msgs::OnionErrorPacket,
220 /// There are a few "states" and then a number of flags which can be applied:
221 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
222 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
223 /// move on to ChannelFunded.
224 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
225 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
226 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
228 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
229 OurInitSent = (1 << 0),
230 /// Implies we have received their open_channel/accept_channel message
231 TheirInitSent = (1 << 1),
232 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
233 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
234 /// upon receipt of funding_created, so simply skip this state.
236 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
237 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
238 /// and our counterparty consider the funding transaction confirmed.
240 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
241 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
242 TheirFundingLocked = (1 << 4),
243 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
244 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
245 OurFundingLocked = (1 << 5),
247 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
248 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
250 PeerDisconnected = (1 << 7),
251 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
252 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
253 /// messages as then we will be unable to determine which HTLCs they included in their
254 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
256 /// Flag is set on ChannelFunded.
257 AwaitingRemoteRevoke = (1 << 8),
258 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
259 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
260 /// to respond with our own shutdown message when possible.
261 RemoteShutdownSent = (1 << 9),
262 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
263 /// point, we may not add any new HTLCs to the channel.
264 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
265 /// us their shutdown.
266 LocalShutdownSent = (1 << 10),
267 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
268 /// to drop us, but we store this anyway.
269 ShutdownComplete = 2048,
271 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
272 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32);
274 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
276 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
277 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
278 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
280 pub(super) struct Channel {
283 channel_id: [u8; 32],
285 channel_outbound: bool,
286 secp_ctx: Secp256k1<secp256k1::All>,
287 announce_publicly: bool,
288 channel_value_satoshis: u64,
290 local_keys: ChannelKeys,
292 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
293 // generation start at 0 and count up...this simplifies some parts of implementation at the
294 // cost of others, but should really just be changed.
296 cur_local_commitment_transaction_number: u64,
297 cur_remote_commitment_transaction_number: u64,
298 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
299 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
300 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
301 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
302 /// remote revoke when we received the latest commitment update from the remote we have to make
303 /// sure that commitment update gets resent first.
304 received_commitment_while_awaiting_raa: bool,
305 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
306 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
307 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
309 // pending_update_fee is filled when sending and receiving update_fee
310 // For outbound channel, feerate_per_kw is updated with the value from
311 // pending_update_fee when revoke_and_ack is received
313 // For inbound channel, feerate_per_kw is updated when it receives
314 // commitment_signed and revoke_and_ack is generated
315 // The pending value is kept when another pair of update_fee and commitment_signed
316 // is received during AwaitingRemoteRevoke and relieved when the expected
317 // revoke_and_ack is received and new commitment_signed is generated to be
318 // sent to the funder. Otherwise, the pending value is removed when receiving
319 // commitment_signed.
320 pending_update_fee: Option<u64>,
321 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
322 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
323 // is received. holding_cell_update_fee is updated when there are additional
324 // update_fee() during ChannelState::AwaitingRemoteRevoke.
325 holding_cell_update_fee: Option<u64>,
326 next_local_htlc_id: u64,
327 next_remote_htlc_id: u64,
328 channel_update_count: u32,
331 #[cfg(debug_assertions)]
332 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
333 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
334 #[cfg(debug_assertions)]
335 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
336 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
339 // Used in ChannelManager's tests to send a revoked transaction
340 pub last_local_commitment_txn: Vec<Transaction>,
342 last_local_commitment_txn: Vec<Transaction>,
344 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
346 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
347 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
348 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
349 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
350 funding_tx_confirmed_in: Option<Sha256dHash>,
351 short_channel_id: Option<u64>,
352 /// Used to deduplicate block_connected callbacks
353 last_block_connected: Sha256dHash,
354 funding_tx_confirmations: u64,
356 their_dust_limit_satoshis: u64,
357 our_dust_limit_satoshis: u64,
358 their_max_htlc_value_in_flight_msat: u64,
359 //get_our_max_htlc_value_in_flight_msat(): u64,
360 /// minimum channel reserve for **self** to maintain - set by them.
361 their_channel_reserve_satoshis: u64,
362 //get_our_channel_reserve_satoshis(): u64,
363 their_htlc_minimum_msat: u64,
364 our_htlc_minimum_msat: u64,
365 their_to_self_delay: u16,
366 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
367 their_max_accepted_htlcs: u16,
368 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
370 their_funding_pubkey: Option<PublicKey>,
371 their_revocation_basepoint: Option<PublicKey>,
372 their_payment_basepoint: Option<PublicKey>,
373 their_delayed_payment_basepoint: Option<PublicKey>,
374 their_htlc_basepoint: Option<PublicKey>,
375 their_cur_commitment_point: Option<PublicKey>,
377 their_prev_commitment_point: Option<PublicKey>,
378 their_node_id: PublicKey,
380 their_shutdown_scriptpubkey: Option<Script>,
382 channel_monitor: ChannelMonitor,
387 const OUR_MAX_HTLCS: u16 = 5; //TODO
388 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
389 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
390 /// really allow for this, so instead we're stuck closing it out at that point.
391 const UNCONF_THRESHOLD: u32 = 6;
392 /// The amount of time we require our counterparty wait to claim their money (ie time between when
393 /// we, or our watchtower, must check for them having broadcast a theft transaction).
394 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
395 /// The amount of time we're willing to wait to claim money back to us
396 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
397 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
398 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
399 const SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT: u64 = 79; // prevout: 36, nSequence: 4, script len: 1, witness lengths: (3+1)/4, sig: 73/4, if-selector: 1, redeemScript: (6 ops + 2*33 pubkeys + 1*2 delay)/4
400 const B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT: u64 = 104; // prevout: 40, nSequence: 4, script len: 1, witness lengths: 3/4, sig: 73/4, pubkey: 33/4, output: 31 (TODO: Wrong? Useless?)
401 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
403 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
405 /// Used to return a simple Error back to ChannelManager. Will get converted to a
406 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
407 /// channel_id in ChannelManager.
408 pub(super) enum ChannelError {
409 Ignore(&'static str),
413 macro_rules! secp_call {
414 ( $res: expr, $err: expr, $chan_id: expr ) => {
417 Err(_) => return Err(HandleError {err: $err, action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: $chan_id, data: $err.to_string()}})})
422 macro_rules! secp_derived_key {
423 ( $res: expr, $chan_id: expr ) => {
424 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters", $chan_id)
428 // Convert constants + channel value to limits:
429 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
430 channel_value_satoshis * 1000 / 10 //TODO
433 /// Returns a minimum channel reserve value **they** need to maintain
435 /// Guaranteed to return a value no larger than channel_value_satoshis
436 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
437 let (q, _) = channel_value_satoshis.overflowing_div(100);
438 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
441 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
442 at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000 //TODO
445 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
449 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
450 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
452 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
456 fn derive_maximum_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
457 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
462 pub fn new_outbound(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, announce_publicly: bool, user_id: u64, logger: Arc<Logger>) -> Result<Channel, APIError> {
463 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
464 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
467 if push_msat > channel_value_satoshis * 1000 {
468 return Err(APIError::APIMisuseError{err: "push value > channel value"});
472 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
473 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
474 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
477 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
479 let secp_ctx = Secp256k1::new();
480 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
481 let our_channel_monitor_claim_script = Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script();
482 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
483 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
484 &chan_keys.htlc_base_key,
485 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
490 channel_id: rng::rand_u832(),
491 channel_state: ChannelState::OurInitSent as u32,
492 channel_outbound: true,
494 announce_publicly: announce_publicly,
495 channel_value_satoshis: channel_value_satoshis,
497 local_keys: chan_keys,
498 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
499 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
500 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
501 received_commitment_while_awaiting_raa: false,
503 pending_inbound_htlcs: Vec::new(),
504 pending_outbound_htlcs: Vec::new(),
505 holding_cell_htlc_updates: Vec::new(),
506 pending_update_fee: None,
507 holding_cell_update_fee: None,
508 next_local_htlc_id: 0,
509 next_remote_htlc_id: 0,
510 channel_update_count: 1,
512 #[cfg(debug_assertions)]
513 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
514 #[cfg(debug_assertions)]
515 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
517 last_local_commitment_txn: Vec::new(),
519 last_sent_closing_fee: None,
521 funding_tx_confirmed_in: None,
522 short_channel_id: None,
523 last_block_connected: Default::default(),
524 funding_tx_confirmations: 0,
526 feerate_per_kw: feerate,
527 their_dust_limit_satoshis: 0,
528 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
529 their_max_htlc_value_in_flight_msat: 0,
530 their_channel_reserve_satoshis: 0,
531 their_htlc_minimum_msat: 0,
532 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
533 their_to_self_delay: 0,
534 their_max_accepted_htlcs: 0,
536 their_funding_pubkey: None,
537 their_revocation_basepoint: None,
538 their_payment_basepoint: None,
539 their_delayed_payment_basepoint: None,
540 their_htlc_basepoint: None,
541 their_cur_commitment_point: None,
543 their_prev_commitment_point: None,
544 their_node_id: their_node_id,
546 their_shutdown_scriptpubkey: None,
548 channel_monitor: channel_monitor,
554 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
555 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
556 return Err(ChannelError::Close("Peer's feerate much too low"));
558 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
559 return Err(ChannelError::Close("Peer's feerate much too high"));
564 /// Creates a new channel from a remote sides' request for one.
565 /// Assumes chain_hash has already been checked and corresponds with what we expect!
566 pub fn new_from_req(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, require_announce: bool, allow_announce: bool, logger: Arc<Logger>) -> Result<Channel, ChannelError> {
567 // Check sanity of message fields:
568 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
569 return Err(ChannelError::Close("funding value > 2^24"));
571 if msg.channel_reserve_satoshis > msg.funding_satoshis {
572 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
574 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
575 return Err(ChannelError::Close("push_msat larger than funding value"));
577 if msg.dust_limit_satoshis > msg.funding_satoshis {
578 return Err(ChannelError::Close("Peer never wants payout outputs?"));
580 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
581 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
583 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
584 return Err(ChannelError::Close("Miminum htlc value is full channel value"));
586 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
588 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
589 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
591 if msg.max_accepted_htlcs < 1 {
592 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
594 if msg.max_accepted_htlcs > 483 {
595 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
598 // Convert things into internal flags and prep our state:
600 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
601 if require_announce && !their_announce {
602 return Err(ChannelError::Close("Peer tried to open unannounced channel, but we require public ones"));
604 if !allow_announce && their_announce {
605 return Err(ChannelError::Close("Peer tried to open announced channel, but we require private ones"));
608 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
610 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
611 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
612 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
613 return Err(ChannelError::Close("Suitalbe channel reserve not found. aborting"));
615 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
616 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
618 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
619 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
622 // check if the funder's amount for the initial commitment tx is sufficient
623 // for full fee payment
624 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
625 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
626 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
629 let to_local_msat = msg.push_msat;
630 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
631 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
632 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
635 let secp_ctx = Secp256k1::new();
636 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).serialize());
637 let our_channel_monitor_claim_script = Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script();
638 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
639 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key),
640 &chan_keys.htlc_base_key,
641 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
642 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
643 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
645 let mut chan = Channel {
648 channel_id: msg.temporary_channel_id,
649 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
650 channel_outbound: false,
652 announce_publicly: their_announce,
654 local_keys: chan_keys,
655 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
656 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
657 value_to_self_msat: msg.push_msat,
658 received_commitment_while_awaiting_raa: false,
660 pending_inbound_htlcs: Vec::new(),
661 pending_outbound_htlcs: Vec::new(),
662 holding_cell_htlc_updates: Vec::new(),
663 pending_update_fee: None,
664 holding_cell_update_fee: None,
665 next_local_htlc_id: 0,
666 next_remote_htlc_id: 0,
667 channel_update_count: 1,
669 #[cfg(debug_assertions)]
670 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
671 #[cfg(debug_assertions)]
672 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
674 last_local_commitment_txn: Vec::new(),
676 last_sent_closing_fee: None,
678 funding_tx_confirmed_in: None,
679 short_channel_id: None,
680 last_block_connected: Default::default(),
681 funding_tx_confirmations: 0,
683 feerate_per_kw: msg.feerate_per_kw as u64,
684 channel_value_satoshis: msg.funding_satoshis,
685 their_dust_limit_satoshis: msg.dust_limit_satoshis,
686 our_dust_limit_satoshis: our_dust_limit_satoshis,
687 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
688 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
689 their_htlc_minimum_msat: msg.htlc_minimum_msat,
690 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
691 their_to_self_delay: msg.to_self_delay,
692 their_max_accepted_htlcs: msg.max_accepted_htlcs,
694 their_funding_pubkey: Some(msg.funding_pubkey),
695 their_revocation_basepoint: Some(msg.revocation_basepoint),
696 their_payment_basepoint: Some(msg.payment_basepoint),
697 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
698 their_htlc_basepoint: Some(msg.htlc_basepoint),
699 their_cur_commitment_point: Some(msg.first_per_commitment_point),
701 their_prev_commitment_point: None,
702 their_node_id: their_node_id,
704 their_shutdown_scriptpubkey: None,
706 channel_monitor: channel_monitor,
711 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
712 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
717 // Utilities to derive keys:
719 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
720 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
721 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
724 // Utilities to build transactions:
726 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
727 let mut sha = Sha256::new();
728 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
730 if self.channel_outbound {
731 sha.input(&our_payment_basepoint.serialize());
732 sha.input(&self.their_payment_basepoint.unwrap().serialize());
734 sha.input(&self.their_payment_basepoint.unwrap().serialize());
735 sha.input(&our_payment_basepoint.serialize());
737 let mut res = [0; 32];
738 sha.result(&mut res);
740 ((res[26] as u64) << 5*8) |
741 ((res[27] as u64) << 4*8) |
742 ((res[28] as u64) << 3*8) |
743 ((res[29] as u64) << 2*8) |
744 ((res[30] as u64) << 1*8) |
745 ((res[31] as u64) << 0*8)
748 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
749 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
750 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
751 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
752 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
754 /// @local is used only to convert relevant internal structures which refer to remote vs local
755 /// to decide value of outputs and direction of HTLCs.
756 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
757 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
758 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
759 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
760 /// which peer generated this transaction and "to whom" this transaction flows.
762 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, Vec<HTLCOutputInCommitment>) {
763 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
766 let mut ins: Vec<TxIn> = Vec::new();
768 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
769 script_sig: Script::new(),
770 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
776 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
778 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
779 let mut remote_htlc_total_msat = 0;
780 let mut local_htlc_total_msat = 0;
781 let mut value_to_self_msat_offset = 0;
783 macro_rules! add_htlc_output {
784 ($htlc: expr, $outbound: expr) => {
785 if $outbound == local { // "offered HTLC output"
786 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
787 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
789 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
790 value: $htlc.amount_msat / 1000
791 }, Some(htlc_in_tx)));
794 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
795 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
796 txouts.push((TxOut { // "received HTLC output"
797 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
798 value: $htlc.amount_msat / 1000
799 }, Some(htlc_in_tx)));
805 for ref htlc in self.pending_inbound_htlcs.iter() {
806 let include = match htlc.state {
807 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
808 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
809 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
810 InboundHTLCState::Committed => true,
811 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
815 add_htlc_output!(htlc, false);
816 remote_htlc_total_msat += htlc.amount_msat;
819 &InboundHTLCState::LocalRemoved(ref reason) => {
820 if generated_by_local {
821 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
822 value_to_self_msat_offset += htlc.amount_msat as i64;
831 for ref htlc in self.pending_outbound_htlcs.iter() {
832 let include = match htlc.state {
833 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
834 OutboundHTLCState::Committed => true,
835 OutboundHTLCState::RemoteRemoved => generated_by_local,
836 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
837 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
841 add_htlc_output!(htlc, true);
842 local_htlc_total_msat += htlc.amount_msat;
845 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
846 if htlc.fail_reason.is_none() {
847 value_to_self_msat_offset -= htlc.amount_msat as i64;
850 OutboundHTLCState::RemoteRemoved => {
851 if !generated_by_local && htlc.fail_reason.is_none() {
852 value_to_self_msat_offset -= htlc.amount_msat as i64;
861 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
862 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset;
864 #[cfg(debug_assertions)]
866 // Make sure that the to_self/to_remote is always either past the appropriate
867 // channel_reserve *or* it is making progress towards it.
868 // TODO: This should happen after fee calculation, but we don't handle that correctly
870 let mut max_commitment_tx_output = if generated_by_local {
871 self.max_commitment_tx_output_local.lock().unwrap()
873 self.max_commitment_tx_output_remote.lock().unwrap()
875 debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
876 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
877 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
878 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
881 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
882 let (value_to_self, value_to_remote) = if self.channel_outbound {
883 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
885 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
888 let value_to_a = if local { value_to_self } else { value_to_remote };
889 let value_to_b = if local { value_to_remote } else { value_to_self };
891 if value_to_a >= (dust_limit_satoshis as i64) {
893 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
894 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
895 &keys.a_delayed_payment_key).to_v0_p2wsh(),
896 value: value_to_a as u64
900 if value_to_b >= (dust_limit_satoshis as i64) {
902 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
903 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
905 value: value_to_b as u64
909 transaction_utils::sort_outputs(&mut txouts);
911 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
912 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
913 for (idx, out) in txouts.drain(..).enumerate() {
915 if let Some(out_htlc) = out.1 {
916 htlcs_used.push(out_htlc);
917 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
923 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
930 fn get_closing_scriptpubkey(&self) -> Script {
931 let our_channel_close_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.channel_close_key).serialize());
932 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
936 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
937 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
941 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
943 let mut ins: Vec<TxIn> = Vec::new();
945 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
946 script_sig: Script::new(),
947 sequence: 0xffffffff,
953 assert!(self.pending_inbound_htlcs.is_empty());
954 assert!(self.pending_outbound_htlcs.is_empty());
955 let mut txouts: Vec<(TxOut, ())> = Vec::new();
957 let mut total_fee_satoshis = proposed_total_fee_satoshis;
958 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
959 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
961 if value_to_self < 0 {
962 assert!(self.channel_outbound);
963 total_fee_satoshis += (-value_to_self) as u64;
964 } else if value_to_remote < 0 {
965 assert!(!self.channel_outbound);
966 total_fee_satoshis += (-value_to_remote) as u64;
969 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
971 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
972 value: value_to_remote as u64
976 if value_to_self as u64 > self.our_dust_limit_satoshis {
978 script_pubkey: self.get_closing_scriptpubkey(),
979 value: value_to_self as u64
983 transaction_utils::sort_outputs(&mut txouts);
985 let mut outputs: Vec<TxOut> = Vec::new();
986 for out in txouts.drain(..) {
995 }, total_fee_satoshis)
999 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1000 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1001 /// our counterparty!)
1002 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1003 /// TODO Some magic rust shit to compile-time check this?
1004 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
1005 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1006 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1007 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1009 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), self.channel_id()))
1013 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1014 /// will sign and send to our counterparty.
1015 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
1016 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1017 //may see payments to it!
1018 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1019 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1020 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1022 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), self.channel_id()))
1025 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1026 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1027 /// Panics if called before accept_channel/new_from_req
1028 pub fn get_funding_redeemscript(&self) -> Script {
1029 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1030 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1031 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1032 if our_funding_key[..] < their_funding_key[..] {
1033 builder.push_slice(&our_funding_key)
1034 .push_slice(&their_funding_key)
1036 builder.push_slice(&their_funding_key)
1037 .push_slice(&our_funding_key)
1038 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1041 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1042 if tx.input.len() != 1 {
1043 panic!("Tried to sign commitment transaction that had input count != 1!");
1045 if tx.input[0].witness.len() != 0 {
1046 panic!("Tried to re-sign commitment transaction");
1049 let funding_redeemscript = self.get_funding_redeemscript();
1051 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1052 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1054 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1056 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1057 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1058 if our_funding_key[..] < their_funding_key[..] {
1059 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1060 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1062 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1063 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1065 tx.input[0].witness[1].push(SigHashType::All as u8);
1066 tx.input[0].witness[2].push(SigHashType::All as u8);
1068 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1073 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1074 /// @local is used only to convert relevant internal structures which refer to remote vs local
1075 /// to decide value of outputs and direction of HTLCs.
1076 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1077 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1080 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
1081 if tx.input.len() != 1 {
1082 panic!("Tried to sign HTLC transaction that had input count != 1!");
1085 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1087 let our_htlc_key = secp_derived_key!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), self.channel_id());
1088 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1089 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1090 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1093 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1094 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1095 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
1096 if tx.input.len() != 1 {
1097 panic!("Tried to sign HTLC transaction that had input count != 1!");
1099 if tx.input[0].witness.len() != 0 {
1100 panic!("Tried to re-sign HTLC transaction");
1103 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1105 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1107 if local_tx { // b, then a
1108 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1109 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1111 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1112 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1114 tx.input[0].witness[1].push(SigHashType::All as u8);
1115 tx.input[0].witness[2].push(SigHashType::All as u8);
1118 tx.input[0].witness.push(Vec::new());
1120 tx.input[0].witness.push(preimage.unwrap().to_vec());
1123 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1128 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1129 /// debug_assertions are turned on
1130 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1131 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1132 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1133 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1135 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1136 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1138 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1140 let mut sha = Sha256::new();
1141 sha.input(&payment_preimage_arg);
1142 let mut payment_hash_calc = [0; 32];
1143 sha.result(&mut payment_hash_calc);
1145 let mut pending_idx = std::usize::MAX;
1146 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1147 if htlc.htlc_id == htlc_id_arg {
1148 assert_eq!(htlc.payment_hash, payment_hash_calc);
1149 if let InboundHTLCState::Committed = htlc.state {
1151 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1152 // Don't return in release mode here so that we can update channel_monitor
1158 if pending_idx == std::usize::MAX {
1159 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1160 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1163 // Now update local state:
1165 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1166 // can claim it even if the channel hits the chain before we see their next commitment.
1167 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1169 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1170 for pending_update in self.holding_cell_htlc_updates.iter() {
1171 match pending_update {
1172 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1173 if htlc_id_arg == htlc_id {
1174 debug_assert!(false, "Tried to fulfill an HTLC we already had a pending fulfill for");
1175 return Ok((None, None));
1178 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1179 if htlc_id_arg == htlc_id {
1180 debug_assert!(false, "Tried to fulfill an HTLC we already had a holding-cell failure on");
1181 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1187 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1188 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1190 return Ok((None, Some(self.channel_monitor.clone())));
1194 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1195 if let InboundHTLCState::Committed = htlc.state {
1197 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1198 return Ok((None, Some(self.channel_monitor.clone())));
1200 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1203 Ok((Some(msgs::UpdateFulfillHTLC {
1204 channel_id: self.channel_id(),
1205 htlc_id: htlc_id_arg,
1206 payment_preimage: payment_preimage_arg,
1207 }), Some(self.channel_monitor.clone())))
1210 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: [u8; 32]) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), HandleError> {
1211 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1212 (Some(update_fulfill_htlc), _) => {
1213 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1214 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1216 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1217 (None, None) => Ok((None, None))
1221 /// May return an IgnoreError, but should not, and will always return Ok(_) when
1222 /// debug_assertions are turned on
1223 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1224 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1225 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1227 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1229 let mut pending_idx = std::usize::MAX;
1230 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1231 if htlc.htlc_id == htlc_id_arg {
1232 if let InboundHTLCState::Committed = htlc.state {
1234 debug_assert!(false, "Have an inbound HTLC we tried to fail before it was fully committed to");
1235 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1240 if pending_idx == std::usize::MAX {
1241 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1242 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1245 // Now update local state:
1246 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32)) != 0 {
1247 for pending_update in self.holding_cell_htlc_updates.iter() {
1248 match pending_update {
1249 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1250 if htlc_id_arg == htlc_id {
1251 debug_assert!(false, "Unable to find a pending HTLC which matched the given HTLC ID");
1252 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given HTLC ID", action: Some(msgs::ErrorAction::IgnoreError)});
1255 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1256 if htlc_id_arg == htlc_id {
1257 debug_assert!(false, "Tried to fail an HTLC that we already had a pending failure for");
1264 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1265 htlc_id: htlc_id_arg,
1272 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1273 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1276 Ok(Some(msgs::UpdateFailHTLC {
1277 channel_id: self.channel_id(),
1278 htlc_id: htlc_id_arg,
1283 pub fn get_update_fail_htlc_and_commit(&mut self, htlc_id: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
1284 match self.get_update_fail_htlc(htlc_id, err_packet)? {
1285 Some(update_fail_htlc) => {
1286 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1287 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1293 // Message handlers:
1295 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), ChannelError> {
1296 // Check sanity of message fields:
1297 if !self.channel_outbound {
1298 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1300 if self.channel_state != ChannelState::OurInitSent as u32 {
1301 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1303 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1304 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1306 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1307 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1309 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1310 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1312 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1313 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1315 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1316 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1318 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1319 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1321 if msg.minimum_depth > Channel::derive_maximum_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) {
1322 return Err(ChannelError::Close("minimum_depth too large"));
1324 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1325 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1327 if msg.max_accepted_htlcs < 1 {
1328 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1330 if msg.max_accepted_htlcs > 483 {
1331 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1334 // TODO: Optional additional constraints mentioned in the spec
1335 // MAY fail the channel if
1336 // funding_satoshi is too small
1337 // htlc_minimum_msat too large
1338 // max_htlc_value_in_flight_msat too small
1339 // channel_reserve_satoshis too large
1340 // max_accepted_htlcs too small
1341 // dust_limit_satoshis too small
1343 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1345 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1346 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1347 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1348 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1349 self.their_to_self_delay = msg.to_self_delay;
1350 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1351 self.their_funding_pubkey = Some(msg.funding_pubkey);
1352 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1353 self.their_payment_basepoint = Some(msg.payment_basepoint);
1354 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1355 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1356 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1358 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1359 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1360 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1362 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1367 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1368 let funding_script = self.get_funding_redeemscript();
1370 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1371 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1372 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1374 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1375 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer", self.channel_id());
1377 let remote_keys = self.build_remote_transaction_keys()?;
1378 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1379 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1381 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1382 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key)))
1385 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1386 if self.channel_outbound {
1387 return Err(HandleError{err: "Received funding_created for an outbound channel?", action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: self.channel_id, data: "Received funding_created for an outbound channel?".to_string()}})});
1389 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1390 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1391 // remember the channel, so its safe to just send an error_message here and drop the
1393 return Err(HandleError{err: "Received funding_created after we got the channel!", action: Some(msgs::ErrorAction::SendErrorMessage {msg: msgs::ErrorMessage {channel_id: self.channel_id, data: "Received funding_created after we got the channel!".to_string()}})});
1395 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1396 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1397 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1398 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1401 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1402 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1403 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1405 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1408 self.channel_monitor.unset_funding_info();
1413 // Now that we're past error-generating stuff, update our local state:
1415 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1416 self.channel_state = ChannelState::FundingSent as u32;
1417 self.channel_id = funding_txo.to_channel_id();
1418 self.cur_remote_commitment_transaction_number -= 1;
1419 self.cur_local_commitment_transaction_number -= 1;
1421 Ok((msgs::FundingSigned {
1422 channel_id: self.channel_id,
1423 signature: our_signature
1424 }, self.channel_monitor.clone()))
1427 /// Handles a funding_signed message from the remote end.
1428 /// If this call is successful, broadcast the funding transaction (and not before!)
1429 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1430 if !self.channel_outbound {
1431 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1433 if self.channel_state != ChannelState::FundingCreated as u32 {
1434 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1436 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1437 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1438 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1439 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1442 let funding_script = self.get_funding_redeemscript();
1444 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1445 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1446 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1448 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1449 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer", self.channel_id());
1451 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1452 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1453 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1454 self.channel_state = ChannelState::FundingSent as u32;
1455 self.cur_local_commitment_transaction_number -= 1;
1457 Ok(self.channel_monitor.clone())
1460 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1461 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1462 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1464 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
1465 if non_shutdown_state == ChannelState::FundingSent as u32 {
1466 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1467 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1468 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
1469 self.channel_update_count += 1;
1470 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1471 // Note that funding_signed/funding_created will have decremented both by 1!
1472 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1473 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1474 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1475 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1477 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1480 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1483 self.their_prev_commitment_point = self.their_cur_commitment_point;
1484 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1488 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1489 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1490 let mut htlc_inbound_value_msat = 0;
1491 for ref htlc in self.pending_inbound_htlcs.iter() {
1492 htlc_inbound_value_msat += htlc.amount_msat;
1494 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1497 /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1498 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1499 let mut htlc_outbound_value_msat = 0;
1500 for ref htlc in self.pending_outbound_htlcs.iter() {
1501 htlc_outbound_value_msat += htlc.amount_msat;
1504 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1507 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), HandleError> {
1508 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1509 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1511 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1512 return Err(HandleError{err: "Peer sent update_add_htlc when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent update_add_htlc when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1514 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1515 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1517 if msg.amount_msat < self.our_htlc_minimum_msat {
1518 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1521 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1522 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1523 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1525 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1526 // Check our_max_htlc_value_in_flight_msat
1527 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1528 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1530 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1531 // the reserve_satoshis we told them to always have as direct payment so that they lose
1532 // something if we punish them for broadcasting an old state).
1533 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 {
1534 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1536 if self.next_remote_htlc_id != msg.htlc_id {
1537 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1539 if msg.cltv_expiry >= 500000000 {
1540 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1543 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1545 // Now update local state:
1546 self.next_remote_htlc_id += 1;
1547 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1548 htlc_id: msg.htlc_id,
1549 amount_msat: msg.amount_msat,
1550 payment_hash: msg.payment_hash,
1551 cltv_expiry: msg.cltv_expiry,
1552 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1558 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1560 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1561 for htlc in self.pending_outbound_htlcs.iter_mut() {
1562 if htlc.htlc_id == htlc_id {
1563 match check_preimage {
1565 Some(payment_hash) =>
1566 if payment_hash != htlc.payment_hash {
1567 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1571 OutboundHTLCState::LocalAnnounced(_) =>
1572 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1573 OutboundHTLCState::Committed => {
1574 htlc.state = OutboundHTLCState::RemoteRemoved;
1575 htlc.fail_reason = fail_reason;
1577 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1578 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1580 return Ok(&htlc.source);
1583 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1586 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<&HTLCSource, ChannelError> {
1587 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1588 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1590 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1591 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1594 let mut sha = Sha256::new();
1595 sha.input(&msg.payment_preimage);
1596 let mut payment_hash = [0; 32];
1597 sha.result(&mut payment_hash);
1599 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)
1602 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1603 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1604 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1606 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1607 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1610 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1613 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<&HTLCSource, ChannelError> {
1614 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1615 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1617 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1618 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1621 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1624 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1625 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1626 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1628 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1629 return Err(HandleError{err: "Peer sent commitment_signed when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent commitment_signed when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1632 let funding_script = self.get_funding_redeemscript();
1634 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1636 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1637 self.pending_update_fee.unwrap()
1642 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1643 let local_commitment_txid = local_commitment_tx.0.txid();
1644 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1645 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer", self.channel_id());
1647 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1648 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1651 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1652 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1653 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1655 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1656 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1657 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys, feerate_per_kw);
1658 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1659 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1660 secp_call!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx siganture from peer", self.channel_id());
1661 let htlc_sig = if htlc.offered {
1662 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1663 new_local_commitment_txn.push(htlc_tx);
1666 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1668 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1671 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1672 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1674 // Update state now that we've passed all the can-fail calls...
1675 let mut need_our_commitment = false;
1676 if !self.channel_outbound {
1677 if let Some(fee_update) = self.pending_update_fee {
1678 self.feerate_per_kw = fee_update;
1679 // We later use the presence of pending_update_fee to indicate we should generate a
1680 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1681 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1682 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1683 need_our_commitment = true;
1684 self.pending_update_fee = None;
1689 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1691 for htlc in self.pending_inbound_htlcs.iter_mut() {
1692 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1693 Some(forward_info.clone())
1695 if let Some(forward_info) = new_forward {
1696 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1697 need_our_commitment = true;
1700 for htlc in self.pending_outbound_htlcs.iter_mut() {
1701 if let OutboundHTLCState::RemoteRemoved = htlc.state {
1702 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1703 need_our_commitment = true;
1707 self.cur_local_commitment_transaction_number -= 1;
1708 self.last_local_commitment_txn = new_local_commitment_txn;
1709 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1711 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1712 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1713 // we'll send one right away when we get the revoke_and_ack when we
1714 // free_holding_cell_htlcs().
1715 let (msg, monitor) = self.send_commitment_no_status_check()?;
1716 (Some(msg), monitor)
1717 } else { (None, self.channel_monitor.clone()) };
1719 Ok((msgs::RevokeAndACK {
1720 channel_id: self.channel_id,
1721 per_commitment_secret: per_commitment_secret,
1722 next_per_commitment_point: next_per_commitment_point,
1723 }, our_commitment_signed, monitor_update))
1726 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1727 /// fulfilling or failing the last pending HTLC)
1728 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1729 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1730 let mut htlc_updates = Vec::new();
1731 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1732 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1733 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1734 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1736 for htlc_update in htlc_updates.drain(..) {
1737 // Note that this *can* fail, though it should be due to rather-rare conditions on
1738 // fee races with adding too many outputs which push our total payments just over
1739 // the limit. In case its less rare than I anticipate, we may want to revisit
1740 // handling this case better and maybe fufilling some of the HTLCs while attempting
1741 // to rebalance channels.
1742 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1743 self.holding_cell_htlc_updates.push(htlc_update);
1745 match &htlc_update {
1746 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref source, ref onion_routing_packet, ..} => {
1747 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1748 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1754 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, htlc_id, .. } => {
1755 match self.get_update_fulfill_htlc(htlc_id, payment_preimage) {
1756 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1758 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1760 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1765 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1766 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1767 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1769 if let Some(msgs::ErrorAction::IgnoreError) = e.action {}
1771 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1778 self.holding_cell_htlc_updates.push(htlc_update);
1782 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1783 //fail it back the route, if its a temporary issue we can ignore it...
1786 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1787 // This should never actually happen and indicates we got some Errs back
1788 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1789 // case there is some strange way to hit duplicate HTLC removes.
1792 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1793 self.pending_update_fee = self.holding_cell_update_fee.take();
1794 Some(msgs::UpdateFee {
1795 channel_id: self.channel_id,
1796 feerate_per_kw: feerate as u32,
1801 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1802 Ok(Some((msgs::CommitmentUpdate {
1804 update_fulfill_htlcs,
1806 update_fail_malformed_htlcs: Vec::new(),
1807 update_fee: update_fee,
1809 }, monitor_update)))
1818 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1819 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1820 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1821 /// generating an appropriate error *after* the channel state has been updated based on the
1822 /// revoke_and_ack message.
1823 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, [u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1824 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1825 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1827 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1828 return Err(HandleError{err: "Peer sent revoke_and_ack when we needed a channel_reestablish", action: Some(msgs::ErrorAction::SendErrorMessage{msg: msgs::ErrorMessage{data: "Peer sent revoke_and_ack when we needed a channel_reestablish".to_string(), channel_id: msg.channel_id}})});
1830 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1831 if PublicKey::from_secret_key(&self.secp_ctx, &secp_call!(SecretKey::from_slice(&self.secp_ctx, &msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret", self.channel_id())) != their_prev_commitment_point {
1832 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1835 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret, Some((self.cur_remote_commitment_transaction_number - 1, msg.next_per_commitment_point)))?;
1837 // Update state now that we've passed all the can-fail calls...
1838 // (note that we may still fail to generate the new commitment_signed message, but that's
1839 // OK, we step the channel here and *then* if the new generation fails we can fail the
1840 // channel based on that, but stepping stuff here should be safe either way.
1841 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1842 self.their_prev_commitment_point = self.their_cur_commitment_point;
1843 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1844 self.cur_remote_commitment_transaction_number -= 1;
1845 self.received_commitment_while_awaiting_raa = false;
1847 let mut to_forward_infos = Vec::new();
1848 let mut revoked_htlcs = Vec::new();
1849 let mut update_fail_htlcs = Vec::new();
1850 let mut update_fail_malformed_htlcs = Vec::new();
1851 let mut require_commitment = false;
1852 let mut value_to_self_msat_diff: i64 = 0;
1853 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1854 self.pending_inbound_htlcs.retain(|htlc| {
1855 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1856 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1857 value_to_self_msat_diff += htlc.amount_msat as i64;
1862 self.pending_outbound_htlcs.retain(|htlc| {
1863 if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1864 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1865 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1867 // They fulfilled, so we sent them money
1868 value_to_self_msat_diff -= htlc.amount_msat as i64;
1873 for htlc in self.pending_inbound_htlcs.iter_mut() {
1874 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1876 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1880 let mut state = InboundHTLCState::Committed;
1881 mem::swap(&mut state, &mut htlc.state);
1883 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1884 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1885 require_commitment = true;
1886 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1887 match forward_info {
1888 PendingHTLCStatus::Fail(fail_msg) => {
1889 require_commitment = true;
1891 HTLCFailureMsg::Relay(msg) => {
1892 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1893 update_fail_htlcs.push(msg)
1895 HTLCFailureMsg::Malformed(msg) => {
1896 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
1897 update_fail_malformed_htlcs.push(msg)
1901 PendingHTLCStatus::Forward(forward_info) => {
1902 to_forward_infos.push((forward_info, htlc.htlc_id));
1903 htlc.state = InboundHTLCState::Committed;
1909 for htlc in self.pending_outbound_htlcs.iter_mut() {
1910 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
1911 htlc.state = OutboundHTLCState::Committed;
1912 } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
1913 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
1914 require_commitment = true;
1917 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1919 if self.channel_outbound {
1920 if let Some(feerate) = self.pending_update_fee.take() {
1921 self.feerate_per_kw = feerate;
1924 if let Some(feerate) = self.pending_update_fee {
1925 // Because a node cannot send two commitment_signed's in a row without getting a
1926 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
1927 // it should use to create keys with) and because a node can't send a
1928 // commitment_signed without changes, checking if the feerate is equal to the
1929 // pending feerate update is sufficient to detect require_commitment.
1930 if feerate == self.feerate_per_kw {
1931 require_commitment = true;
1932 self.pending_update_fee = None;
1937 match self.free_holding_cell_htlcs()? {
1938 Some(mut commitment_update) => {
1939 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
1940 for fail_msg in update_fail_htlcs.drain(..) {
1941 commitment_update.0.update_fail_htlcs.push(fail_msg);
1943 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
1944 for fail_msg in update_fail_malformed_htlcs.drain(..) {
1945 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
1947 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
1950 if require_commitment {
1951 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1952 Ok((Some(msgs::CommitmentUpdate {
1953 update_add_htlcs: Vec::new(),
1954 update_fulfill_htlcs: Vec::new(),
1956 update_fail_malformed_htlcs,
1959 }), to_forward_infos, revoked_htlcs, monitor_update))
1961 Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
1968 /// Adds a pending update to this channel. See the doc for send_htlc for
1969 /// further details on the optionness of the return value.
1970 /// You MUST call send_commitment prior to any other calls on this Channel
1971 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
1972 if !self.channel_outbound {
1973 panic!("Cannot send fee from inbound channel");
1975 if !self.is_usable() {
1976 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
1978 if !self.is_live() {
1979 panic!("Cannot update fee while peer is disconnected (ChannelManager should have caught this)");
1982 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
1983 self.holding_cell_update_fee = Some(feerate_per_kw);
1987 debug_assert!(self.pending_update_fee.is_none());
1988 self.pending_update_fee = Some(feerate_per_kw);
1990 Some(msgs::UpdateFee {
1991 channel_id: self.channel_id,
1992 feerate_per_kw: feerate_per_kw as u32,
1996 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
1997 match self.send_update_fee(feerate_per_kw) {
1998 Some(update_fee) => {
1999 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2000 Ok(Some((update_fee, commitment_signed, monitor_update)))
2006 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2007 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2008 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2009 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2010 /// No further message handling calls may be made until a channel_reestablish dance has
2012 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, [u8; 32])> {
2013 let mut outbound_drops = Vec::new();
2015 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2016 if self.channel_state < ChannelState::FundingSent as u32 {
2017 self.channel_state = ChannelState::ShutdownComplete as u32;
2018 return outbound_drops;
2021 let mut inbound_drop_count = 0;
2022 self.pending_inbound_htlcs.retain(|htlc| {
2024 InboundHTLCState::RemoteAnnounced(_) => {
2025 // They sent us an update_add_htlc but we never got the commitment_signed.
2026 // We'll tell them what commitment_signed we're expecting next and they'll drop
2027 // this HTLC accordingly
2028 inbound_drop_count += 1;
2031 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2032 // We received a commitment_signed updating this HTLC and (at least hopefully)
2033 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2034 // in response to it yet, so don't touch it.
2037 InboundHTLCState::Committed => true,
2038 InboundHTLCState::LocalRemoved(_) => {
2039 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2040 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2041 // (that we missed). Keep this around for now and if they tell us they missed
2042 // the commitment_signed we can re-transmit the update then.
2048 for htlc in self.pending_outbound_htlcs.iter_mut() {
2049 if let OutboundHTLCState::RemoteRemoved = htlc.state {
2050 // They sent us an update to remove this but haven't yet sent the corresponding
2051 // commitment_signed, we need to move it back to Committed and they can re-send
2052 // the update upon reconnection.
2053 htlc.state = OutboundHTLCState::Committed;
2057 self.holding_cell_htlc_updates.retain(|htlc_update| {
2059 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2060 outbound_drops.push((source.clone(), payment_hash.clone()));
2063 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2066 self.channel_state |= ChannelState::PeerDisconnected as u32;
2067 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2071 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2072 if self.channel_outbound {
2073 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2075 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2076 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2078 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2080 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2081 self.channel_update_count += 1;
2085 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2086 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2087 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder), ChannelError> {
2088 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2089 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2090 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2091 // just close here instead of trying to recover.
2092 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2095 if msg.next_local_commitment_number == 0 || msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2096 msg.next_remote_commitment_number == 0 || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER {
2097 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2100 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2101 // remaining cases either succeed or ErrorMessage-fail).
2102 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2104 let required_revoke = if msg.next_remote_commitment_number == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2105 // Remote isn't waiting on any RevokeAndACK from us!
2106 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2108 } else if msg.next_remote_commitment_number == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2109 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2110 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2111 Some(msgs::RevokeAndACK {
2112 channel_id: self.channel_id,
2113 per_commitment_secret,
2114 next_per_commitment_point,
2117 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2120 // We increment cur_remote_commitment_transaction_number only upon receipt of
2121 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2122 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2123 // the corresponding revoke_and_ack back yet.
2124 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2126 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2127 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2128 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2129 Some(msgs::FundingLocked {
2130 channel_id: self.channel_id(),
2131 next_per_commitment_point: next_per_commitment_point,
2135 let order = if self.received_commitment_while_awaiting_raa {
2136 RAACommitmentOrder::CommitmentFirst
2138 RAACommitmentOrder::RevokeAndACKFirst
2141 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2142 if required_revoke.is_some() {
2143 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2145 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2148 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2149 // We're up-to-date and not waiting on a remote revoke (if we are our
2150 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2151 // have received some updates while we were disconnected. Free the holding cell
2153 match self.free_holding_cell_htlcs() {
2155 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(_)}) = &e.action {
2156 return Err(ChannelError::Close(e.err));
2157 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: _}) = &e.action {
2158 return Err(ChannelError::Close(e.err));
2160 panic!("Got non-channel-failing result from free_holding_cell_htlcs");
2163 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order)),
2164 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order)),
2167 return Ok((resend_funding_locked, required_revoke, None, None, order));
2169 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2170 if required_revoke.is_some() {
2171 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2173 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2175 let mut update_add_htlcs = Vec::new();
2176 let mut update_fulfill_htlcs = Vec::new();
2177 let mut update_fail_htlcs = Vec::new();
2178 let mut update_fail_malformed_htlcs = Vec::new();
2180 for htlc in self.pending_outbound_htlcs.iter() {
2181 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2182 update_add_htlcs.push(msgs::UpdateAddHTLC {
2183 channel_id: self.channel_id(),
2184 htlc_id: htlc.htlc_id,
2185 amount_msat: htlc.amount_msat,
2186 payment_hash: htlc.payment_hash,
2187 cltv_expiry: htlc.cltv_expiry,
2188 onion_routing_packet: (**onion_packet).clone(),
2193 for htlc in self.pending_inbound_htlcs.iter() {
2194 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2196 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2197 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2198 channel_id: self.channel_id(),
2199 htlc_id: htlc.htlc_id,
2200 reason: err_packet.clone()
2203 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2204 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2205 channel_id: self.channel_id(),
2206 htlc_id: htlc.htlc_id,
2207 sha256_of_onion: sha256_of_onion.clone(),
2208 failure_code: failure_code.clone(),
2211 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2212 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2213 channel_id: self.channel_id(),
2214 htlc_id: htlc.htlc_id,
2215 payment_preimage: payment_preimage.clone(),
2222 return Ok((resend_funding_locked, required_revoke,
2223 Some(msgs::CommitmentUpdate {
2224 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2225 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2226 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,
2229 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2233 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, [u8; 32])>), HandleError> {
2234 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2235 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}})});
2237 if self.channel_state < ChannelState::FundingSent as u32 {
2238 self.channel_state = ChannelState::ShutdownComplete as u32;
2239 self.channel_update_count += 1;
2240 return Ok((None, None, Vec::new()));
2242 for htlc in self.pending_inbound_htlcs.iter() {
2243 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2244 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
2247 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
2248 return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
2250 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2252 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2253 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2254 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2255 return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
2258 //Check shutdown_scriptpubkey form as BOLT says we must
2259 if !(msg.scriptpubkey.is_p2pkh()) && !(msg.scriptpubkey.is_p2sh())
2260 && !(msg.scriptpubkey.is_v0_p2wpkh()) && !(msg.scriptpubkey.is_v0_p2wsh()){
2261 return Err(HandleError{err: "Got an invalid scriptpubkey from remote peer", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
2264 if self.their_shutdown_scriptpubkey.is_some() {
2265 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2266 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
2269 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2272 let our_closing_script = self.get_closing_scriptpubkey();
2274 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() {
2275 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2276 if self.feerate_per_kw > proposed_feerate {
2277 proposed_feerate = self.feerate_per_kw;
2279 let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
2280 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2282 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2283 let funding_redeemscript = self.get_funding_redeemscript();
2284 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2286 (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key)))
2287 } else { (None, None, None) };
2289 // From here on out, we may not fail!
2291 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2292 self.channel_update_count += 1;
2294 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2295 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2296 // cell HTLCs and return them to fail the payment.
2297 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2298 self.holding_cell_htlc_updates.retain(|htlc_update| {
2300 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2301 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2307 for htlc in self.pending_outbound_htlcs.iter() {
2308 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2309 return Ok((None, None, dropped_outbound_htlcs));
2313 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2316 Some(msgs::Shutdown {
2317 channel_id: self.channel_id,
2318 scriptpubkey: our_closing_script,
2322 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2323 self.channel_update_count += 1;
2324 if self.pending_inbound_htlcs.is_empty() && self.pending_outbound_htlcs.is_empty() && self.channel_outbound {
2325 // There are no more HTLCs and we're the funder, this means we start the closing_signed
2326 // dance with an initial fee proposal!
2327 self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
2328 Ok((our_shutdown, Some(msgs::ClosingSigned {
2329 channel_id: self.channel_id,
2330 fee_satoshis: proposed_fee.unwrap(),
2331 signature: our_sig.unwrap(),
2332 }), dropped_outbound_htlcs))
2334 Ok((our_shutdown, None, dropped_outbound_htlcs))
2338 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
2339 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2340 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
2342 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2343 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}})});
2345 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2346 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
2348 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2349 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
2352 let funding_redeemscript = self.get_funding_redeemscript();
2353 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2354 if used_total_fee != msg.fee_satoshis {
2355 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
2357 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2359 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2362 // The remote end may have decided to revoke their output due to inconsistent dust
2363 // limits, so check for that case by re-checking the signature here.
2364 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2365 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2366 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer", self.channel_id());
2370 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2371 if last_fee == msg.fee_satoshis {
2372 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2373 self.channel_state = ChannelState::ShutdownComplete as u32;
2374 self.channel_update_count += 1;
2375 return Ok((None, Some(closing_tx)));
2379 macro_rules! propose_new_feerate {
2380 ($new_feerate: expr) => {
2381 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2382 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2383 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2384 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2385 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2386 return Ok((Some(msgs::ClosingSigned {
2387 channel_id: self.channel_id,
2388 fee_satoshis: used_total_fee,
2394 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2395 if self.channel_outbound {
2396 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2397 if proposed_sat_per_kw > our_max_feerate {
2398 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2399 if our_max_feerate <= last_feerate {
2400 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
2403 propose_new_feerate!(our_max_feerate);
2406 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2407 if proposed_sat_per_kw < our_min_feerate {
2408 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2409 if our_min_feerate >= last_feerate {
2410 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
2413 propose_new_feerate!(our_min_feerate);
2417 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2418 self.channel_state = ChannelState::ShutdownComplete as u32;
2419 self.channel_update_count += 1;
2421 Ok((Some(msgs::ClosingSigned {
2422 channel_id: self.channel_id,
2423 fee_satoshis: msg.fee_satoshis,
2425 }), Some(closing_tx)))
2428 // Public utilities:
2430 pub fn channel_id(&self) -> [u8; 32] {
2434 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2435 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2436 pub fn get_user_id(&self) -> u64 {
2440 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2441 pub fn channel_monitor(&self) -> ChannelMonitor {
2442 if self.channel_state < ChannelState::FundingCreated as u32 {
2443 panic!("Can't get a channel monitor until funding has been created");
2445 self.channel_monitor.clone()
2448 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2449 /// is_usable() returns true).
2450 /// Allowed in any state (including after shutdown)
2451 pub fn get_short_channel_id(&self) -> Option<u64> {
2452 self.short_channel_id
2455 /// Returns the funding_txo we either got from our peer, or were given by
2456 /// get_outbound_funding_created.
2457 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2458 self.channel_monitor.get_funding_txo()
2461 /// Allowed in any state (including after shutdown)
2462 pub fn get_their_node_id(&self) -> PublicKey {
2466 /// Allowed in any state (including after shutdown)
2467 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2468 self.our_htlc_minimum_msat
2471 /// Allowed in any state (including after shutdown)
2472 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2473 self.our_htlc_minimum_msat
2476 pub fn get_value_satoshis(&self) -> u64 {
2477 self.channel_value_satoshis
2481 pub fn get_feerate(&self) -> u64 {
2485 //TODO: Testing purpose only, should be changed in another way after #81
2487 pub fn get_local_keys(&self) -> &ChannelKeys {
2492 pub fn get_value_stat(&self) -> ChannelValueStat {
2494 value_to_self_msat: self.value_to_self_msat,
2495 channel_value_msat: self.channel_value_satoshis * 1000,
2496 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2497 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2498 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2499 holding_cell_outbound_amount_msat: {
2501 for h in self.holding_cell_htlc_updates.iter() {
2503 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2511 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2515 /// Allowed in any state (including after shutdown)
2516 pub fn get_channel_update_count(&self) -> u32 {
2517 self.channel_update_count
2520 pub fn should_announce(&self) -> bool {
2521 self.announce_publicly
2524 pub fn is_outbound(&self) -> bool {
2525 self.channel_outbound
2528 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2529 /// Allowed in any state (including after shutdown)
2530 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2531 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2532 // output value back into a transaction with the regular channel output:
2534 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2535 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2537 if self.channel_outbound {
2538 // + the marginal fee increase cost to us in the commitment transaction:
2539 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2542 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2543 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2548 /// Returns true if we've ever received a message from the remote end for this Channel
2549 pub fn have_received_message(&self) -> bool {
2550 self.channel_state > (ChannelState::OurInitSent as u32)
2553 /// Returns true if this channel is fully established and not known to be closing.
2554 /// Allowed in any state (including after shutdown)
2555 pub fn is_usable(&self) -> bool {
2556 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2557 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2560 /// Returns true if this channel is currently available for use. This is a superset of
2561 /// is_usable() and considers things like the channel being temporarily disabled.
2562 /// Allowed in any state (including after shutdown)
2563 pub fn is_live(&self) -> bool {
2564 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
2567 /// Returns true if funding_created was sent/received.
2568 pub fn is_funding_initiated(&self) -> bool {
2569 self.channel_state >= ChannelState::FundingCreated as u32
2572 /// Returns true if this channel is fully shut down. True here implies that no further actions
2573 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2574 /// will be handled appropriately by the chain monitor.
2575 pub fn is_shutdown(&self) -> bool {
2576 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2577 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2582 /// Called by channelmanager based on chain blocks being connected.
2583 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2584 /// the channel_monitor.
2585 /// In case of Err, the channel may have been closed, at which point the standard requirements
2586 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2587 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2588 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2589 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2590 if self.funding_tx_confirmations > 0 {
2591 if header.bitcoin_hash() != self.last_block_connected {
2592 self.last_block_connected = header.bitcoin_hash();
2593 self.funding_tx_confirmations += 1;
2594 if self.funding_tx_confirmations == Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 {
2595 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2596 self.channel_state |= ChannelState::OurFundingLocked as u32;
2598 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2599 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2600 self.channel_update_count += 1;
2602 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2603 // We got a reorg but not enough to trigger a force close, just update
2604 // funding_tx_confirmed_in and return.
2606 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2607 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2609 // We got a reorg but not enough to trigger a force close, just update
2610 // funding_tx_confirmed_in and return.
2613 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2615 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2616 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2617 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2618 //a protocol oversight, but I assume I'm just missing something.
2619 if need_commitment_update {
2620 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2621 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2622 return Ok(Some(msgs::FundingLocked {
2623 channel_id: self.channel_id,
2624 next_per_commitment_point: next_per_commitment_point,
2630 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2631 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2632 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2633 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2634 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2635 tx.output[txo_idx].value != self.channel_value_satoshis {
2636 if self.channel_outbound {
2637 // If we generated the funding transaction and it doesn't match what it
2638 // should, the client is really broken and we should just panic and
2639 // tell them off. That said, because hash collisions happen with high
2640 // probability in fuzztarget mode, if we're fuzzing we just close the
2641 // channel and move on.
2642 #[cfg(not(feature = "fuzztarget"))]
2643 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2645 self.channel_state = ChannelState::ShutdownComplete as u32;
2646 self.channel_update_count += 1;
2647 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2649 self.funding_tx_confirmations = 1;
2650 self.short_channel_id = Some(((height as u64) << (5*8)) |
2651 ((*index_in_block as u64) << (2*8)) |
2652 ((txo_idx as u64) << (0*8)));
2660 /// Called by channelmanager based on chain blocks being disconnected.
2661 /// Returns true if we need to close the channel now due to funding transaction
2662 /// unconfirmation/reorg.
2663 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2664 if self.funding_tx_confirmations > 0 {
2665 self.funding_tx_confirmations -= 1;
2666 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2670 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2671 self.funding_tx_confirmations = Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 - 1;
2676 // Methods to get unprompted messages to send to the remote end (or where we already returned
2677 // something in the handler for the message that prompted this message):
2679 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2680 if !self.channel_outbound {
2681 panic!("Tried to open a channel for an inbound channel?");
2683 if self.channel_state != ChannelState::OurInitSent as u32 {
2684 panic!("Cannot generate an open_channel after we've moved forward");
2687 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2688 panic!("Tried to send an open_channel for a channel that has already advanced");
2691 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2694 chain_hash: chain_hash,
2695 temporary_channel_id: self.channel_id,
2696 funding_satoshis: self.channel_value_satoshis,
2697 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2698 dust_limit_satoshis: self.our_dust_limit_satoshis,
2699 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2700 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2701 htlc_minimum_msat: self.our_htlc_minimum_msat,
2702 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2703 to_self_delay: BREAKDOWN_TIMEOUT,
2704 max_accepted_htlcs: OUR_MAX_HTLCS,
2705 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2706 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2707 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2708 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2709 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2710 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2711 channel_flags: if self.announce_publicly {1} else {0},
2712 shutdown_scriptpubkey: None,
2716 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2717 if self.channel_outbound {
2718 panic!("Tried to send accept_channel for an outbound channel?");
2720 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2721 panic!("Tried to send accept_channel after channel had moved forward");
2723 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2724 panic!("Tried to send an accept_channel for a channel that has already advanced");
2727 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2729 msgs::AcceptChannel {
2730 temporary_channel_id: self.channel_id,
2731 dust_limit_satoshis: self.our_dust_limit_satoshis,
2732 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2733 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2734 htlc_minimum_msat: self.our_htlc_minimum_msat,
2735 minimum_depth: Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat),
2736 to_self_delay: BREAKDOWN_TIMEOUT,
2737 max_accepted_htlcs: OUR_MAX_HTLCS,
2738 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2739 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2740 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2741 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2742 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2743 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2744 shutdown_scriptpubkey: None,
2748 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2749 let funding_script = self.get_funding_redeemscript();
2751 let remote_keys = self.build_remote_transaction_keys()?;
2752 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
2753 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();
2755 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2756 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
2759 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2760 /// a funding_created message for the remote peer.
2761 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2762 /// or if called on an inbound channel.
2763 /// Note that channel_id changes during this call!
2764 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2765 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2766 if !self.channel_outbound {
2767 panic!("Tried to create outbound funding_created message on an inbound channel!");
2769 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2770 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)");
2772 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
2773 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
2774 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2775 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2778 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2779 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2781 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2784 log_error!(self, "Got bad signatures: {}!", e.err);
2785 self.channel_monitor.unset_funding_info();
2790 let temporary_channel_id = self.channel_id;
2792 // Now that we're past error-generating stuff, update our local state:
2793 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2794 self.channel_state = ChannelState::FundingCreated as u32;
2795 self.channel_id = funding_txo.to_channel_id();
2796 self.cur_remote_commitment_transaction_number -= 1;
2798 Ok((msgs::FundingCreated {
2799 temporary_channel_id: temporary_channel_id,
2800 funding_txid: funding_txo.txid,
2801 funding_output_index: funding_txo.index,
2802 signature: our_signature
2803 }, self.channel_monitor.clone()))
2806 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2807 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2808 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
2809 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2810 /// Will only fail if we're not in a state where channel_announcement may be sent (including
2812 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
2813 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
2814 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
2815 if !self.announce_publicly {
2816 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
2818 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
2819 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
2821 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
2822 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
2825 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2826 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
2828 let msg = msgs::UnsignedChannelAnnouncement {
2829 features: msgs::GlobalFeatures::new(),
2830 chain_hash: chain_hash,
2831 short_channel_id: self.get_short_channel_id().unwrap(),
2832 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2833 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2834 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
2835 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
2836 excess_data: Vec::new(),
2839 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2840 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
2845 /// May panic if called on a channel that wasn't immediately-previously
2846 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
2847 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
2848 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
2849 msgs::ChannelReestablish {
2850 channel_id: self.channel_id(),
2851 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
2852 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number,
2853 data_loss_protect: None,
2858 // Send stuff to our remote peers:
2860 /// Adds a pending outbound HTLC to this channel, note that you probably want
2861 /// send_htlc_and_commit instead cause you'll want both messages at once.
2862 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2863 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
2864 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
2865 /// You MUST call send_commitment prior to any other calls on this Channel
2866 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> {
2867 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
2868 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
2871 if amount_msat > self.channel_value_satoshis * 1000 {
2872 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
2874 if amount_msat < self.their_htlc_minimum_msat {
2875 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
2878 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2879 // Note that this should never really happen, if we're !is_live() on receipt of an
2880 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
2881 // the user to send directly into a !is_live() channel. However, if we
2882 // disconnected during the time the previous hop was doing the commitment dance we may
2883 // end up getting here after the forwarding delay. In any case, returning an
2884 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
2885 return Err(HandleError{err: "Cannot send an HTLC while disconnected", action: Some(ErrorAction::IgnoreError)});
2888 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
2889 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
2890 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
2892 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
2893 // Check their_max_htlc_value_in_flight_msat
2894 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
2895 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
2898 let mut holding_cell_outbound_amount_msat = 0;
2899 for holding_htlc in self.holding_cell_htlc_updates.iter() {
2900 match holding_htlc {
2901 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
2902 holding_cell_outbound_amount_msat += *amount_msat;
2908 // Check self.their_channel_reserve_satoshis (the amount we must keep as
2909 // reserve for them to have something to claim if we misbehave)
2910 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
2911 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
2914 //TODO: Check cltv_expiry? Do this in channel manager?
2916 // Now update local state:
2917 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2918 //TODO: Check the limits *including* other pending holding cell HTLCs!
2919 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
2920 amount_msat: amount_msat,
2921 payment_hash: payment_hash,
2922 cltv_expiry: cltv_expiry,
2924 onion_routing_packet: onion_routing_packet,
2925 time_created: Instant::now(),
2930 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
2931 htlc_id: self.next_local_htlc_id,
2932 amount_msat: amount_msat,
2933 payment_hash: payment_hash.clone(),
2934 cltv_expiry: cltv_expiry,
2935 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
2940 let res = msgs::UpdateAddHTLC {
2941 channel_id: self.channel_id,
2942 htlc_id: self.next_local_htlc_id,
2943 amount_msat: amount_msat,
2944 payment_hash: payment_hash,
2945 cltv_expiry: cltv_expiry,
2946 onion_routing_packet: onion_routing_packet,
2948 self.next_local_htlc_id += 1;
2953 /// Creates a signed commitment transaction to send to the remote peer.
2954 /// Always returns a Channel-failing HandleError::action if an immediately-preceding (read: the
2955 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
2956 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
2957 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2958 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2959 panic!("Cannot create commitment tx until channel is fully established");
2961 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2962 panic!("Cannot create commitment tx until remote revokes their previous commitment");
2964 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
2965 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
2967 let mut have_updates = self.pending_update_fee.is_some();
2968 for htlc in self.pending_outbound_htlcs.iter() {
2969 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2970 have_updates = true;
2972 if have_updates { break; }
2975 panic!("Cannot create commitment tx until we have some updates to send");
2977 self.send_commitment_no_status_check()
2979 /// Only fails in case of bad keys
2980 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2981 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
2982 // fail to generate this, we still are at least at a position where upgrading their status
2984 for htlc in self.pending_inbound_htlcs.iter_mut() {
2985 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
2986 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
2988 if let Some(state) = new_state {
2992 for htlc in self.pending_outbound_htlcs.iter_mut() {
2993 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
2994 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
2998 match self.send_commitment_no_state_update() {
2999 Ok((res, remote_commitment_tx)) => {
3000 // Update state now that we've passed all the can-fail calls...
3001 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
3002 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3003 Ok((res, self.channel_monitor.clone()))
3009 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3010 /// when we shouldn't change HTLC/channel state.
3011 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<HTLCOutputInCommitment>)), HandleError> {
3012 let funding_script = self.get_funding_redeemscript();
3014 let mut feerate_per_kw = self.feerate_per_kw;
3015 if let Some(feerate) = self.pending_update_fee {
3016 if self.channel_outbound {
3017 feerate_per_kw = feerate;
3021 let remote_keys = self.build_remote_transaction_keys()?;
3022 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3023 let remote_commitment_txid = remote_commitment_tx.0.txid();
3024 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();
3025 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3027 let mut htlc_sigs = Vec::new();
3029 for ref htlc in remote_commitment_tx.1.iter() {
3030 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3031 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3032 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3033 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());
3034 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3037 Ok((msgs::CommitmentSigned {
3038 channel_id: self.channel_id,
3040 htlc_signatures: htlc_sigs,
3041 }, remote_commitment_tx))
3044 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3045 /// to send to the remote peer in one go.
3046 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3048 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> {
3049 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3050 Some(update_add_htlc) => {
3051 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3052 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3058 /// Begins the shutdown process, getting a message for the remote peer and returning all
3059 /// holding cell HTLCs for payment failure.
3060 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, [u8; 32])>), APIError> {
3061 for htlc in self.pending_outbound_htlcs.iter() {
3062 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3063 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3066 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3067 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3068 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3070 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3071 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3074 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3075 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3076 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected, maybe force-close instead?"});
3079 let our_closing_script = self.get_closing_scriptpubkey();
3081 // From here on out, we may not fail!
3082 if self.channel_state < ChannelState::FundingSent as u32 {
3083 self.channel_state = ChannelState::ShutdownComplete as u32;
3085 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3087 self.channel_update_count += 1;
3089 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3090 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3091 // cell HTLCs and return them to fail the payment.
3092 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3093 self.holding_cell_htlc_updates.retain(|htlc_update| {
3095 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3096 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3103 Ok((msgs::Shutdown {
3104 channel_id: self.channel_id,
3105 scriptpubkey: our_closing_script,
3106 }, dropped_outbound_htlcs))
3109 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3110 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3111 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3112 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3113 /// immediately (others we will have to allow to time out).
3114 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>) {
3115 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3117 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3118 // return them to fail the payment.
3119 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3120 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3122 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3123 dropped_outbound_htlcs.push((source, payment_hash));
3129 for _htlc in self.pending_outbound_htlcs.drain(..) {
3130 //TODO: Do something with the remaining HTLCs
3131 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3135 self.channel_state = ChannelState::ShutdownComplete as u32;
3136 self.channel_update_count += 1;
3137 let mut res = Vec::new();
3138 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3139 (res, dropped_outbound_htlcs)
3145 use bitcoin::util::hash::Sha256dHash;
3146 use bitcoin::util::bip143;
3147 use bitcoin::network::serialize::serialize;
3148 use bitcoin::blockdata::script::Script;
3149 use bitcoin::blockdata::transaction::Transaction;
3151 use ln::channelmanager::HTLCSource;
3152 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3153 use ln::channel::MAX_FUNDING_SATOSHIS;
3155 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3156 use chain::transaction::OutPoint;
3157 use util::test_utils;
3158 use util::logger::Logger;
3159 use secp256k1::{Secp256k1,Message,Signature};
3160 use secp256k1::key::{SecretKey,PublicKey};
3161 use crypto::sha2::Sha256;
3162 use crypto::digest::Digest;
3165 struct TestFeeEstimator {
3168 impl FeeEstimator for TestFeeEstimator {
3169 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3175 fn test_max_funding_satoshis() {
3176 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3177 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3181 fn outbound_commitment_test() {
3182 // Test vectors from BOLT 3 Appendix C:
3183 let feeest = TestFeeEstimator{fee_est: 15000};
3184 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3185 let secp_ctx = Secp256k1::new();
3187 let chan_keys = ChannelKeys {
3188 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3189 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3190 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3191 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3193 // These aren't set in the test vectors:
3194 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3195 channel_close_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3196 channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3197 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],
3199 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3200 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3202 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
3203 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
3204 chan.their_to_self_delay = 144;
3205 chan.our_dust_limit_satoshis = 546;
3207 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
3208 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
3210 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3211 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
3212 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3214 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
3215 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
3216 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
3218 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
3219 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
3220 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
3222 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
3224 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
3225 // derived from a commitment_seed, so instead we copy it here and call
3226 // build_commitment_transaction.
3227 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
3228 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3229 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3230 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
3231 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();
3233 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
3235 macro_rules! test_commitment {
3236 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
3237 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
3238 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3239 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();
3240 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
3242 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
3244 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
3245 hex::decode($tx_hex).unwrap()[..]);
3249 macro_rules! test_htlc_output {
3250 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
3251 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
3253 let ref htlc = unsigned_tx.1[$htlc_idx];
3254 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
3255 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
3256 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3257 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
3259 let mut preimage: Option<[u8; 32]> = None;
3262 let mut sha = Sha256::new();
3263 sha.input(&[i; 32]);
3265 let mut out = [0; 32];
3266 sha.result(&mut out);
3268 if out == htlc.payment_hash {
3269 preimage = Some([i; 32]);
3273 assert!(preimage.is_some());
3276 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
3277 assert_eq!(serialize(&htlc_tx).unwrap()[..],
3278 hex::decode($tx_hex).unwrap()[..]);
3283 // simple commitment tx with no HTLCs
3284 chan.value_to_self_msat = 7000000000;
3286 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
3287 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
3288 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3291 chan.pending_inbound_htlcs.push({
3292 let mut out = InboundHTLCOutput{
3294 amount_msat: 1000000,
3296 payment_hash: [0; 32],
3297 state: InboundHTLCState::Committed,
3299 let mut sha = Sha256::new();
3300 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3301 sha.result(&mut out.payment_hash);
3304 chan.pending_inbound_htlcs.push({
3305 let mut out = InboundHTLCOutput{
3307 amount_msat: 2000000,
3309 payment_hash: [0; 32],
3310 state: InboundHTLCState::Committed,
3312 let mut sha = Sha256::new();
3313 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3314 sha.result(&mut out.payment_hash);
3317 chan.pending_outbound_htlcs.push({
3318 let mut out = OutboundHTLCOutput{
3320 amount_msat: 2000000,
3322 payment_hash: [0; 32],
3323 state: OutboundHTLCState::Committed,
3324 source: HTLCSource::dummy(),
3327 let mut sha = Sha256::new();
3328 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
3329 sha.result(&mut out.payment_hash);
3332 chan.pending_outbound_htlcs.push({
3333 let mut out = OutboundHTLCOutput{
3335 amount_msat: 3000000,
3337 payment_hash: [0; 32],
3338 state: OutboundHTLCState::Committed,
3339 source: HTLCSource::dummy(),
3342 let mut sha = Sha256::new();
3343 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
3344 sha.result(&mut out.payment_hash);
3347 chan.pending_inbound_htlcs.push({
3348 let mut out = InboundHTLCOutput{
3350 amount_msat: 4000000,
3352 payment_hash: [0; 32],
3353 state: InboundHTLCState::Committed,
3355 let mut sha = Sha256::new();
3356 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
3357 sha.result(&mut out.payment_hash);
3362 // commitment tx with all five HTLCs untrimmed (minimum feerate)
3363 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3364 chan.feerate_per_kw = 0;
3366 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
3367 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
3368 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3370 assert_eq!(unsigned_tx.1.len(), 5);
3372 test_htlc_output!(0,
3373 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
3374 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
3375 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3377 test_htlc_output!(1,
3378 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
3379 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
3380 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3382 test_htlc_output!(2,
3383 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
3384 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
3385 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3387 test_htlc_output!(3,
3388 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
3389 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
3390 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3392 test_htlc_output!(4,
3393 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
3394 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
3395 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3399 // commitment tx with seven outputs untrimmed (maximum feerate)
3400 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3401 chan.feerate_per_kw = 647;
3403 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
3404 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
3405 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3407 assert_eq!(unsigned_tx.1.len(), 5);
3409 test_htlc_output!(0,
3410 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
3411 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
3412 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
3414 test_htlc_output!(1,
3415 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
3416 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
3417 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3419 test_htlc_output!(2,
3420 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
3421 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
3422 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3424 test_htlc_output!(3,
3425 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
3426 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
3427 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3429 test_htlc_output!(4,
3430 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
3431 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
3432 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3436 // commitment tx with six outputs untrimmed (minimum feerate)
3437 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3438 chan.feerate_per_kw = 648;
3440 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
3441 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
3442 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3444 assert_eq!(unsigned_tx.1.len(), 4);
3446 test_htlc_output!(0,
3447 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
3448 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
3449 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3451 test_htlc_output!(1,
3452 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
3453 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
3454 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3456 test_htlc_output!(2,
3457 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
3458 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
3459 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3461 test_htlc_output!(3,
3462 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
3463 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
3464 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3468 // commitment tx with six outputs untrimmed (maximum feerate)
3469 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3470 chan.feerate_per_kw = 2069;
3472 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
3473 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
3474 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3476 assert_eq!(unsigned_tx.1.len(), 4);
3478 test_htlc_output!(0,
3479 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
3480 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
3481 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3483 test_htlc_output!(1,
3484 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
3485 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
3486 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
3488 test_htlc_output!(2,
3489 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
3490 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
3491 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3493 test_htlc_output!(3,
3494 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
3495 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
3496 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3500 // commitment tx with five outputs untrimmed (minimum feerate)
3501 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3502 chan.feerate_per_kw = 2070;
3504 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
3505 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
3506 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3508 assert_eq!(unsigned_tx.1.len(), 3);
3510 test_htlc_output!(0,
3511 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
3512 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
3513 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3515 test_htlc_output!(1,
3516 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
3517 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
3518 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3520 test_htlc_output!(2,
3521 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
3522 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
3523 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3527 // commitment tx with five outputs untrimmed (maximum feerate)
3528 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3529 chan.feerate_per_kw = 2194;
3531 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
3532 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
3533 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3535 assert_eq!(unsigned_tx.1.len(), 3);
3537 test_htlc_output!(0,
3538 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
3539 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
3540 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
3542 test_htlc_output!(1,
3543 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
3544 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
3545 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3547 test_htlc_output!(2,
3548 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
3549 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
3550 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3554 // commitment tx with four outputs untrimmed (minimum feerate)
3555 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3556 chan.feerate_per_kw = 2195;
3558 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
3559 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
3560 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3562 assert_eq!(unsigned_tx.1.len(), 2);
3564 test_htlc_output!(0,
3565 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
3566 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
3567 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3569 test_htlc_output!(1,
3570 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
3571 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
3572 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3576 // commitment tx with four outputs untrimmed (maximum feerate)
3577 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3578 chan.feerate_per_kw = 3702;
3580 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
3581 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
3582 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3584 assert_eq!(unsigned_tx.1.len(), 2);
3586 test_htlc_output!(0,
3587 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
3588 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
3589 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
3591 test_htlc_output!(1,
3592 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
3593 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
3594 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3598 // commitment tx with three outputs untrimmed (minimum feerate)
3599 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3600 chan.feerate_per_kw = 3703;
3602 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
3603 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
3604 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3606 assert_eq!(unsigned_tx.1.len(), 1);
3608 test_htlc_output!(0,
3609 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
3610 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
3611 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3615 // commitment tx with three outputs untrimmed (maximum feerate)
3616 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3617 chan.feerate_per_kw = 4914;
3619 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
3620 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
3621 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3623 assert_eq!(unsigned_tx.1.len(), 1);
3625 test_htlc_output!(0,
3626 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
3627 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
3628 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3632 // commitment tx with two outputs untrimmed (minimum feerate)
3633 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3634 chan.feerate_per_kw = 4915;
3636 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
3637 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
3638 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3640 assert_eq!(unsigned_tx.1.len(), 0);
3644 // commitment tx with two outputs untrimmed (maximum feerate)
3645 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3646 chan.feerate_per_kw = 9651180;
3648 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
3649 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
3650 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3652 assert_eq!(unsigned_tx.1.len(), 0);
3656 // commitment tx with one output untrimmed (minimum feerate)
3657 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3658 chan.feerate_per_kw = 9651181;
3660 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3661 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3662 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3664 assert_eq!(unsigned_tx.1.len(), 0);
3668 // commitment tx with fee greater than funder amount
3669 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3670 chan.feerate_per_kw = 9651936;
3672 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3673 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3674 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3676 assert_eq!(unsigned_tx.1.len(), 0);
3681 fn test_per_commitment_secret_gen() {
3682 // Test vectors from BOLT 3 Appendix D:
3684 let mut seed = [0; 32];
3685 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3686 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3687 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
3689 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
3690 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3691 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
3693 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
3694 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
3696 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
3697 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
3699 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3700 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
3701 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
3705 fn test_key_derivation() {
3706 // Test vectors from BOLT 3 Appendix E:
3707 let secp_ctx = Secp256k1::new();
3709 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
3710 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3712 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
3713 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
3715 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
3716 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
3718 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3719 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
3721 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
3722 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
3724 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3725 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
3727 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
3728 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());