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, MsgEncodable};
18 use ln::channelmonitor::ChannelMonitor;
19 use ln::channelmanager::{PendingForwardHTLCInfo, HTLCFailReason};
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::sha2::Sha256;
26 use util::logger::{Logger, Record};
27 use util::errors::APIError;
30 use std::default::Default;
32 use std::time::Instant;
35 pub struct ChannelKeys {
36 pub funding_key: SecretKey,
37 pub revocation_base_key: SecretKey,
38 pub payment_base_key: SecretKey,
39 pub delayed_payment_base_key: SecretKey,
40 pub htlc_base_key: SecretKey,
41 pub channel_close_key: SecretKey,
42 pub channel_monitor_claim_key: SecretKey,
43 pub commitment_seed: [u8; 32],
47 pub fn new_from_seed(seed: &[u8; 32]) -> Result<ChannelKeys, secp256k1::Error> {
48 let mut prk = [0; 32];
49 hkdf_extract(Sha256::new(), b"rust-lightning key gen salt", seed, &mut prk);
50 let secp_ctx = Secp256k1::without_caps();
52 let mut okm = [0; 32];
53 hkdf_expand(Sha256::new(), &prk, b"rust-lightning funding key info", &mut okm);
54 let funding_key = SecretKey::from_slice(&secp_ctx, &okm)?;
56 hkdf_expand(Sha256::new(), &prk, b"rust-lightning revocation base key info", &mut okm);
57 let revocation_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
59 hkdf_expand(Sha256::new(), &prk, b"rust-lightning payment base key info", &mut okm);
60 let payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
62 hkdf_expand(Sha256::new(), &prk, b"rust-lightning delayed payment base key info", &mut okm);
63 let delayed_payment_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
65 hkdf_expand(Sha256::new(), &prk, b"rust-lightning htlc base key info", &mut okm);
66 let htlc_base_key = SecretKey::from_slice(&secp_ctx, &okm)?;
68 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel close key info", &mut okm);
69 let channel_close_key = SecretKey::from_slice(&secp_ctx, &okm)?;
71 hkdf_expand(Sha256::new(), &prk, b"rust-lightning channel monitor claim key info", &mut okm);
72 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &okm)?;
74 hkdf_expand(Sha256::new(), &prk, b"rust-lightning local commitment seed info", &mut okm);
77 funding_key: funding_key,
78 revocation_base_key: revocation_base_key,
79 payment_base_key: payment_base_key,
80 delayed_payment_base_key: delayed_payment_base_key,
81 htlc_base_key: htlc_base_key,
82 channel_close_key: channel_close_key,
83 channel_monitor_claim_key: channel_monitor_claim_key,
91 /// Added by remote, to be included in next local commitment tx.
92 /// Implies HTLCOutput::outbound: false
94 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
95 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
96 /// accept this HTLC. Implies AwaitingRemoteRevoke.
97 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
98 /// a remote revoke_and_ack on a previous state before we can do so.
99 /// Implies HTLCOutput::outbound: false
100 AwaitingRemoteRevokeToAnnounce,
101 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
102 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
103 /// accept this HTLC. Implies AwaitingRemoteRevoke.
104 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
106 /// Implies HTLCOutput::outbound: true
107 AwaitingAnnouncedRemoteRevoke,
108 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
109 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
110 /// we will promote to Committed (note that they may not accept it until the next time we
111 /// revoke, but we dont really care about that:
112 /// * they've revoked, so worst case we can announce an old state and get our (option on)
113 /// money back (though we wont), and,
114 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
115 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
116 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
117 /// we'll never get out of sync).
118 /// Implies HTLCOutput::outbound: true
121 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
122 /// the change (though they'll need to revoke before we fail the payment).
123 /// Implies HTLCOutput::outbound: true
125 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
126 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
127 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
128 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
129 /// remote revoke_and_ack on a previous state before we can do so.
130 /// Implies HTLCOutput::outbound: true
131 AwaitingRemoteRevokeToRemove,
132 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
133 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
134 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
135 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
136 /// revoke_and_ack to drop completely.
137 /// Implies HTLCOutput::outbound: true
138 AwaitingRemovedRemoteRevoke,
139 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
140 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
141 /// we'll promote to LocalRemovedAwaitingCommitment if we fulfilled, otherwise we'll drop at
143 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
144 /// commitment transaction without it as otherwise we'll have to force-close the channel to
145 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
147 /// Implies HTLCOutput::outbound: false
149 /// Removed by us, sent a new commitment_signed and got a revoke_and_ack. Just waiting on an
150 /// updated local commitment transaction. Implies local_removed_fulfilled.
151 /// Implies HTLCOutput::outbound: false
152 LocalRemovedAwaitingCommitment,
155 struct HTLCOutput { //TODO: Refactor into Outbound/InboundHTLCOutput (will save memory and fewer panics)
156 outbound: bool, // ie to an HTLC-Timeout transaction
160 payment_hash: [u8; 32],
162 /// If we're in a Remote* removed state, set if they failed, otherwise None
163 fail_reason: Option<HTLCFailReason>,
164 /// If we're in LocalRemoved*, set to true if we fulfilled the HTLC, and can claim money
165 local_removed_fulfilled: bool,
166 /// state pre-committed Remote* implies pending_forward_state, otherwise it must be None
167 pending_forward_state: Option<PendingForwardHTLCInfo>,
171 fn get_in_commitment(&self, offered: bool) -> HTLCOutputInCommitment {
172 HTLCOutputInCommitment {
174 amount_msat: self.amount_msat,
175 cltv_expiry: self.cltv_expiry,
176 payment_hash: self.payment_hash,
177 transaction_output_index: 0
182 /// See AwaitingRemoteRevoke ChannelState for more info
183 enum HTLCUpdateAwaitingACK {
188 payment_hash: [u8; 32],
189 onion_routing_packet: msgs::OnionPacket,
190 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
193 payment_preimage: [u8; 32],
194 payment_hash: [u8; 32], // Only here for effecient duplicate detection
197 payment_hash: [u8; 32],
198 err_packet: msgs::OnionErrorPacket,
203 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
204 OurInitSent = (1 << 0),
205 /// Implies we have received their open_channel/accept_channel message
206 TheirInitSent = (1 << 1),
207 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
208 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
209 /// upon receipt of funding_created, so simply skip this state.
211 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
212 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
213 /// and our counterparty consider the funding transaction confirmed.
215 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
216 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
217 TheirFundingLocked = (1 << 4),
218 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
219 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
220 OurFundingLocked = (1 << 5),
222 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
223 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
224 /// messages as then we will be unable to determine which HTLCs they included in their
225 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
227 /// Flag is set on ChannelFunded.
228 AwaitingRemoteRevoke = (1 << 7),
229 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
230 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
231 /// to respond with our own shutdown message when possible.
232 RemoteShutdownSent = (1 << 8),
233 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
234 /// point, we may not add any new HTLCs to the channel.
235 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
236 /// us their shutdown.
237 LocalShutdownSent = (1 << 9),
238 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
239 /// to drop us, but we store this anyway.
240 ShutdownComplete = (1 << 10),
242 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
244 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
245 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
246 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
251 channel_id: [u8; 32],
253 channel_outbound: bool,
255 announce_publicly: bool,
256 channel_value_satoshis: u64,
258 local_keys: ChannelKeys,
260 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
261 // generation start at 0 and count up...this simplifies some parts of implementation at the
262 // cost of others, but should really just be changed.
264 cur_local_commitment_transaction_number: u64,
265 cur_remote_commitment_transaction_number: u64,
266 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
267 pending_htlcs: Vec<HTLCOutput>,
268 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
269 next_local_htlc_id: u64,
270 next_remote_htlc_id: u64,
271 channel_update_count: u32,
275 // Used in ChannelManager's tests to send a revoked transaction
276 pub last_local_commitment_txn: Vec<Transaction>,
278 last_local_commitment_txn: Vec<Transaction>,
280 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
282 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
283 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
284 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
285 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
286 funding_tx_confirmed_in: Option<Sha256dHash>,
287 short_channel_id: Option<u64>,
288 /// Used to deduplicate block_connected callbacks
289 last_block_connected: Sha256dHash,
290 funding_tx_confirmations: u64,
292 their_dust_limit_satoshis: u64,
293 our_dust_limit_satoshis: u64,
294 their_max_htlc_value_in_flight_msat: u64,
295 //get_our_max_htlc_value_in_flight_msat(): u64,
296 their_channel_reserve_satoshis: u64,
297 //get_our_channel_reserve_satoshis(): u64,
298 their_htlc_minimum_msat: u64,
299 our_htlc_minimum_msat: u64,
300 their_to_self_delay: u16,
301 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
302 their_max_accepted_htlcs: u16,
303 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
305 their_funding_pubkey: PublicKey,
306 their_revocation_basepoint: PublicKey,
307 their_payment_basepoint: PublicKey,
308 their_delayed_payment_basepoint: PublicKey,
309 their_htlc_basepoint: PublicKey,
310 their_cur_commitment_point: PublicKey,
312 their_prev_commitment_point: Option<PublicKey>,
313 their_node_id: PublicKey,
315 their_shutdown_scriptpubkey: Option<Script>,
317 channel_monitor: ChannelMonitor,
322 const OUR_MAX_HTLCS: u16 = 5; //TODO
323 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
324 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
325 /// really allow for this, so instead we're stuck closing it out at that point.
326 const UNCONF_THRESHOLD: u32 = 6;
327 /// The amount of time we require our counterparty wait to claim their money (ie time between when
328 /// we, or our watchtower, must check for them having broadcast a theft transaction).
329 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
330 /// The amount of time we're willing to wait to claim money back to us
331 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
332 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
333 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
334 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
335 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?)
336 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
338 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
340 macro_rules! secp_call {
341 ( $res: expr, $err: expr ) => {
344 //TODO: make the error a parameter
345 Err(_) => return Err(HandleError{err: $err, action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })})
350 macro_rules! secp_derived_key {
352 secp_call!($res, "Derived invalid key, peer is maliciously selecting parameters")
356 // Convert constants + channel value to limits:
357 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
358 channel_value_satoshis * 1000 / 10 //TODO
361 /// Guaranteed to return a value no larger than channel_value_satoshis
362 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
363 cmp::min(channel_value_satoshis, 1000) //TODO
366 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
367 at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000 //TODO
370 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
374 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
375 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
379 fn derive_maximum_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
380 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
385 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> {
386 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
387 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
390 if push_msat > channel_value_satoshis * 1000 {
391 return Err(APIError::APIMisuseError{err: "push value > channel value"});
394 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
395 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
397 let secp_ctx = Secp256k1::new();
398 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).unwrap().serialize());
399 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();
400 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
401 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key).unwrap(),
402 &chan_keys.htlc_base_key,
403 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
408 channel_id: rng::rand_u832(),
409 channel_state: ChannelState::OurInitSent as u32,
410 channel_outbound: true,
412 announce_publicly: announce_publicly,
413 channel_value_satoshis: channel_value_satoshis,
415 local_keys: chan_keys,
416 cur_local_commitment_transaction_number: (1 << 48) - 1,
417 cur_remote_commitment_transaction_number: (1 << 48) - 1,
418 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
419 pending_htlcs: Vec::new(),
420 holding_cell_htlc_updates: Vec::new(),
421 next_local_htlc_id: 0,
422 next_remote_htlc_id: 0,
423 channel_update_count: 1,
425 last_local_commitment_txn: Vec::new(),
427 last_sent_closing_fee: None,
429 funding_tx_confirmed_in: None,
430 short_channel_id: None,
431 last_block_connected: Default::default(),
432 funding_tx_confirmations: 0,
434 feerate_per_kw: feerate,
435 their_dust_limit_satoshis: 0,
436 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
437 their_max_htlc_value_in_flight_msat: 0,
438 their_channel_reserve_satoshis: 0,
439 their_htlc_minimum_msat: 0,
440 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
441 their_to_self_delay: 0,
442 their_max_accepted_htlcs: 0,
444 their_funding_pubkey: PublicKey::new(),
445 their_revocation_basepoint: PublicKey::new(),
446 their_payment_basepoint: PublicKey::new(),
447 their_delayed_payment_basepoint: PublicKey::new(),
448 their_htlc_basepoint: PublicKey::new(),
449 their_cur_commitment_point: PublicKey::new(),
451 their_prev_commitment_point: None,
452 their_node_id: their_node_id,
454 their_shutdown_scriptpubkey: None,
456 channel_monitor: channel_monitor,
462 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), HandleError> {
463 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
464 return Err(HandleError{err: "Peer's feerate much too low", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
466 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
467 return Err(HandleError{err: "Peer's feerate much too high", action: Some(msgs::ErrorAction::DisconnectPeer{ msg: None })});
472 /// Creates a new channel from a remote sides' request for one.
473 /// Assumes chain_hash has already been checked and corresponds with what we expect!
474 /// Generally prefers to take the DisconnectPeer action on failure, as a notice to the sender
475 /// that we're rejecting the new channel.
476 pub fn new_from_req(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, require_announce: bool, allow_announce: bool, logger: Arc<Logger>) -> Result<Channel, HandleError> {
477 macro_rules! return_error_message {
479 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
483 // Check sanity of message fields:
484 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
485 return_error_message!("funding value > 2^24");
487 if msg.channel_reserve_satoshis > msg.funding_satoshis {
488 return_error_message!("Bogus channel_reserve_satoshis");
490 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
491 return_error_message!("push_msat larger than funding value");
493 if msg.dust_limit_satoshis > msg.funding_satoshis {
494 return_error_message!("Peer never wants payout outputs?");
496 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
497 return_error_message!("Bogus; channel reserve is less than dust limit");
499 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
500 return_error_message!("Miminum htlc value is full channel value");
502 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw).map_err(|e|
503 HandleError{err: e.err, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: e.err.to_string() }})}
506 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
507 return_error_message!("They wanted our payments to be delayed by a needlessly long period");
509 if msg.max_accepted_htlcs < 1 {
510 return_error_message!("0 max_accpted_htlcs makes for a useless channel");
512 if msg.max_accepted_htlcs > 483 {
513 return_error_message!("max_accpted_htlcs > 483");
515 if (msg.channel_flags & 254) != 0 {
516 return Err(HandleError{err: "Unknown channel flags", action: Some(msgs::ErrorAction::IgnoreError) });
519 // Convert things into internal flags and prep our state:
521 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
522 if require_announce && !their_announce {
523 return Err(HandleError{err: "Peer tried to open unannounced channel, but we require public ones", action: Some(msgs::ErrorAction::IgnoreError) });
525 if !allow_announce && their_announce {
526 return Err(HandleError{err: "Peer tried to open announced channel, but we require private ones", action: Some(msgs::ErrorAction::IgnoreError) });
529 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
531 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
532 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
533 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
534 return_error_message!("Suitalbe channel reserve not found. aborting");
536 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
537 return_error_message!("channel_reserve_satoshis too small");
539 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
540 return_error_message!("Dust limit too high for our channel reserve");
543 // check if the funder's amount for the initial commitment tx is sufficient
544 // for full fee payment
545 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
546 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
547 return_error_message!("Insufficient funding amount for initial commitment");
550 let to_local_msat = msg.push_msat;
551 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
552 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
553 return_error_message!("Insufficient funding amount for initial commitment");
556 let secp_ctx = Secp256k1::new();
557 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &chan_keys.channel_monitor_claim_key).unwrap().serialize());
558 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();
559 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key,
560 &PublicKey::from_secret_key(&secp_ctx, &chan_keys.delayed_payment_base_key).unwrap(),
561 &chan_keys.htlc_base_key,
562 BREAKDOWN_TIMEOUT, our_channel_monitor_claim_script);
563 channel_monitor.set_their_htlc_base_key(&msg.htlc_basepoint);
564 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
566 let mut chan = Channel {
569 channel_id: msg.temporary_channel_id,
570 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
571 channel_outbound: false,
573 announce_publicly: their_announce,
575 local_keys: chan_keys,
576 cur_local_commitment_transaction_number: (1 << 48) - 1,
577 cur_remote_commitment_transaction_number: (1 << 48) - 1,
578 value_to_self_msat: msg.push_msat,
579 pending_htlcs: Vec::new(),
580 holding_cell_htlc_updates: Vec::new(),
581 next_local_htlc_id: 0,
582 next_remote_htlc_id: 0,
583 channel_update_count: 1,
585 last_local_commitment_txn: Vec::new(),
587 last_sent_closing_fee: None,
589 funding_tx_confirmed_in: None,
590 short_channel_id: None,
591 last_block_connected: Default::default(),
592 funding_tx_confirmations: 0,
594 feerate_per_kw: msg.feerate_per_kw as u64,
595 channel_value_satoshis: msg.funding_satoshis,
596 their_dust_limit_satoshis: msg.dust_limit_satoshis,
597 our_dust_limit_satoshis: our_dust_limit_satoshis,
598 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
599 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
600 their_htlc_minimum_msat: msg.htlc_minimum_msat,
601 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
602 their_to_self_delay: msg.to_self_delay,
603 their_max_accepted_htlcs: msg.max_accepted_htlcs,
605 their_funding_pubkey: msg.funding_pubkey,
606 their_revocation_basepoint: msg.revocation_basepoint,
607 their_payment_basepoint: msg.payment_basepoint,
608 their_delayed_payment_basepoint: msg.delayed_payment_basepoint,
609 their_htlc_basepoint: msg.htlc_basepoint,
610 their_cur_commitment_point: msg.first_per_commitment_point,
612 their_prev_commitment_point: None,
613 their_node_id: their_node_id,
615 their_shutdown_scriptpubkey: None,
617 channel_monitor: channel_monitor,
622 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
623 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
628 // Utilities to derive keys:
630 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
631 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
632 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
635 // Utilities to build transactions:
637 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
638 let mut sha = Sha256::new();
639 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key).unwrap();
641 if self.channel_outbound {
642 sha.input(&our_payment_basepoint.serialize());
643 sha.input(&self.their_payment_basepoint.serialize());
645 sha.input(&self.their_payment_basepoint.serialize());
646 sha.input(&our_payment_basepoint.serialize());
648 let mut res = [0; 32];
649 sha.result(&mut res);
651 ((res[26] as u64) << 5*8) |
652 ((res[27] as u64) << 4*8) |
653 ((res[28] as u64) << 3*8) |
654 ((res[29] as u64) << 2*8) |
655 ((res[30] as u64) << 1*8) |
656 ((res[31] as u64) << 0*8)
659 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
660 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
661 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
662 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
663 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
665 /// @local is used only to convert relevant internal structures which refer to remote vs local
666 /// to decide value of outputs and direction of HTLCs.
667 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
668 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
669 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
670 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
671 /// which peer generated this transaction and "to whom" this transaction flows.
673 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool) -> (Transaction, Vec<HTLCOutputInCommitment>) {
674 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (0xffffffffffff - commitment_number);
677 let mut ins: Vec<TxIn> = Vec::new();
679 prev_hash: self.channel_monitor.get_funding_txo().unwrap().txid,
680 prev_index: self.channel_monitor.get_funding_txo().unwrap().index as u32,
681 script_sig: Script::new(),
682 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
688 let mut txouts: Vec<(TxOut, Option<HTLCOutputInCommitment>)> = Vec::with_capacity(self.pending_htlcs.len() + 2);
690 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
691 let mut remote_htlc_total_msat = 0;
692 let mut local_htlc_total_msat = 0;
693 let mut value_to_self_msat_offset = 0;
695 for ref htlc in self.pending_htlcs.iter() {
696 let include = match htlc.state {
697 HTLCState::RemoteAnnounced => !generated_by_local,
698 HTLCState::AwaitingRemoteRevokeToAnnounce => !generated_by_local,
699 HTLCState::AwaitingAnnouncedRemoteRevoke => true,
700 HTLCState::LocalAnnounced => generated_by_local,
701 HTLCState::Committed => true,
702 HTLCState::RemoteRemoved => generated_by_local,
703 HTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
704 HTLCState::AwaitingRemovedRemoteRevoke => false,
705 HTLCState::LocalRemoved => !generated_by_local,
706 HTLCState::LocalRemovedAwaitingCommitment => false,
710 if htlc.outbound == local { // "offered HTLC output"
711 if htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
712 let htlc_in_tx = htlc.get_in_commitment(true);
714 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
715 value: htlc.amount_msat / 1000
716 }, Some(htlc_in_tx)));
719 if htlc.amount_msat / 1000 >= dust_limit_satoshis + (self.feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
720 let htlc_in_tx = htlc.get_in_commitment(false);
721 txouts.push((TxOut { // "received HTLC output"
722 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
723 value: htlc.amount_msat / 1000
724 }, Some(htlc_in_tx)));
728 local_htlc_total_msat += htlc.amount_msat;
730 remote_htlc_total_msat += htlc.amount_msat;
734 HTLCState::AwaitingRemoteRevokeToRemove|HTLCState::AwaitingRemovedRemoteRevoke => {
735 if htlc.fail_reason.is_none() {
736 value_to_self_msat_offset -= htlc.amount_msat as i64;
739 HTLCState::RemoteRemoved => {
740 if !generated_by_local && htlc.fail_reason.is_none() {
741 value_to_self_msat_offset -= htlc.amount_msat as i64;
744 HTLCState::LocalRemoved => {
745 if generated_by_local && htlc.local_removed_fulfilled {
746 value_to_self_msat_offset += htlc.amount_msat as i64;
749 HTLCState::LocalRemovedAwaitingCommitment => {
750 assert!(htlc.local_removed_fulfilled);
751 value_to_self_msat_offset += htlc.amount_msat as i64;
758 let total_fee: u64 = self.feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
759 let value_to_self: i64 = ((self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset) / 1000 - if self.channel_outbound { total_fee as i64 } else { 0 };
760 let value_to_remote: i64 = (((self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset) / 1000) - if self.channel_outbound { 0 } else { total_fee as i64 };
762 let value_to_a = if local { value_to_self } else { value_to_remote };
763 let value_to_b = if local { value_to_remote } else { value_to_self };
765 if value_to_a >= (dust_limit_satoshis as i64) {
767 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
768 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
769 &keys.a_delayed_payment_key).to_v0_p2wsh(),
770 value: value_to_a as u64
774 if value_to_b >= (dust_limit_satoshis as i64) {
776 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
777 .push_slice(&Hash160::from_data(&keys.b_payment_key.serialize())[..])
779 value: value_to_b as u64
783 transaction_utils::sort_outputs(&mut txouts);
785 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
786 let mut htlcs_used: Vec<HTLCOutputInCommitment> = Vec::with_capacity(txouts.len());
787 for (idx, out) in txouts.drain(..).enumerate() {
789 if let Some(out_htlc) = out.1 {
790 htlcs_used.push(out_htlc);
791 htlcs_used.last_mut().unwrap().transaction_output_index = idx as u32;
797 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
804 fn get_closing_scriptpubkey(&self) -> Script {
805 let our_channel_close_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.channel_close_key).unwrap().serialize());
806 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
810 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
811 (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)
815 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
817 let mut ins: Vec<TxIn> = Vec::new();
819 prev_hash: self.channel_monitor.get_funding_txo().unwrap().txid,
820 prev_index: self.channel_monitor.get_funding_txo().unwrap().index as u32,
821 script_sig: Script::new(),
822 sequence: 0xffffffff,
828 assert!(self.pending_htlcs.is_empty());
829 let mut txouts: Vec<(TxOut, ())> = Vec::new();
831 let mut total_fee_satoshis = proposed_total_fee_satoshis;
832 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
833 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 };
835 if value_to_self < 0 {
836 assert!(self.channel_outbound);
837 total_fee_satoshis += (-value_to_self) as u64;
838 } else if value_to_remote < 0 {
839 assert!(!self.channel_outbound);
840 total_fee_satoshis += (-value_to_remote) as u64;
843 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
845 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
846 value: value_to_remote as u64
850 if value_to_self as u64 > self.our_dust_limit_satoshis {
852 script_pubkey: self.get_closing_scriptpubkey(),
853 value: value_to_self as u64
857 transaction_utils::sort_outputs(&mut txouts);
859 let mut outputs: Vec<TxOut> = Vec::new();
860 for out in txouts.drain(..) {
869 }, total_fee_satoshis)
873 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
874 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
875 /// our counterparty!)
876 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
877 /// TODO Some magic rust shit to compile-time check this?
878 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, HandleError> {
879 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number)).unwrap();
880 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key).unwrap();
881 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key).unwrap();
883 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint, &self.their_payment_basepoint, &self.their_htlc_basepoint)))
887 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
888 /// will sign and send to our counterparty.
889 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, HandleError> {
890 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
891 //may see payments to it!
892 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key).unwrap();
893 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key).unwrap();
894 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key).unwrap();
896 Ok(secp_derived_key!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point, &self.their_delayed_payment_basepoint, &self.their_htlc_basepoint, &revocation_basepoint, &payment_basepoint, &htlc_basepoint)))
899 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
900 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
901 pub fn get_funding_redeemscript(&self) -> Script {
902 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
903 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).unwrap().serialize();
904 let their_funding_key = self.their_funding_pubkey.serialize();
905 if our_funding_key[..] < their_funding_key[..] {
906 builder.push_slice(&our_funding_key)
907 .push_slice(&their_funding_key)
909 builder.push_slice(&their_funding_key)
910 .push_slice(&our_funding_key)
911 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
914 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
915 if tx.input.len() != 1 {
916 panic!("Tried to sign commitment transaction that had input count != 1!");
918 if tx.input[0].witness.len() != 0 {
919 panic!("Tried to re-sign commitment transaction");
922 let funding_redeemscript = self.get_funding_redeemscript();
924 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
925 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key).unwrap();
927 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
929 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).unwrap().serialize();
930 let their_funding_key = self.their_funding_pubkey.serialize();
931 if our_funding_key[..] < their_funding_key[..] {
932 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
933 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
935 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
936 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
938 tx.input[0].witness[1].push(SigHashType::All as u8);
939 tx.input[0].witness[2].push(SigHashType::All as u8);
941 tx.input[0].witness.push(funding_redeemscript.into_vec());
946 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
947 /// @local is used only to convert relevant internal structures which refer to remote vs local
948 /// to decide value of outputs and direction of HTLCs.
949 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys) -> Transaction {
950 chan_utils::build_htlc_transaction(prev_hash, self.feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
953 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), HandleError> {
954 if tx.input.len() != 1 {
955 panic!("Tried to sign HTLC transaction that had input count != 1!");
958 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
960 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));
961 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
962 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key).unwrap() == keys.a_htlc_key;
963 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key).unwrap(), is_local_tx))
966 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
967 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
968 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<[u8; 32]>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, HandleError> {
969 if tx.input.len() != 1 {
970 panic!("Tried to sign HTLC transaction that had input count != 1!");
972 if tx.input[0].witness.len() != 0 {
973 panic!("Tried to re-sign HTLC transaction");
976 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
978 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
980 if local_tx { // b, then a
981 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
982 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
984 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
985 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
987 tx.input[0].witness[1].push(SigHashType::All as u8);
988 tx.input[0].witness[2].push(SigHashType::All as u8);
991 tx.input[0].witness.push(Vec::new());
993 tx.input[0].witness.push(preimage.unwrap().to_vec());
996 tx.input[0].witness.push(htlc_redeemscript.into_vec());
1001 fn get_update_fulfill_htlc(&mut self, payment_preimage_arg: [u8; 32]) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), HandleError> {
1002 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1003 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1004 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1006 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1007 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1009 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1011 let mut sha = Sha256::new();
1012 sha.input(&payment_preimage_arg);
1013 let mut payment_hash_calc = [0; 32];
1014 sha.result(&mut payment_hash_calc);
1016 let mut pending_idx = std::usize::MAX;
1017 for (idx, htlc) in self.pending_htlcs.iter().enumerate() {
1018 if !htlc.outbound && htlc.payment_hash == payment_hash_calc {
1019 if pending_idx != std::usize::MAX {
1020 panic!("Duplicate HTLC payment_hash, ChannelManager should have prevented this!");
1025 if pending_idx == std::usize::MAX {
1026 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1029 // Now update local state:
1031 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1032 // can claim it even if the channel hits the chain before we see their next commitment.
1033 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1035 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
1036 for pending_update in self.holding_cell_htlc_updates.iter() {
1037 match pending_update {
1038 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, .. } => {
1039 if payment_preimage_arg == *payment_preimage {
1040 return Ok((None, None));
1043 &HTLCUpdateAwaitingACK::FailHTLC { ref payment_hash, .. } => {
1044 if payment_hash_calc == *payment_hash {
1045 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1051 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1052 payment_preimage: payment_preimage_arg, payment_hash: payment_hash_calc,
1054 return Ok((None, Some(self.channel_monitor.clone())));
1058 let htlc = &mut self.pending_htlcs[pending_idx];
1059 if htlc.state == HTLCState::Committed {
1060 htlc.state = HTLCState::LocalRemoved;
1061 htlc.local_removed_fulfilled = true;
1062 } else if htlc.state == HTLCState::RemoteAnnounced || htlc.state == HTLCState::AwaitingRemoteRevokeToAnnounce || htlc.state == HTLCState::AwaitingAnnouncedRemoteRevoke {
1063 // Theoretically we can hit this if we get the preimage on an HTLC prior to us
1064 // having forwarded it to anyone. This implies that the sender is busted as someone
1065 // else knows the preimage, but handling this case and implementing the logic to
1066 // take their money would be a lot of (never-tested) code to handle a case that
1067 // hopefully never happens. Instead, we make sure we get the preimage into the
1068 // channel_monitor and pretend we didn't just see the preimage.
1069 return Ok((None, Some(self.channel_monitor.clone())));
1070 } else if htlc.state == HTLCState::LocalRemoved || htlc.state == HTLCState::LocalRemovedAwaitingCommitment {
1071 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1073 panic!("Have an inbound HTLC when not awaiting remote revoke that had a garbage state");
1078 Ok((Some(msgs::UpdateFulfillHTLC {
1079 channel_id: self.channel_id(),
1081 payment_preimage: payment_preimage_arg,
1082 }), Some(self.channel_monitor.clone())))
1085 pub fn get_update_fulfill_htlc_and_commit(&mut self, payment_preimage: [u8; 32]) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), HandleError> {
1086 match self.get_update_fulfill_htlc(payment_preimage)? {
1087 (Some(update_fulfill_htlc), _) => {
1088 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1089 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1091 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1092 (None, None) => Ok((None, None))
1096 pub fn get_update_fail_htlc(&mut self, payment_hash_arg: &[u8; 32], err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, HandleError> {
1097 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1098 return Err(HandleError{err: "Was asked to fail an HTLC when channel was not in an operational state", action: None});
1100 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1102 // Now update local state:
1103 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
1104 for pending_update in self.holding_cell_htlc_updates.iter() {
1105 match pending_update {
1106 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_hash, .. } => {
1107 if *payment_hash_arg == *payment_hash {
1108 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1111 &HTLCUpdateAwaitingACK::FailHTLC { ref payment_hash, .. } => {
1112 if *payment_hash_arg == *payment_hash {
1119 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1120 payment_hash: payment_hash_arg.clone(),
1126 let mut htlc_id = 0;
1127 let mut htlc_amount_msat = 0;
1128 for htlc in self.pending_htlcs.iter_mut() {
1129 if !htlc.outbound && htlc.payment_hash == *payment_hash_arg {
1131 panic!("Duplicate HTLC payment_hash, you probably re-used payment preimages, NEVER DO THIS!");
1133 htlc_id = htlc.htlc_id;
1134 htlc_amount_msat += htlc.amount_msat;
1135 if htlc.state == HTLCState::Committed {
1136 htlc.state = HTLCState::LocalRemoved;
1137 } else if htlc.state == HTLCState::RemoteAnnounced {
1138 panic!("Somehow forwarded HTLC prior to remote revocation!");
1139 } else if htlc.state == HTLCState::LocalRemoved || htlc.state == HTLCState::LocalRemovedAwaitingCommitment {
1140 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1142 panic!("Have an inbound HTLC when not awaiting remote revoke that had a garbage state");
1146 if htlc_amount_msat == 0 {
1147 return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None});
1150 Ok(Some(msgs::UpdateFailHTLC {
1151 channel_id: self.channel_id(),
1157 pub fn get_update_fail_htlc_and_commit(&mut self, payment_hash: &[u8; 32], err_packet: msgs::OnionErrorPacket) -> Result<Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
1158 match self.get_update_fail_htlc(payment_hash, err_packet)? {
1159 Some(update_fail_htlc) => {
1160 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1161 Ok(Some((update_fail_htlc, commitment, monitor_update)))
1167 // Message handlers:
1169 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1170 macro_rules! return_error_message {
1172 return Err(HandleError{err: $msg, action: Some(msgs::ErrorAction::SendErrorMessage{ msg: msgs::ErrorMessage { channel_id: msg.temporary_channel_id, data: $msg.to_string() }})});
1175 // Check sanity of message fields:
1176 if !self.channel_outbound {
1177 return_error_message!("Got an accept_channel message from an inbound peer");
1179 if self.channel_state != ChannelState::OurInitSent as u32 {
1180 return_error_message!("Got an accept_channel message at a strange time");
1182 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1183 return_error_message!("Peer never wants payout outputs?");
1185 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1186 return_error_message!("Bogus channel_reserve_satoshis");
1188 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1189 return_error_message!("Bogus channel_reserve and dust_limit");
1191 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1192 return_error_message!("Peer never wants payout outputs?");
1194 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1195 return_error_message!("Dust limit is bigger than our channel reverse");
1197 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1198 return_error_message!("Minimum htlc value is full channel value");
1200 if msg.minimum_depth > Channel::derive_maximum_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) {
1201 return_error_message!("minimum_depth too large");
1203 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1204 return_error_message!("They wanted our payments to be delayed by a needlessly long period");
1206 if msg.max_accepted_htlcs < 1 {
1207 return_error_message!("0 max_accpted_htlcs makes for a useless channel");
1209 if msg.max_accepted_htlcs > 483 {
1210 return_error_message!("max_accpted_htlcs > 483");
1213 // TODO: Optional additional constraints mentioned in the spec
1214 // MAY fail the channel if
1215 // funding_satoshi is too small
1216 // htlc_minimum_msat too large
1217 // max_htlc_value_in_flight_msat too small
1218 // channel_reserve_satoshis too large
1219 // max_accepted_htlcs too small
1220 // dust_limit_satoshis too small
1222 self.channel_monitor.set_their_htlc_base_key(&msg.htlc_basepoint);
1224 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1225 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1226 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1227 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1228 self.their_to_self_delay = msg.to_self_delay;
1229 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1230 self.their_funding_pubkey = msg.funding_pubkey;
1231 self.their_revocation_basepoint = msg.revocation_basepoint;
1232 self.their_payment_basepoint = msg.payment_basepoint;
1233 self.their_delayed_payment_basepoint = msg.delayed_payment_basepoint;
1234 self.their_htlc_basepoint = msg.htlc_basepoint;
1235 self.their_cur_commitment_point = msg.first_per_commitment_point;
1237 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1238 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1239 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1241 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1246 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Signature), HandleError> {
1247 let funding_script = self.get_funding_redeemscript();
1249 let remote_keys = self.build_remote_transaction_keys()?;
1250 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
1251 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();
1253 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1254 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1255 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();
1257 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1258 secp_call!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey), "Invalid funding_created signature from peer");
1260 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1261 Ok((remote_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key).unwrap()))
1264 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> {
1265 if self.channel_outbound {
1266 return Err(HandleError{err: "Received funding_created for an outbound channel?", action: None});
1268 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1269 return Err(HandleError{err: "Received funding_created after we got the channel!", action: None});
1271 if self.channel_monitor.get_min_seen_secret() != (1 << 48) || self.cur_remote_commitment_transaction_number != (1 << 48) - 1 || self.cur_local_commitment_transaction_number != (1 << 48) - 1 {
1272 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1275 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1276 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1277 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1279 let (remote_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature) {
1282 self.channel_monitor.unset_funding_info();
1287 // Now that we're past error-generating stuff, update our local state:
1289 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
1290 self.channel_state = ChannelState::FundingSent as u32;
1291 self.channel_id = funding_txo.to_channel_id();
1292 self.cur_remote_commitment_transaction_number -= 1;
1293 self.cur_local_commitment_transaction_number -= 1;
1295 Ok((msgs::FundingSigned {
1296 channel_id: self.channel_id,
1297 signature: our_signature
1298 }, self.channel_monitor.clone()))
1301 /// Handles a funding_signed message from the remote end.
1302 /// If this call is successful, broadcast the funding transaction (and not before!)
1303 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, HandleError> {
1304 if !self.channel_outbound {
1305 return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None});
1307 if self.channel_state != ChannelState::FundingCreated as u32 {
1308 return Err(HandleError{err: "Received funding_signed in strange state!", action: None});
1310 if self.channel_monitor.get_min_seen_secret() != (1 << 48) || self.cur_remote_commitment_transaction_number != (1 << 48) - 2 || self.cur_local_commitment_transaction_number != (1 << 48) - 1 {
1311 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1314 let funding_script = self.get_funding_redeemscript();
1316 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1317 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false).0;
1318 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();
1320 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1321 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey), "Invalid funding_signed signature from peer");
1323 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1324 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1325 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1326 self.channel_state = ChannelState::FundingSent as u32;
1327 self.cur_local_commitment_transaction_number -= 1;
1329 Ok(self.channel_monitor.clone())
1332 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
1333 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
1334 if non_shutdown_state == ChannelState::FundingSent as u32 {
1335 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1336 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1337 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
1338 self.channel_update_count += 1;
1340 return Err(HandleError{err: "Peer sent a funding_locked at a strange time", action: None});
1343 self.their_prev_commitment_point = Some(self.their_cur_commitment_point);
1344 self.their_cur_commitment_point = msg.next_per_commitment_point;
1348 /// Returns (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1349 /// If its for a remote update check, we need to be more lax about checking against messages we
1350 /// sent but they may not have received/processed before they sent this message. Further, for
1351 /// our own sends, we're more conservative and even consider things they've removed against
1352 /// totals, though there is little reason to outside of further avoiding any race condition
1354 fn get_pending_htlc_stats(&self, for_remote_update_check: bool) -> (u32, u32, u64, u64) {
1355 let mut inbound_htlc_count: u32 = 0;
1356 let mut outbound_htlc_count: u32 = 0;
1357 let mut htlc_outbound_value_msat = 0;
1358 let mut htlc_inbound_value_msat = 0;
1359 for ref htlc in self.pending_htlcs.iter() {
1361 HTLCState::RemoteAnnounced => {},
1362 HTLCState::AwaitingRemoteRevokeToAnnounce => {},
1363 HTLCState::AwaitingAnnouncedRemoteRevoke => {},
1364 HTLCState::LocalAnnounced => { if for_remote_update_check { continue; } },
1365 HTLCState::Committed => {},
1366 HTLCState::RemoteRemoved => { if for_remote_update_check { continue; } },
1367 HTLCState::AwaitingRemoteRevokeToRemove => { if for_remote_update_check { continue; } },
1368 HTLCState::AwaitingRemovedRemoteRevoke => { if for_remote_update_check { continue; } },
1369 HTLCState::LocalRemoved => {},
1370 HTLCState::LocalRemovedAwaitingCommitment => { if for_remote_update_check { continue; } },
1373 inbound_htlc_count += 1;
1374 htlc_inbound_value_msat += htlc.amount_msat;
1376 outbound_htlc_count += 1;
1377 htlc_outbound_value_msat += htlc.amount_msat;
1380 (inbound_htlc_count, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat)
1383 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingForwardHTLCInfo) -> Result<(), HandleError> {
1384 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1385 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1387 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1388 return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None});
1390 if msg.amount_msat < self.our_htlc_minimum_msat {
1391 return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None});
1394 let (inbound_htlc_count, _, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(true);
1395 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1396 return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None});
1398 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1399 // Check our_max_htlc_value_in_flight_msat
1400 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1401 return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None});
1403 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1404 // the reserve_satoshis we told them to always have as direct payment so that they lose
1405 // something if we punish them for broadcasting an old state).
1406 if htlc_inbound_value_msat + htlc_outbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 {
1407 return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None});
1409 if self.next_remote_htlc_id != msg.htlc_id {
1410 return Err(HandleError{err: "Remote skipped HTLC ID", action: None});
1412 if msg.cltv_expiry >= 500000000 {
1413 return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None});
1416 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1418 // Now update local state:
1419 self.next_remote_htlc_id += 1;
1420 self.pending_htlcs.push(HTLCOutput {
1422 htlc_id: msg.htlc_id,
1423 amount_msat: msg.amount_msat,
1424 payment_hash: msg.payment_hash,
1425 cltv_expiry: msg.cltv_expiry,
1426 state: HTLCState::RemoteAnnounced,
1428 local_removed_fulfilled: false,
1429 pending_forward_state: Some(pending_forward_state),
1435 /// Removes an outbound HTLC which has been commitment_signed by the remote end
1437 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<[u8; 32]>, fail_reason: Option<HTLCFailReason>) -> Result<[u8; 32], HandleError> {
1438 for htlc in self.pending_htlcs.iter_mut() {
1439 if htlc.outbound && htlc.htlc_id == htlc_id {
1440 match check_preimage {
1442 Some(payment_hash) =>
1443 if payment_hash != htlc.payment_hash {
1444 return Err(HandleError{err: "Remote tried to fulfill HTLC with an incorrect preimage", action: None});
1447 if htlc.state == HTLCState::LocalAnnounced {
1448 return Err(HandleError{err: "Remote tried to fulfill HTLC before it had been committed", action: None});
1449 } else if htlc.state == HTLCState::Committed {
1450 htlc.state = HTLCState::RemoteRemoved;
1451 htlc.fail_reason = fail_reason;
1452 } else if htlc.state == HTLCState::AwaitingRemoteRevokeToRemove || htlc.state == HTLCState::AwaitingRemovedRemoteRevoke || htlc.state == HTLCState::RemoteRemoved {
1453 return Err(HandleError{err: "Remote tried to fulfill HTLC that they'd already fulfilled", action: None});
1455 panic!("Got a non-outbound state on an outbound HTLC");
1457 return Ok(htlc.payment_hash.clone());
1460 Err(HandleError{err: "Remote tried to fulfill/fail an HTLC we couldn't find", action: None})
1463 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1464 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1465 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1468 let mut sha = Sha256::new();
1469 sha.input(&msg.payment_preimage);
1470 let mut payment_hash = [0; 32];
1471 sha.result(&mut payment_hash);
1473 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None)?;
1477 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<[u8; 32], HandleError> {
1478 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1479 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1482 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))
1485 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), HandleError> {
1486 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1487 return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None});
1490 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1494 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, ChannelMonitor), HandleError> {
1495 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1496 return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None});
1499 let funding_script = self.get_funding_redeemscript();
1501 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1502 let mut local_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false);
1503 let local_commitment_txid = local_commitment_tx.0.txid();
1504 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();
1505 secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey), "Invalid commitment tx signature from peer");
1507 if msg.htlc_signatures.len() != local_commitment_tx.1.len() {
1508 return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None});
1511 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1);
1512 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1513 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1515 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.1.len());
1516 for (idx, ref htlc) in local_commitment_tx.1.iter().enumerate() {
1517 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, htlc, true, &local_keys);
1518 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1519 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1520 secp_call!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx siganture from peer");
1521 let htlc_sig = if htlc.offered {
1522 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, htlc, &local_keys)?;
1523 new_local_commitment_txn.push(htlc_tx);
1526 self.create_htlc_tx_signature(&htlc_tx, htlc, &local_keys)?.1
1528 htlcs_and_sigs.push(((*htlc).clone(), msg.htlc_signatures[idx], htlc_sig));
1531 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1)).unwrap();
1532 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1534 // Update state now that we've passed all the can-fail calls...
1535 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1537 let mut need_our_commitment = false;
1538 for htlc in self.pending_htlcs.iter_mut() {
1539 if htlc.state == HTLCState::RemoteAnnounced {
1540 htlc.state = HTLCState::AwaitingRemoteRevokeToAnnounce;
1541 need_our_commitment = true;
1542 } else if htlc.state == HTLCState::RemoteRemoved {
1543 htlc.state = HTLCState::AwaitingRemoteRevokeToRemove;
1544 need_our_commitment = true;
1547 // Finally delete all the LocalRemovedAwaitingCommitment HTLCs
1548 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1549 let mut claimed_value_msat = 0;
1550 self.pending_htlcs.retain(|htlc| {
1551 if htlc.state == HTLCState::LocalRemovedAwaitingCommitment {
1552 claimed_value_msat += htlc.amount_msat;
1556 self.value_to_self_msat += claimed_value_msat;
1558 self.cur_local_commitment_transaction_number -= 1;
1559 self.last_local_commitment_txn = new_local_commitment_txn;
1561 let (our_commitment_signed, monitor_update) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1562 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1563 // we'll send one right away when we get the revoke_and_ack when we
1564 // free_holding_cell_htlcs().
1565 let (msg, monitor) = self.send_commitment_no_status_check()?;
1566 (Some(msg), monitor)
1567 } else { (None, self.channel_monitor.clone()) };
1569 Ok((msgs::RevokeAndACK {
1570 channel_id: self.channel_id,
1571 per_commitment_secret: per_commitment_secret,
1572 next_per_commitment_point: next_per_commitment_point,
1573 }, our_commitment_signed, monitor_update))
1576 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1577 /// fulfilling or failing the last pending HTLC)
1578 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, HandleError> {
1579 if self.holding_cell_htlc_updates.len() != 0 {
1580 let mut htlc_updates = Vec::new();
1581 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1582 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1583 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1584 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1586 for htlc_update in htlc_updates.drain(..) {
1587 // Note that this *can* fail, though it should be due to rather-rare conditions on
1588 // fee races with adding too many outputs which push our total payments just over
1589 // the limit. In case its less rare than I anticipate, we may want to revisit
1590 // handling this case better and maybe fufilling some of the HTLCs while attempting
1591 // to rebalance channels.
1592 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1593 self.holding_cell_htlc_updates.push(htlc_update);
1595 match &htlc_update {
1596 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, payment_hash, ref onion_routing_packet, ..} => {
1597 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, onion_routing_packet.clone()) {
1598 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1604 &HTLCUpdateAwaitingACK::ClaimHTLC { payment_preimage, .. } => {
1605 match self.get_update_fulfill_htlc(payment_preimage) {
1606 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1612 &HTLCUpdateAwaitingACK::FailHTLC { payment_hash, ref err_packet } => {
1613 match self.get_update_fail_htlc(&payment_hash, err_packet.clone()) {
1614 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1622 self.holding_cell_htlc_updates.push(htlc_update);
1626 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1627 //fail it back the route, if its a temporary issue we can ignore it...
1630 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1631 Ok(Some((msgs::CommitmentUpdate {
1633 update_fulfill_htlcs,
1636 }, monitor_update)))
1645 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1646 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1647 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1648 /// generating an appropriate error *after* the channel state has been updated based on the
1649 /// revoke_and_ack message.
1650 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option<msgs::CommitmentUpdate>, Vec<PendingForwardHTLCInfo>, Vec<([u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> {
1651 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1652 return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None});
1654 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1655 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")).unwrap() != their_prev_commitment_point {
1656 return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None});
1659 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)))?;
1661 // Update state now that we've passed all the can-fail calls...
1662 // (note that we may still fail to generate the new commitment_signed message, but that's
1663 // OK, we step the channel here and *then* if the new generation fails we can fail the
1664 // channel based on that, but stepping stuff here should be safe either way.
1665 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1666 self.their_prev_commitment_point = Some(self.their_cur_commitment_point);
1667 self.their_cur_commitment_point = msg.next_per_commitment_point;
1668 self.cur_remote_commitment_transaction_number -= 1;
1670 let mut to_forward_infos = Vec::new();
1671 let mut revoked_htlcs = Vec::new();
1672 let mut require_commitment = false;
1673 let mut value_to_self_msat_diff: i64 = 0;
1674 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1675 self.pending_htlcs.retain(|htlc| {
1676 if htlc.state == HTLCState::LocalRemoved {
1677 if htlc.local_removed_fulfilled { true } else { false }
1678 } else if htlc.state == HTLCState::AwaitingRemovedRemoteRevoke {
1679 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1680 revoked_htlcs.push((htlc.payment_hash, reason));
1682 // They fulfilled, so we sent them money
1683 value_to_self_msat_diff -= htlc.amount_msat as i64;
1688 for htlc in self.pending_htlcs.iter_mut() {
1689 if htlc.state == HTLCState::LocalAnnounced {
1690 htlc.state = HTLCState::Committed;
1691 } else if htlc.state == HTLCState::AwaitingRemoteRevokeToAnnounce {
1692 htlc.state = HTLCState::AwaitingAnnouncedRemoteRevoke;
1693 require_commitment = true;
1694 } else if htlc.state == HTLCState::AwaitingAnnouncedRemoteRevoke {
1695 htlc.state = HTLCState::Committed;
1696 to_forward_infos.push(htlc.pending_forward_state.take().unwrap());
1697 } else if htlc.state == HTLCState::AwaitingRemoteRevokeToRemove {
1698 htlc.state = HTLCState::AwaitingRemovedRemoteRevoke;
1699 require_commitment = true;
1700 } else if htlc.state == HTLCState::LocalRemoved {
1701 assert!(htlc.local_removed_fulfilled);
1702 htlc.state = HTLCState::LocalRemovedAwaitingCommitment;
1705 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
1707 match self.free_holding_cell_htlcs()? {
1708 Some(commitment_update) => {
1709 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, commitment_update.1))
1712 if require_commitment {
1713 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1714 Ok((Some(msgs::CommitmentUpdate {
1715 update_add_htlcs: Vec::new(),
1716 update_fulfill_htlcs: Vec::new(),
1717 update_fail_htlcs: Vec::new(),
1719 }), to_forward_infos, revoked_htlcs, monitor_update))
1721 Ok((None, to_forward_infos, revoked_htlcs, self.channel_monitor.clone()))
1727 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1728 if self.channel_outbound {
1729 return Err(HandleError{err: "Non-funding remote tried to update channel fee", action: None});
1731 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
1732 self.channel_update_count += 1;
1733 self.feerate_per_kw = msg.feerate_per_kw as u64;
1737 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<[u8; 32]>), HandleError> {
1738 if self.channel_state < ChannelState::FundingSent as u32 {
1739 self.channel_state = ChannelState::ShutdownComplete as u32;
1740 self.channel_update_count += 1;
1741 return Ok((None, None, Vec::new()));
1743 for htlc in self.pending_htlcs.iter() {
1744 if htlc.state == HTLCState::RemoteAnnounced {
1745 return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None});
1748 if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
1749 return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None});
1751 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1753 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
1754 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
1755 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
1756 return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None});
1758 //TODO: Check shutdown_scriptpubkey form as BOLT says we must? WHYYY
1760 if self.their_shutdown_scriptpubkey.is_some() {
1761 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
1762 return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None});
1765 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
1768 let our_closing_script = self.get_closing_scriptpubkey();
1770 let (proposed_feerate, proposed_fee, our_sig) = if self.channel_outbound && self.pending_htlcs.is_empty() {
1771 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
1772 if self.feerate_per_kw > proposed_feerate {
1773 proposed_feerate = self.feerate_per_kw;
1775 let tx_weight = Self::get_closing_transaction_weight(&our_closing_script, &msg.scriptpubkey);
1776 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
1778 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
1779 let funding_redeemscript = self.get_funding_redeemscript();
1780 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1782 (Some(proposed_feerate), Some(total_fee_satoshis), Some(self.secp_ctx.sign(&sighash, &self.local_keys.funding_key).unwrap()))
1783 } else { (None, None, None) };
1785 // From here on out, we may not fail!
1787 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
1788 self.channel_update_count += 1;
1790 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
1791 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
1792 // cell HTLCs and return them to fail the payment.
1793 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
1794 self.holding_cell_htlc_updates.retain(|htlc_update| {
1796 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, .. } => {
1797 dropped_outbound_htlcs.push(payment_hash.clone());
1803 for htlc in self.pending_htlcs.iter() {
1804 if htlc.state == HTLCState::LocalAnnounced {
1805 return Ok((None, None, dropped_outbound_htlcs));
1809 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
1812 Some(msgs::Shutdown {
1813 channel_id: self.channel_id,
1814 scriptpubkey: our_closing_script,
1818 self.channel_state |= ChannelState::LocalShutdownSent as u32;
1819 self.channel_update_count += 1;
1820 if self.pending_htlcs.is_empty() && self.channel_outbound {
1821 // There are no more HTLCs and we're the funder, this means we start the closing_signed
1822 // dance with an initial fee proposal!
1823 self.last_sent_closing_fee = Some((proposed_feerate.unwrap(), proposed_fee.unwrap()));
1824 Ok((our_shutdown, Some(msgs::ClosingSigned {
1825 channel_id: self.channel_id,
1826 fee_satoshis: proposed_fee.unwrap(),
1827 signature: our_sig.unwrap(),
1828 }), dropped_outbound_htlcs))
1830 Ok((our_shutdown, None, dropped_outbound_htlcs))
1834 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), HandleError> {
1835 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
1836 return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None});
1838 if !self.pending_htlcs.is_empty() {
1839 return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None});
1841 if msg.fee_satoshis > 21000000 * 10000000 {
1842 return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None});
1845 let funding_redeemscript = self.get_funding_redeemscript();
1846 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
1847 if used_total_fee != msg.fee_satoshis {
1848 return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None});
1850 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1852 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey) {
1855 // The remote end may have decided to revoke their output due to inconsistent dust
1856 // limits, so check for that case by re-checking the signature here.
1857 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
1858 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1859 secp_call!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey), "Invalid closing tx signature from peer");
1863 if let Some((_, last_fee)) = self.last_sent_closing_fee {
1864 if last_fee == msg.fee_satoshis {
1865 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
1866 self.channel_state = ChannelState::ShutdownComplete as u32;
1867 self.channel_update_count += 1;
1868 return Ok((None, Some(closing_tx)));
1872 macro_rules! propose_new_feerate {
1873 ($new_feerate: expr) => {
1874 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
1875 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
1876 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1877 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key).unwrap();
1878 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
1879 return Ok((Some(msgs::ClosingSigned {
1880 channel_id: self.channel_id,
1881 fee_satoshis: used_total_fee,
1887 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
1888 if self.channel_outbound {
1889 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
1890 if proposed_sat_per_kw > our_max_feerate {
1891 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
1892 if our_max_feerate <= last_feerate {
1893 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None});
1896 propose_new_feerate!(our_max_feerate);
1899 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
1900 if proposed_sat_per_kw < our_min_feerate {
1901 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
1902 if our_min_feerate >= last_feerate {
1903 return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None});
1906 propose_new_feerate!(our_min_feerate);
1910 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
1911 self.channel_state = ChannelState::ShutdownComplete as u32;
1912 self.channel_update_count += 1;
1914 Ok((Some(msgs::ClosingSigned {
1915 channel_id: self.channel_id,
1916 fee_satoshis: msg.fee_satoshis,
1918 }), Some(closing_tx)))
1921 // Public utilities:
1923 pub fn channel_id(&self) -> [u8; 32] {
1927 /// Gets the "user_id" value passed into the construction of this channel. It has no special
1928 /// meaning and exists only to allow users to have a persistent identifier of a channel.
1929 pub fn get_user_id(&self) -> u64 {
1933 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
1934 pub fn channel_monitor(&self) -> ChannelMonitor {
1935 if self.channel_state < ChannelState::FundingCreated as u32 {
1936 panic!("Can't get a channel monitor until funding has been created");
1938 self.channel_monitor.clone()
1941 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
1942 /// is_usable() returns true).
1943 /// Allowed in any state (including after shutdown)
1944 pub fn get_short_channel_id(&self) -> Option<u64> {
1945 self.short_channel_id
1948 /// Returns the funding_txo we either got from our peer, or were given by
1949 /// get_outbound_funding_created.
1950 pub fn get_funding_txo(&self) -> Option<OutPoint> {
1951 self.channel_monitor.get_funding_txo()
1954 /// Allowed in any state (including after shutdown)
1955 pub fn get_their_node_id(&self) -> PublicKey {
1959 /// Allowed in any state (including after shutdown)
1960 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
1961 self.our_htlc_minimum_msat
1964 pub fn get_value_satoshis(&self) -> u64 {
1965 self.channel_value_satoshis
1968 /// Allowed in any state (including after shutdown)
1969 pub fn get_channel_update_count(&self) -> u32 {
1970 self.channel_update_count
1973 pub fn should_announce(&self) -> bool {
1974 self.announce_publicly
1977 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
1978 /// Allowed in any state (including after shutdown)
1979 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
1980 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
1981 // output value back into a transaction with the regular channel output:
1983 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
1984 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
1986 if self.channel_outbound {
1987 // + the marginal fee increase cost to us in the commitment transaction:
1988 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
1991 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
1992 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
1997 /// Returns true if this channel is fully established and not known to be closing.
1998 /// Allowed in any state (including after shutdown)
1999 pub fn is_usable(&self) -> bool {
2000 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2001 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2004 /// Returns true if this channel is currently available for use. This is a superset of
2005 /// is_usable() and considers things like the channel being temporarily disabled.
2006 /// Allowed in any state (including after shutdown)
2007 pub fn is_live(&self) -> bool {
2011 /// Returns true if funding_created was sent/received.
2012 pub fn is_funding_initiated(&self) -> bool {
2013 self.channel_state >= ChannelState::FundingCreated as u32
2016 /// Returns true if this channel is fully shut down. True here implies that no further actions
2017 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2018 /// will be handled appropriately by the chain monitor.
2019 pub fn is_shutdown(&self) -> bool {
2020 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2021 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2026 /// Called by channelmanager based on chain blocks being connected.
2027 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2028 /// the channel_monitor.
2029 /// In case of Err, the channel may have been closed, at which point the standard requirements
2030 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2031 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2032 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, HandleError> {
2033 let non_shutdown_state = self.channel_state & (!BOTH_SIDES_SHUTDOWN_MASK);
2034 if self.funding_tx_confirmations > 0 {
2035 if header.bitcoin_hash() != self.last_block_connected {
2036 self.last_block_connected = header.bitcoin_hash();
2037 self.funding_tx_confirmations += 1;
2038 if self.funding_tx_confirmations == Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 {
2039 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2040 self.channel_state |= ChannelState::OurFundingLocked as u32;
2042 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2043 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK);
2044 self.channel_update_count += 1;
2046 } else if self.channel_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2047 // We got a reorg but not enough to trigger a force close, just update
2048 // funding_tx_confirmed_in and return.
2050 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2051 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2053 // We got a reorg but not enough to trigger a force close, just update
2054 // funding_tx_confirmed_in and return.
2057 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2059 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2060 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2061 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2062 //a protocol oversight, but I assume I'm just missing something.
2063 if need_commitment_update {
2064 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2065 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret).unwrap();
2066 return Ok(Some(msgs::FundingLocked {
2067 channel_id: self.channel_id,
2068 next_per_commitment_point: next_per_commitment_point,
2074 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2075 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2076 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2077 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2078 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2079 tx.output[txo_idx].value != self.channel_value_satoshis {
2080 self.channel_state = ChannelState::ShutdownComplete as u32;
2081 self.channel_update_count += 1;
2082 return Err(HandleError{err: "funding tx had wrong script/value", action: Some(ErrorAction::DisconnectPeer{msg: None})});
2084 self.funding_tx_confirmations = 1;
2085 self.short_channel_id = Some(((height as u64) << (5*8)) |
2086 ((*index_in_block as u64) << (2*8)) |
2087 ((txo_idx as u64) << (0*8)));
2095 /// Called by channelmanager based on chain blocks being disconnected.
2096 /// Returns true if we need to close the channel now due to funding transaction
2097 /// unconfirmation/reorg.
2098 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2099 if self.funding_tx_confirmations > 0 {
2100 self.funding_tx_confirmations -= 1;
2101 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2105 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2106 self.funding_tx_confirmations = Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat) as u64 - 1;
2111 // Methods to get unprompted messages to send to the remote end (or where we already returned
2112 // something in the handler for the message that prompted this message):
2114 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> Result<msgs::OpenChannel, APIError> {
2115 if !self.channel_outbound {
2116 panic!("Tried to open a channel for an inbound channel?");
2118 if self.channel_state != ChannelState::OurInitSent as u32 {
2119 panic!("Cannot generate an open_channel after we've moved forward");
2122 if self.cur_local_commitment_transaction_number != (1 << 48) - 1 {
2123 panic!("Tried to send an open_channel for a channel that has already advanced");
2126 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2128 Ok(msgs::OpenChannel {
2129 chain_hash: chain_hash,
2130 temporary_channel_id: self.channel_id,
2131 funding_satoshis: self.channel_value_satoshis,
2132 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2133 dust_limit_satoshis: self.our_dust_limit_satoshis,
2134 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2135 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2136 htlc_minimum_msat: self.our_htlc_minimum_msat,
2137 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2138 to_self_delay: BREAKDOWN_TIMEOUT,
2139 max_accepted_htlcs: OUR_MAX_HTLCS,
2140 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).unwrap(),
2141 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key).unwrap(),
2142 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key).unwrap(),
2143 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key).unwrap(),
2144 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key).unwrap(),
2145 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret).unwrap(),
2146 channel_flags: if self.announce_publicly {1} else {0},
2147 shutdown_scriptpubkey: None,
2151 pub fn get_accept_channel(&self) -> Result<msgs::AcceptChannel, HandleError> {
2152 if self.channel_outbound {
2153 panic!("Tried to send accept_channel for an outbound channel?");
2155 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2156 panic!("Tried to send accept_channel after channel had moved forward");
2158 if self.cur_local_commitment_transaction_number != (1 << 48) - 1 {
2159 panic!("Tried to send an accept_channel for a channel that has already advanced");
2162 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2164 Ok(msgs::AcceptChannel {
2165 temporary_channel_id: self.channel_id,
2166 dust_limit_satoshis: self.our_dust_limit_satoshis,
2167 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2168 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2169 htlc_minimum_msat: self.our_htlc_minimum_msat,
2170 minimum_depth: Channel::derive_minimum_depth(self.channel_value_satoshis*1000, self.value_to_self_msat),
2171 to_self_delay: BREAKDOWN_TIMEOUT,
2172 max_accepted_htlcs: OUR_MAX_HTLCS,
2173 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).unwrap(),
2174 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key).unwrap(),
2175 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key).unwrap(),
2176 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key).unwrap(),
2177 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key).unwrap(),
2178 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret).unwrap(),
2179 shutdown_scriptpubkey: None,
2183 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), HandleError> {
2184 let funding_script = self.get_funding_redeemscript();
2186 let remote_keys = self.build_remote_transaction_keys()?;
2187 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false).0;
2188 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();
2190 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
2191 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key).unwrap(), remote_initial_commitment_tx))
2194 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
2195 /// a funding_created message for the remote peer.
2196 /// Panics if called at some time other than immediately after initial handshake, if called twice,
2197 /// or if called on an inbound channel.
2198 /// Note that channel_id changes during this call!
2199 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
2200 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), HandleError> {
2201 if !self.channel_outbound {
2202 panic!("Tried to create outbound funding_created message on an inbound channel!");
2204 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
2205 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)");
2207 if self.channel_monitor.get_min_seen_secret() != (1 << 48) || self.cur_remote_commitment_transaction_number != (1 << 48) - 1 || self.cur_local_commitment_transaction_number != (1 << 48) - 1 {
2208 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
2211 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
2212 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
2214 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
2217 log_error!(self, "Got bad signatures: {}!", e.err);
2218 self.channel_monitor.unset_funding_info();
2223 let temporary_channel_id = self.channel_id;
2225 // Now that we're past error-generating stuff, update our local state:
2226 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number);
2227 self.channel_state = ChannelState::FundingCreated as u32;
2228 self.channel_id = funding_txo.to_channel_id();
2229 self.cur_remote_commitment_transaction_number -= 1;
2231 Ok((msgs::FundingCreated {
2232 temporary_channel_id: temporary_channel_id,
2233 funding_txid: funding_txo.txid,
2234 funding_output_index: funding_txo.index,
2235 signature: our_signature
2236 }, self.channel_monitor.clone()))
2239 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
2240 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
2241 /// available for use (have exchanged FundingLocked messages in both directions. Should be used
2242 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
2243 /// Note that you can get an announcement for a channel which is closing, though you should
2244 /// likely not announce such a thing. In case its already been announced, a channel_update
2245 /// message can mark the channel disabled.
2246 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), HandleError> {
2247 if !self.announce_publicly {
2248 return Err(HandleError{err: "Channel is not available for public announcements", action: None});
2250 if self.channel_state & (ChannelState::ChannelFunded as u32) != (ChannelState::ChannelFunded as u32) {
2251 return Err(HandleError{err: "Cannot get a ChannelAnnouncement until the channel funding has been locked", action: None});
2254 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
2255 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).unwrap();
2257 let msg = msgs::UnsignedChannelAnnouncement {
2258 features: msgs::GlobalFeatures::new(),
2259 chain_hash: chain_hash,
2260 short_channel_id: self.get_short_channel_id().unwrap(),
2261 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
2262 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
2263 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey },
2264 bitcoin_key_2: if were_node_one { self.their_funding_pubkey } else { our_bitcoin_key },
2267 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
2268 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key).unwrap();
2274 // Send stuff to our remote peers:
2276 /// Adds a pending outbound HTLC to this channel, note that you probably want
2277 /// send_htlc_and_commit instead cause you'll want both messages at once.
2278 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
2279 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
2280 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
2281 pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, HandleError> {
2282 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
2283 return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None});
2286 if amount_msat > self.channel_value_satoshis * 1000 {
2287 return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None});
2289 if amount_msat < self.their_htlc_minimum_msat {
2290 return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None});
2293 let (_, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(false);
2294 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
2295 return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None});
2297 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
2298 // Check their_max_htlc_value_in_flight_msat
2299 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
2300 return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None});
2302 // Check their_channel_reserve_satoshis:
2303 if htlc_inbound_value_msat + htlc_outbound_value_msat + amount_msat + (self.channel_value_satoshis * 1000 - self.value_to_self_msat) > (self.channel_value_satoshis - self.their_channel_reserve_satoshis) * 1000 {
2304 return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None});
2307 //TODO: Check cltv_expiry? Do this in channel manager?
2309 // Now update local state:
2310 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2311 //TODO: Check the limits *including* other pending holding cell HTLCs!
2312 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
2313 amount_msat: amount_msat,
2314 payment_hash: payment_hash,
2315 cltv_expiry: cltv_expiry,
2316 onion_routing_packet: onion_routing_packet,
2317 time_created: Instant::now(),
2322 self.pending_htlcs.push(HTLCOutput {
2324 htlc_id: self.next_local_htlc_id,
2325 amount_msat: amount_msat,
2326 payment_hash: payment_hash.clone(),
2327 cltv_expiry: cltv_expiry,
2328 state: HTLCState::LocalAnnounced,
2330 local_removed_fulfilled: false,
2331 pending_forward_state: None
2334 let res = msgs::UpdateAddHTLC {
2335 channel_id: self.channel_id,
2336 htlc_id: self.next_local_htlc_id,
2337 amount_msat: amount_msat,
2338 payment_hash: payment_hash,
2339 cltv_expiry: cltv_expiry,
2340 onion_routing_packet: onion_routing_packet,
2342 self.next_local_htlc_id += 1;
2347 /// Creates a signed commitment transaction to send to the remote peer.
2348 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2349 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2350 return Err(HandleError{err: "Cannot create commitment tx until channel is fully established", action: None});
2352 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2353 return Err(HandleError{err: "Cannot create commitment tx until remote revokes their previous commitment", action: None});
2355 let mut have_updates = false; // TODO initialize with "have we sent a fee update?"
2356 for htlc in self.pending_htlcs.iter() {
2357 if htlc.state == HTLCState::LocalAnnounced {
2358 have_updates = true;
2360 if have_updates { break; }
2363 return Err(HandleError{err: "Cannot create commitment tx until we have some updates to send", action: None});
2365 self.send_commitment_no_status_check()
2367 /// Only fails in case of bad keys
2368 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> {
2369 let funding_script = self.get_funding_redeemscript();
2371 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
2372 // fail to generate this, we still are at least at a position where upgrading their status
2374 for htlc in self.pending_htlcs.iter_mut() {
2375 if htlc.state == HTLCState::AwaitingRemoteRevokeToAnnounce {
2376 htlc.state = HTLCState::AwaitingAnnouncedRemoteRevoke;
2377 } else if htlc.state == HTLCState::AwaitingRemoteRevokeToRemove {
2378 htlc.state = HTLCState::AwaitingRemovedRemoteRevoke;
2382 let remote_keys = self.build_remote_transaction_keys()?;
2383 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true);
2384 let remote_commitment_txid = remote_commitment_tx.0.txid();
2385 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();
2386 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key).unwrap();
2388 let mut htlc_sigs = Vec::new();
2390 for ref htlc in remote_commitment_tx.1.iter() {
2391 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys);
2392 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
2393 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2394 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));
2395 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key).unwrap());
2398 // Update state now that we've passed all the can-fail calls...
2399 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx.0, remote_commitment_tx.1, self.cur_remote_commitment_transaction_number);
2400 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
2402 Ok((msgs::CommitmentSigned {
2403 channel_id: self.channel_id,
2405 htlc_signatures: htlc_sigs,
2406 }, self.channel_monitor.clone()))
2409 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
2410 /// to send to the remote peer in one go.
2411 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
2413 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, HandleError> {
2414 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, onion_routing_packet)? {
2415 Some(update_add_htlc) => {
2416 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2417 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
2423 /// Begins the shutdown process, getting a message for the remote peer and returning all
2424 /// holding cell HTLCs for payment failure.
2425 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<[u8; 32]>), HandleError> {
2426 for htlc in self.pending_htlcs.iter() {
2427 if htlc.state == HTLCState::LocalAnnounced {
2428 return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", action: None});
2431 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
2432 return Err(HandleError{err: "Shutdown already in progress", action: None});
2434 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2436 let our_closing_script = self.get_closing_scriptpubkey();
2438 // From here on out, we may not fail!
2439 if self.channel_state < ChannelState::FundingSent as u32 {
2440 self.channel_state = ChannelState::ShutdownComplete as u32;
2442 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2444 self.channel_update_count += 1;
2446 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2447 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2448 // cell HTLCs and return them to fail the payment.
2449 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2450 self.holding_cell_htlc_updates.retain(|htlc_update| {
2452 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, .. } => {
2453 dropped_outbound_htlcs.push(payment_hash.clone());
2460 Ok((msgs::Shutdown {
2461 channel_id: self.channel_id,
2462 scriptpubkey: our_closing_script,
2463 }, dropped_outbound_htlcs))
2466 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
2467 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
2468 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
2469 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
2470 /// immediately (others we will have to allow to time out).
2471 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<[u8; 32]>) {
2472 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
2474 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
2475 // return them to fail the payment.
2476 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2477 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
2479 HTLCUpdateAwaitingACK::AddHTLC { payment_hash, .. } => {
2480 dropped_outbound_htlcs.push(payment_hash);
2486 for htlc in self.pending_htlcs.drain(..) {
2487 if htlc.state == HTLCState::LocalAnnounced {
2488 dropped_outbound_htlcs.push(htlc.payment_hash);
2490 //TODO: Do something with the remaining HTLCs
2491 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
2495 self.channel_state = ChannelState::ShutdownComplete as u32;
2496 self.channel_update_count += 1;
2497 let mut res = Vec::new();
2498 mem::swap(&mut res, &mut self.last_local_commitment_txn);
2499 (res, dropped_outbound_htlcs)
2505 use bitcoin::util::hash::Sha256dHash;
2506 use bitcoin::util::bip143;
2507 use bitcoin::network::serialize::serialize;
2508 use bitcoin::blockdata::script::Script;
2509 use bitcoin::blockdata::transaction::Transaction;
2511 use ln::channel::{Channel,ChannelKeys,HTLCOutput,HTLCState,HTLCOutputInCommitment,TxCreationKeys};
2512 use ln::channel::MAX_FUNDING_SATOSHIS;
2514 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
2515 use chain::transaction::OutPoint;
2516 use util::test_utils;
2517 use util::logger::Logger;
2518 use secp256k1::{Secp256k1,Message,Signature};
2519 use secp256k1::key::{SecretKey,PublicKey};
2520 use crypto::sha2::Sha256;
2521 use crypto::digest::Digest;
2524 struct TestFeeEstimator {
2527 impl FeeEstimator for TestFeeEstimator {
2528 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
2534 fn test_max_funding_satoshis() {
2535 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
2536 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
2540 fn outbound_commitment_test() {
2541 // Test vectors from BOLT 3 Appendix C:
2542 let feeest = TestFeeEstimator{fee_est: 15000};
2543 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2544 let secp_ctx = Secp256k1::new();
2546 let chan_keys = ChannelKeys {
2547 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
2548 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2549 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
2550 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
2552 // These aren't set in the test vectors:
2553 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2554 channel_close_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2555 channel_monitor_claim_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
2556 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],
2558 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).unwrap().serialize()[..],
2559 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
2561 let mut chan = Channel::new_outbound(&feeest, chan_keys, PublicKey::new(), 10000000, 100000, false, 42, Arc::clone(&logger)).unwrap(); // Nothing uses their network key in this test
2562 chan.their_to_self_delay = 144;
2563 chan.our_dust_limit_satoshis = 546;
2565 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
2566 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
2568 chan.their_payment_basepoint = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()).unwrap();
2569 assert_eq!(chan.their_payment_basepoint.serialize()[..],
2570 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2572 chan.their_funding_pubkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()).unwrap();
2573 assert_eq!(chan.their_funding_pubkey.serialize()[..],
2574 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
2576 chan.their_htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()).unwrap();
2577 assert_eq!(chan.their_htlc_basepoint.serialize()[..],
2578 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
2580 chan.their_revocation_basepoint = PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap();
2582 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
2583 // derived from a commitment_seed, so instead we copy it here and call
2584 // build_commitment_transaction.
2585 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key).unwrap();
2586 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
2587 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret).unwrap();
2588 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key).unwrap();
2589 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint, &chan.their_payment_basepoint, &chan.their_htlc_basepoint).unwrap();
2591 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
2593 macro_rules! test_commitment {
2594 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
2595 unsigned_tx = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false);
2596 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2597 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();
2598 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey).unwrap();
2600 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
2602 assert_eq!(serialize(&unsigned_tx.0).unwrap()[..],
2603 hex::decode($tx_hex).unwrap()[..]);
2607 macro_rules! test_htlc_output {
2608 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
2609 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
2611 let ref htlc = unsigned_tx.1[$htlc_idx];
2612 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys);
2613 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2614 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
2615 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
2617 let mut preimage: Option<[u8; 32]> = None;
2620 let mut sha = Sha256::new();
2621 sha.input(&[i; 32]);
2623 let mut out = [0; 32];
2624 sha.result(&mut out);
2626 if out == htlc.payment_hash {
2627 preimage = Some([i; 32]);
2631 assert!(preimage.is_some());
2634 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
2635 assert_eq!(serialize(&htlc_tx).unwrap()[..],
2636 hex::decode($tx_hex).unwrap()[..]);
2641 // simple commitment tx with no HTLCs
2642 chan.value_to_self_msat = 7000000000;
2644 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
2645 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
2646 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2649 chan.pending_htlcs.push({
2650 let mut out = HTLCOutput{
2653 amount_msat: 1000000,
2655 payment_hash: [0; 32],
2656 state: HTLCState::Committed,
2658 local_removed_fulfilled: false,
2659 pending_forward_state: None,
2661 let mut sha = Sha256::new();
2662 sha.input(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
2663 sha.result(&mut out.payment_hash);
2666 chan.pending_htlcs.push({
2667 let mut out = HTLCOutput{
2670 amount_msat: 2000000,
2672 payment_hash: [0; 32],
2673 state: HTLCState::Committed,
2675 local_removed_fulfilled: false,
2676 pending_forward_state: None,
2678 let mut sha = Sha256::new();
2679 sha.input(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
2680 sha.result(&mut out.payment_hash);
2683 chan.pending_htlcs.push({
2684 let mut out = HTLCOutput{
2687 amount_msat: 2000000,
2689 payment_hash: [0; 32],
2690 state: HTLCState::Committed,
2692 local_removed_fulfilled: false,
2693 pending_forward_state: None,
2695 let mut sha = Sha256::new();
2696 sha.input(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap());
2697 sha.result(&mut out.payment_hash);
2700 chan.pending_htlcs.push({
2701 let mut out = HTLCOutput{
2704 amount_msat: 3000000,
2706 payment_hash: [0; 32],
2707 state: HTLCState::Committed,
2709 local_removed_fulfilled: false,
2710 pending_forward_state: None,
2712 let mut sha = Sha256::new();
2713 sha.input(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap());
2714 sha.result(&mut out.payment_hash);
2717 chan.pending_htlcs.push({
2718 let mut out = HTLCOutput{
2721 amount_msat: 4000000,
2723 payment_hash: [0; 32],
2724 state: HTLCState::Committed,
2726 local_removed_fulfilled: false,
2727 pending_forward_state: None,
2729 let mut sha = Sha256::new();
2730 sha.input(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap());
2731 sha.result(&mut out.payment_hash);
2736 // commitment tx with all five HTLCs untrimmed (minimum feerate)
2737 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2738 chan.feerate_per_kw = 0;
2740 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
2741 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
2742 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2744 assert_eq!(unsigned_tx.1.len(), 5);
2746 test_htlc_output!(0,
2747 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
2748 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
2749 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
2751 test_htlc_output!(1,
2752 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
2753 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
2754 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2756 test_htlc_output!(2,
2757 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
2758 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
2759 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
2761 test_htlc_output!(3,
2762 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
2763 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
2764 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2766 test_htlc_output!(4,
2767 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
2768 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
2769 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2773 // commitment tx with seven outputs untrimmed (maximum feerate)
2774 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2775 chan.feerate_per_kw = 647;
2777 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
2778 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
2779 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2781 assert_eq!(unsigned_tx.1.len(), 5);
2783 test_htlc_output!(0,
2784 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
2785 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
2786 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
2788 test_htlc_output!(1,
2789 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
2790 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
2791 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2793 test_htlc_output!(2,
2794 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
2795 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
2796 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
2798 test_htlc_output!(3,
2799 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
2800 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
2801 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2803 test_htlc_output!(4,
2804 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
2805 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
2806 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2810 // commitment tx with six outputs untrimmed (minimum feerate)
2811 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2812 chan.feerate_per_kw = 648;
2814 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
2815 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
2816 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2818 assert_eq!(unsigned_tx.1.len(), 4);
2820 test_htlc_output!(0,
2821 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
2822 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
2823 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2825 test_htlc_output!(1,
2826 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
2827 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
2828 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
2830 test_htlc_output!(2,
2831 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
2832 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
2833 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2835 test_htlc_output!(3,
2836 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
2837 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
2838 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2842 // commitment tx with six outputs untrimmed (maximum feerate)
2843 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2844 chan.feerate_per_kw = 2069;
2846 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
2847 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
2848 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2850 assert_eq!(unsigned_tx.1.len(), 4);
2852 test_htlc_output!(0,
2853 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
2854 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
2855 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2857 test_htlc_output!(1,
2858 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
2859 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
2860 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
2862 test_htlc_output!(2,
2863 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
2864 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
2865 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2867 test_htlc_output!(3,
2868 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
2869 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
2870 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2874 // commitment tx with five outputs untrimmed (minimum feerate)
2875 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2876 chan.feerate_per_kw = 2070;
2878 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
2879 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
2880 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2882 assert_eq!(unsigned_tx.1.len(), 3);
2884 test_htlc_output!(0,
2885 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
2886 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
2887 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2889 test_htlc_output!(1,
2890 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
2891 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
2892 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2894 test_htlc_output!(2,
2895 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
2896 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
2897 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2901 // commitment tx with five outputs untrimmed (maximum feerate)
2902 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2903 chan.feerate_per_kw = 2194;
2905 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
2906 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
2907 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2909 assert_eq!(unsigned_tx.1.len(), 3);
2911 test_htlc_output!(0,
2912 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
2913 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
2914 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
2916 test_htlc_output!(1,
2917 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
2918 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
2919 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2921 test_htlc_output!(2,
2922 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
2923 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
2924 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2928 // commitment tx with four outputs untrimmed (minimum feerate)
2929 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2930 chan.feerate_per_kw = 2195;
2932 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
2933 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
2934 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2936 assert_eq!(unsigned_tx.1.len(), 2);
2938 test_htlc_output!(0,
2939 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
2940 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
2941 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2943 test_htlc_output!(1,
2944 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
2945 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
2946 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2950 // commitment tx with four outputs untrimmed (maximum feerate)
2951 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2952 chan.feerate_per_kw = 3702;
2954 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
2955 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
2956 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2958 assert_eq!(unsigned_tx.1.len(), 2);
2960 test_htlc_output!(0,
2961 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
2962 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
2963 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
2965 test_htlc_output!(1,
2966 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
2967 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
2968 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2972 // commitment tx with three outputs untrimmed (minimum feerate)
2973 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2974 chan.feerate_per_kw = 3703;
2976 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
2977 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
2978 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2980 assert_eq!(unsigned_tx.1.len(), 1);
2982 test_htlc_output!(0,
2983 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
2984 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
2985 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
2989 // commitment tx with three outputs untrimmed (maximum feerate)
2990 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
2991 chan.feerate_per_kw = 4914;
2993 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
2994 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
2995 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
2997 assert_eq!(unsigned_tx.1.len(), 1);
2999 test_htlc_output!(0,
3000 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
3001 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
3002 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
3006 // commitment tx with two outputs untrimmed (minimum feerate)
3007 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3008 chan.feerate_per_kw = 4915;
3010 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
3011 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
3012 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3014 assert_eq!(unsigned_tx.1.len(), 0);
3018 // commitment tx with two outputs untrimmed (maximum feerate)
3019 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3020 chan.feerate_per_kw = 9651180;
3022 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
3023 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
3024 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3026 assert_eq!(unsigned_tx.1.len(), 0);
3030 // commitment tx with one output untrimmed (minimum feerate)
3031 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3032 chan.feerate_per_kw = 9651181;
3034 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3035 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3036 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3038 assert_eq!(unsigned_tx.1.len(), 0);
3042 // commitment tx with fee greater than funder amount
3043 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
3044 chan.feerate_per_kw = 9651936;
3046 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
3047 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
3048 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
3050 assert_eq!(unsigned_tx.1.len(), 0);
3055 fn test_per_commitment_secret_gen() {
3056 // Test vectors from BOLT 3 Appendix D:
3058 let mut seed = [0; 32];
3059 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
3060 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3061 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
3063 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
3064 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
3065 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
3067 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
3068 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
3070 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
3071 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
3073 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
3074 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
3075 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
3079 fn test_key_derivation() {
3080 // Test vectors from BOLT 3 Appendix E:
3081 let secp_ctx = Secp256k1::new();
3083 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
3084 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
3086 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret).unwrap();
3087 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
3089 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret).unwrap();
3090 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
3092 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3093 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
3095 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
3096 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
3098 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
3099 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
3101 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
3102 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());