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::BitcoinHash;
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
9 use bitcoin_hashes::{Hash, HashEngine};
10 use bitcoin_hashes::sha256::Hash as Sha256;
11 use bitcoin_hashes::hash160::Hash as Hash160;
12 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
14 use secp256k1::key::{PublicKey,SecretKey};
15 use secp256k1::{Secp256k1,Signature};
19 use ln::msgs::{DecodeError, OptionalField};
20 use ln::channelmonitor::ChannelMonitor;
21 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash};
22 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
24 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
25 use chain::transaction::OutPoint;
26 use chain::keysinterface::{ChannelKeys, KeysInterface};
27 use util::transaction_utils;
28 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
29 use util::logger::{Logger, LogHolder};
30 use util::errors::APIError;
31 use util::config::{UserConfig,ChannelConfig};
34 use std::default::Default;
36 use std::time::Instant;
40 pub struct ChannelValueStat {
41 pub value_to_self_msat: u64,
42 pub channel_value_msat: u64,
43 pub channel_reserve_msat: u64,
44 pub pending_outbound_htlcs_amount_msat: u64,
45 pub pending_inbound_htlcs_amount_msat: u64,
46 pub holding_cell_outbound_amount_msat: u64,
47 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
50 enum InboundHTLCRemovalReason {
51 FailRelay(msgs::OnionErrorPacket),
52 FailMalformed(([u8; 32], u16)),
53 Fulfill(PaymentPreimage),
56 enum InboundHTLCState {
57 /// Added by remote, to be included in next local commitment tx.
58 RemoteAnnounced(PendingHTLCStatus),
59 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
60 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
61 /// accept this HTLC. Implies AwaitingRemoteRevoke.
62 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
63 /// a remote revoke_and_ack on a previous state before we can do so.
64 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
65 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
66 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
67 /// accept this HTLC. Implies AwaitingRemoteRevoke.
68 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
70 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
72 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
73 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
75 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
76 /// commitment transaction without it as otherwise we'll have to force-close the channel to
77 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
78 /// anyway). That said, ChannelMonitor does this for us (see
79 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
80 /// local state before then, once we're sure that the next commitment_signed and
81 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
82 LocalRemoved(InboundHTLCRemovalReason),
85 struct InboundHTLCOutput {
89 payment_hash: PaymentHash,
90 state: InboundHTLCState,
93 enum OutboundHTLCState {
94 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
95 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
96 /// we will promote to Committed (note that they may not accept it until the next time we
97 /// revoke, but we don't really care about that:
98 /// * they've revoked, so worst case we can announce an old state and get our (option on)
99 /// money back (though we won't), and,
100 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
101 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
102 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
103 /// we'll never get out of sync).
104 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
105 /// OutboundHTLCOutput's size just for a temporary bit
106 LocalAnnounced(Box<msgs::OnionPacket>),
108 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
109 /// the change (though they'll need to revoke before we fail the payment).
110 RemoteRemoved(Option<HTLCFailReason>),
111 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
112 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
113 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
114 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
115 /// remote revoke_and_ack on a previous state before we can do so.
116 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
117 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
118 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
119 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
120 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
121 /// revoke_and_ack to drop completely.
122 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
125 struct OutboundHTLCOutput {
129 payment_hash: PaymentHash,
130 state: OutboundHTLCState,
134 /// See AwaitingRemoteRevoke ChannelState for more info
135 enum HTLCUpdateAwaitingACK {
140 payment_hash: PaymentHash,
142 onion_routing_packet: msgs::OnionPacket,
143 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
146 payment_preimage: PaymentPreimage,
151 err_packet: msgs::OnionErrorPacket,
155 /// There are a few "states" and then a number of flags which can be applied:
156 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
157 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
158 /// move on to ChannelFunded.
159 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
160 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
161 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
163 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
164 OurInitSent = (1 << 0),
165 /// Implies we have received their open_channel/accept_channel message
166 TheirInitSent = (1 << 1),
167 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
168 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
169 /// upon receipt of funding_created, so simply skip this state.
171 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
172 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
173 /// and our counterparty consider the funding transaction confirmed.
175 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
176 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
177 TheirFundingLocked = (1 << 4),
178 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
179 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
180 OurFundingLocked = (1 << 5),
182 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
183 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
185 PeerDisconnected = (1 << 7),
186 /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
187 /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
188 /// messages until they've managed to do so.
189 MonitorUpdateFailed = (1 << 8),
190 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
191 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
192 /// messages as then we will be unable to determine which HTLCs they included in their
193 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
195 /// Flag is set on ChannelFunded.
196 AwaitingRemoteRevoke = (1 << 9),
197 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
198 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
199 /// to respond with our own shutdown message when possible.
200 RemoteShutdownSent = (1 << 10),
201 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
202 /// point, we may not add any new HTLCs to the channel.
203 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
204 /// us their shutdown.
205 LocalShutdownSent = (1 << 11),
206 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
207 /// to drop us, but we store this anyway.
208 ShutdownComplete = 4096,
210 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
211 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
213 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
215 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
216 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
217 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
219 pub(super) struct Channel {
220 config: ChannelConfig,
224 channel_id: [u8; 32],
226 channel_outbound: bool,
227 secp_ctx: Secp256k1<secp256k1::All>,
228 channel_value_satoshis: u64,
230 local_keys: ChannelKeys,
231 shutdown_pubkey: PublicKey,
233 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
234 // generation start at 0 and count up...this simplifies some parts of implementation at the
235 // cost of others, but should really just be changed.
237 cur_local_commitment_transaction_number: u64,
238 cur_remote_commitment_transaction_number: u64,
239 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
240 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
241 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
242 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
243 /// remote revoke when we received the latest commitment update from the remote we have to make
244 /// sure that commitment update gets resent first.
245 received_commitment_while_awaiting_raa: bool,
246 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
247 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
248 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
250 monitor_pending_revoke_and_ack: bool,
251 monitor_pending_commitment_signed: bool,
252 monitor_pending_order: Option<RAACommitmentOrder>,
253 monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
254 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
256 // pending_update_fee is filled when sending and receiving update_fee
257 // For outbound channel, feerate_per_kw is updated with the value from
258 // pending_update_fee when revoke_and_ack is received
260 // For inbound channel, feerate_per_kw is updated when it receives
261 // commitment_signed and revoke_and_ack is generated
262 // The pending value is kept when another pair of update_fee and commitment_signed
263 // is received during AwaitingRemoteRevoke and relieved when the expected
264 // revoke_and_ack is received and new commitment_signed is generated to be
265 // sent to the funder. Otherwise, the pending value is removed when receiving
266 // commitment_signed.
267 pending_update_fee: Option<u64>,
268 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
269 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
270 // is received. holding_cell_update_fee is updated when there are additional
271 // update_fee() during ChannelState::AwaitingRemoteRevoke.
272 holding_cell_update_fee: Option<u64>,
273 next_local_htlc_id: u64,
274 next_remote_htlc_id: u64,
275 channel_update_count: u32,
278 #[cfg(debug_assertions)]
279 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
280 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
281 #[cfg(debug_assertions)]
282 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
283 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
286 // Used in ChannelManager's tests to send a revoked transaction
287 pub last_local_commitment_txn: Vec<Transaction>,
289 last_local_commitment_txn: Vec<Transaction>,
291 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
293 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
294 /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
295 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
296 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
297 funding_tx_confirmed_in: Option<Sha256dHash>,
298 short_channel_id: Option<u64>,
299 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
300 /// ChannelManager deserialization (hence pub(super))
301 pub(super) last_block_connected: Sha256dHash,
302 funding_tx_confirmations: u64,
304 their_dust_limit_satoshis: u64,
306 pub(super) our_dust_limit_satoshis: u64,
308 our_dust_limit_satoshis: u64,
310 pub(super) their_max_htlc_value_in_flight_msat: u64,
312 their_max_htlc_value_in_flight_msat: u64,
313 //get_our_max_htlc_value_in_flight_msat(): u64,
314 /// minimum channel reserve for **self** to maintain - set by them.
315 their_channel_reserve_satoshis: u64,
316 //get_our_channel_reserve_satoshis(): u64,
317 their_htlc_minimum_msat: u64,
318 our_htlc_minimum_msat: u64,
319 their_to_self_delay: u16,
320 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
322 pub their_max_accepted_htlcs: u16,
324 their_max_accepted_htlcs: u16,
325 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
328 their_funding_pubkey: Option<PublicKey>,
329 their_revocation_basepoint: Option<PublicKey>,
330 their_payment_basepoint: Option<PublicKey>,
331 their_delayed_payment_basepoint: Option<PublicKey>,
332 their_htlc_basepoint: Option<PublicKey>,
333 their_cur_commitment_point: Option<PublicKey>,
335 their_prev_commitment_point: Option<PublicKey>,
336 their_node_id: PublicKey,
338 their_shutdown_scriptpubkey: Option<Script>,
340 channel_monitor: ChannelMonitor,
345 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
346 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
347 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
348 /// really allow for this, so instead we're stuck closing it out at that point.
349 const UNCONF_THRESHOLD: u32 = 6;
350 /// The amount of time we require our counterparty wait to claim their money (ie time between when
351 /// we, or our watchtower, must check for them having broadcast a theft transaction).
353 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
355 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
356 /// The amount of time we're willing to wait to claim money back to us
357 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
358 /// Exposing these two constants for use in test in ChannelMonitor
359 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
360 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
361 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
362 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?)
363 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
365 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
368 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
370 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 139;
371 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
373 /// Used to return a simple Error back to ChannelManager. Will get converted to a
374 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
375 /// channel_id in ChannelManager.
377 pub(super) enum ChannelError {
378 Ignore(&'static str),
382 macro_rules! secp_check {
383 ($res: expr, $err: expr) => {
386 Err(_) => return Err(ChannelError::Close($err)),
392 // Convert constants + channel value to limits:
393 fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
394 channel_value_satoshis * 1000 / 10 //TODO
397 /// Returns a minimum channel reserve value **they** need to maintain
399 /// Guaranteed to return a value no larger than channel_value_satoshis
400 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
401 let (q, _) = channel_value_satoshis.overflowing_div(100);
402 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
405 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
406 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
409 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
413 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
414 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
416 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
421 pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
422 let chan_keys = keys_provider.get_channel_keys(false);
424 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
425 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
428 if push_msat > channel_value_satoshis * 1000 {
429 return Err(APIError::APIMisuseError{err: "push value > channel value"});
433 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
434 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
435 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
438 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
440 let secp_ctx = Secp256k1::new();
441 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
442 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
443 keys_provider.get_destination_script(), logger.clone());
447 config: config.channel_options.clone(),
449 channel_id: keys_provider.get_channel_id(),
450 channel_state: ChannelState::OurInitSent as u32,
451 channel_outbound: true,
453 channel_value_satoshis: channel_value_satoshis,
455 local_keys: chan_keys,
456 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
457 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
458 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
459 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
460 received_commitment_while_awaiting_raa: false,
462 pending_inbound_htlcs: Vec::new(),
463 pending_outbound_htlcs: Vec::new(),
464 holding_cell_htlc_updates: Vec::new(),
465 pending_update_fee: None,
466 holding_cell_update_fee: None,
467 next_local_htlc_id: 0,
468 next_remote_htlc_id: 0,
469 channel_update_count: 1,
471 monitor_pending_revoke_and_ack: false,
472 monitor_pending_commitment_signed: false,
473 monitor_pending_order: None,
474 monitor_pending_forwards: Vec::new(),
475 monitor_pending_failures: Vec::new(),
477 #[cfg(debug_assertions)]
478 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
479 #[cfg(debug_assertions)]
480 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
482 last_local_commitment_txn: Vec::new(),
484 last_sent_closing_fee: None,
486 funding_tx_confirmed_in: None,
487 short_channel_id: None,
488 last_block_connected: Default::default(),
489 funding_tx_confirmations: 0,
491 feerate_per_kw: feerate,
492 their_dust_limit_satoshis: 0,
493 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
494 their_max_htlc_value_in_flight_msat: 0,
495 their_channel_reserve_satoshis: 0,
496 their_htlc_minimum_msat: 0,
497 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
498 their_to_self_delay: 0,
499 their_max_accepted_htlcs: 0,
500 minimum_depth: 0, // Filled in in accept_channel
502 their_funding_pubkey: None,
503 their_revocation_basepoint: None,
504 their_payment_basepoint: None,
505 their_delayed_payment_basepoint: None,
506 their_htlc_basepoint: None,
507 their_cur_commitment_point: None,
509 their_prev_commitment_point: None,
510 their_node_id: their_node_id,
512 their_shutdown_scriptpubkey: None,
514 channel_monitor: channel_monitor,
520 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
521 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
522 return Err(ChannelError::Close("Peer's feerate much too low"));
524 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
525 return Err(ChannelError::Close("Peer's feerate much too high"));
530 /// Creates a new channel from a remote sides' request for one.
531 /// Assumes chain_hash has already been checked and corresponds with what we expect!
532 pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
533 let chan_keys = keys_provider.get_channel_keys(true);
534 let mut local_config = (*config).channel_options.clone();
536 // Check sanity of message fields:
537 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
538 return Err(ChannelError::Close("funding value > 2^24"));
540 if msg.channel_reserve_satoshis > msg.funding_satoshis {
541 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
543 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
544 return Err(ChannelError::Close("push_msat larger than funding value"));
546 if msg.dust_limit_satoshis > msg.funding_satoshis {
547 return Err(ChannelError::Close("Peer never wants payout outputs?"));
549 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
550 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
552 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
553 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
555 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
557 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
558 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
560 if msg.max_accepted_htlcs < 1 {
561 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
563 if msg.max_accepted_htlcs > 483 {
564 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
567 // Now check against optional parameters as set by config...
568 if msg.funding_satoshis < config.channel_limits.min_funding_satoshis {
569 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
571 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
572 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
574 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
575 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
577 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
578 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
580 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
581 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
583 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
584 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
586 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
587 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
590 // Convert things into internal flags and prep our state:
592 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
593 if config.channel_limits.force_announced_channel_preference {
594 if local_config.announced_channel != their_announce {
595 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
598 // we either accept their preference or the preferences match
599 local_config.announced_channel = their_announce;
601 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
603 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
604 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
605 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
606 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
608 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
609 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
611 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
612 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
615 // check if the funder's amount for the initial commitment tx is sufficient
616 // for full fee payment
617 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
618 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
619 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
622 let to_local_msat = msg.push_msat;
623 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
624 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
625 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
628 let secp_ctx = Secp256k1::new();
629 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
630 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
631 keys_provider.get_destination_script(), logger.clone());
632 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
633 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
635 let mut chan = Channel {
637 config: local_config,
639 channel_id: msg.temporary_channel_id,
640 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
641 channel_outbound: false,
644 local_keys: chan_keys,
645 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
646 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
647 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
648 value_to_self_msat: msg.push_msat,
649 received_commitment_while_awaiting_raa: false,
651 pending_inbound_htlcs: Vec::new(),
652 pending_outbound_htlcs: Vec::new(),
653 holding_cell_htlc_updates: Vec::new(),
654 pending_update_fee: None,
655 holding_cell_update_fee: None,
656 next_local_htlc_id: 0,
657 next_remote_htlc_id: 0,
658 channel_update_count: 1,
660 monitor_pending_revoke_and_ack: false,
661 monitor_pending_commitment_signed: false,
662 monitor_pending_order: None,
663 monitor_pending_forwards: Vec::new(),
664 monitor_pending_failures: Vec::new(),
666 #[cfg(debug_assertions)]
667 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
668 #[cfg(debug_assertions)]
669 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
671 last_local_commitment_txn: Vec::new(),
673 last_sent_closing_fee: None,
675 funding_tx_confirmed_in: None,
676 short_channel_id: None,
677 last_block_connected: Default::default(),
678 funding_tx_confirmations: 0,
680 feerate_per_kw: msg.feerate_per_kw as u64,
681 channel_value_satoshis: msg.funding_satoshis,
682 their_dust_limit_satoshis: msg.dust_limit_satoshis,
683 our_dust_limit_satoshis: our_dust_limit_satoshis,
684 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
685 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
686 their_htlc_minimum_msat: msg.htlc_minimum_msat,
687 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
688 their_to_self_delay: msg.to_self_delay,
689 their_max_accepted_htlcs: msg.max_accepted_htlcs,
690 minimum_depth: Channel::derive_minimum_depth(msg.funding_satoshis*1000, msg.push_msat),
692 their_funding_pubkey: Some(msg.funding_pubkey),
693 their_revocation_basepoint: Some(msg.revocation_basepoint),
694 their_payment_basepoint: Some(msg.payment_basepoint),
695 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
696 their_htlc_basepoint: Some(msg.htlc_basepoint),
697 their_cur_commitment_point: Some(msg.first_per_commitment_point),
699 their_prev_commitment_point: None,
700 their_node_id: their_node_id,
702 their_shutdown_scriptpubkey: None,
704 channel_monitor: channel_monitor,
709 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
710 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
715 // Utilities to derive keys:
717 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
718 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
719 SecretKey::from_slice(&res).unwrap()
722 // Utilities to build transactions:
724 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
725 let mut sha = Sha256::engine();
726 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
728 if self.channel_outbound {
729 sha.input(&our_payment_basepoint.serialize());
730 sha.input(&self.their_payment_basepoint.unwrap().serialize());
732 sha.input(&self.their_payment_basepoint.unwrap().serialize());
733 sha.input(&our_payment_basepoint.serialize());
735 let res = Sha256::from_engine(sha).into_inner();
737 ((res[26] as u64) << 5*8) |
738 ((res[27] as u64) << 4*8) |
739 ((res[28] as u64) << 3*8) |
740 ((res[29] as u64) << 2*8) |
741 ((res[30] as u64) << 1*8) |
742 ((res[31] as u64) << 0*8)
745 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
746 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
747 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
748 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
749 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
751 /// @local is used only to convert relevant internal structures which refer to remote vs local
752 /// to decide value of outputs and direction of HTLCs.
753 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
754 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
755 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
756 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
757 /// which peer generated this transaction and "to whom" this transaction flows.
758 /// Returns (the transaction built, the number of HTLC outputs which were present in the
759 /// transaction, the list of HTLCs which were not ignored when building the transaction).
760 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
761 /// sources are provided only for outbound HTLCs in the third return value.
763 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
764 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
767 let mut ins: Vec<TxIn> = Vec::new();
769 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
770 script_sig: Script::new(),
771 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
777 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
778 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
780 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
781 let mut remote_htlc_total_msat = 0;
782 let mut local_htlc_total_msat = 0;
783 let mut value_to_self_msat_offset = 0;
785 log_trace!(self, "Building commitment transaction number {} for {}, generated by {} with fee {}...", commitment_number, if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
787 macro_rules! get_htlc_in_commitment {
788 ($htlc: expr, $offered: expr) => {
789 HTLCOutputInCommitment {
791 amount_msat: $htlc.amount_msat,
792 cltv_expiry: $htlc.cltv_expiry,
793 payment_hash: $htlc.payment_hash,
794 transaction_output_index: None
799 macro_rules! add_htlc_output {
800 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
801 if $outbound == local { // "offered HTLC output"
802 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
803 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
804 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
806 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
807 value: $htlc.amount_msat / 1000
808 }, Some((htlc_in_tx, $source))));
810 log_trace!(self, " ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
811 included_dust_htlcs.push((htlc_in_tx, $source));
814 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
815 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
816 log_trace!(self, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
817 txouts.push((TxOut { // "received HTLC output"
818 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
819 value: $htlc.amount_msat / 1000
820 }, Some((htlc_in_tx, $source))));
822 log_trace!(self, " ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
823 included_dust_htlcs.push((htlc_in_tx, $source));
829 for ref htlc in self.pending_inbound_htlcs.iter() {
830 let (include, state_name) = match htlc.state {
831 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
832 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
833 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
834 InboundHTLCState::Committed => (true, "Committed"),
835 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
839 add_htlc_output!(htlc, false, None, state_name);
840 remote_htlc_total_msat += htlc.amount_msat;
842 log_trace!(self, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
844 &InboundHTLCState::LocalRemoved(ref reason) => {
845 if generated_by_local {
846 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
847 value_to_self_msat_offset += htlc.amount_msat as i64;
856 for ref htlc in self.pending_outbound_htlcs.iter() {
857 let (include, state_name) = match htlc.state {
858 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
859 OutboundHTLCState::Committed => (true, "Committed"),
860 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
861 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
862 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
866 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
867 local_htlc_total_msat += htlc.amount_msat;
869 log_trace!(self, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
871 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
872 value_to_self_msat_offset -= htlc.amount_msat as i64;
874 OutboundHTLCState::RemoteRemoved(None) => {
875 if !generated_by_local {
876 value_to_self_msat_offset -= htlc.amount_msat as i64;
885 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
886 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset;
888 #[cfg(debug_assertions)]
890 // Make sure that the to_self/to_remote is always either past the appropriate
891 // channel_reserve *or* it is making progress towards it.
892 // TODO: This should happen after fee calculation, but we don't handle that correctly
894 let mut max_commitment_tx_output = if generated_by_local {
895 self.max_commitment_tx_output_local.lock().unwrap()
897 self.max_commitment_tx_output_remote.lock().unwrap()
899 debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
900 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
901 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
902 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
905 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
906 let (value_to_self, value_to_remote) = if self.channel_outbound {
907 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
909 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
912 let value_to_a = if local { value_to_self } else { value_to_remote };
913 let value_to_b = if local { value_to_remote } else { value_to_self };
915 if value_to_a >= (dust_limit_satoshis as i64) {
917 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
918 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
919 &keys.a_delayed_payment_key).to_v0_p2wsh(),
920 value: value_to_a as u64
924 if value_to_b >= (dust_limit_satoshis as i64) {
926 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
927 .push_slice(&Hash160::hash(&keys.b_payment_key.serialize())[..])
929 value: value_to_b as u64
933 transaction_utils::sort_outputs(&mut txouts);
935 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
936 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
937 for (idx, mut out) in txouts.drain(..).enumerate() {
939 if let Some((mut htlc, source_option)) = out.1.take() {
940 htlc.transaction_output_index = Some(idx as u32);
941 htlcs_included.push((htlc, source_option));
944 let non_dust_htlc_count = htlcs_included.len();
945 htlcs_included.append(&mut included_dust_htlcs);
949 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
952 }, non_dust_htlc_count, htlcs_included)
956 fn get_closing_scriptpubkey(&self) -> Script {
957 let our_channel_close_key_hash = Hash160::hash(&self.shutdown_pubkey.serialize());
958 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
962 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
963 (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)
967 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
969 let mut ins: Vec<TxIn> = Vec::new();
971 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
972 script_sig: Script::new(),
973 sequence: 0xffffffff,
979 assert!(self.pending_inbound_htlcs.is_empty());
980 assert!(self.pending_outbound_htlcs.is_empty());
981 let mut txouts: Vec<(TxOut, ())> = Vec::new();
983 let mut total_fee_satoshis = proposed_total_fee_satoshis;
984 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
985 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 };
987 if value_to_self < 0 {
988 assert!(self.channel_outbound);
989 total_fee_satoshis += (-value_to_self) as u64;
990 } else if value_to_remote < 0 {
991 assert!(!self.channel_outbound);
992 total_fee_satoshis += (-value_to_remote) as u64;
995 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
997 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
998 value: value_to_remote as u64
1002 if value_to_self as u64 > self.our_dust_limit_satoshis {
1003 txouts.push((TxOut {
1004 script_pubkey: self.get_closing_scriptpubkey(),
1005 value: value_to_self as u64
1009 transaction_utils::sort_outputs(&mut txouts);
1011 let mut outputs: Vec<TxOut> = Vec::new();
1012 for out in txouts.drain(..) {
1013 outputs.push(out.0);
1021 }, total_fee_satoshis)
1025 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1026 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1027 /// our counterparty!)
1028 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1029 /// TODO Some magic rust shit to compile-time check this?
1030 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1031 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1032 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1033 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1035 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), "Local tx keys generation got bogus keys"))
1039 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1040 /// will sign and send to our counterparty.
1041 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1042 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1043 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1044 //may see payments to it!
1045 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1046 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1047 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1049 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1052 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1053 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1054 /// Panics if called before accept_channel/new_from_req
1055 pub fn get_funding_redeemscript(&self) -> Script {
1056 let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
1057 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1058 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1059 if our_funding_key[..] < their_funding_key[..] {
1060 builder.push_slice(&our_funding_key)
1061 .push_slice(&their_funding_key)
1063 builder.push_slice(&their_funding_key)
1064 .push_slice(&our_funding_key)
1065 }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
1068 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1069 if tx.input.len() != 1 {
1070 panic!("Tried to sign commitment transaction that had input count != 1!");
1072 if tx.input[0].witness.len() != 0 {
1073 panic!("Tried to re-sign commitment transaction");
1076 let funding_redeemscript = self.get_funding_redeemscript();
1078 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
1079 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1081 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1083 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1084 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1085 if our_funding_key[..] < their_funding_key[..] {
1086 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1087 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1089 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1090 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1092 tx.input[0].witness[1].push(SigHashType::All as u8);
1093 tx.input[0].witness[2].push(SigHashType::All as u8);
1095 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1100 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1101 /// @local is used only to convert relevant internal structures which refer to remote vs local
1102 /// to decide value of outputs and direction of HTLCs.
1103 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1104 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1107 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), ChannelError> {
1108 if tx.input.len() != 1 {
1109 panic!("Tried to sign HTLC transaction that had input count != 1!");
1112 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1114 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
1115 let sighash = hash_to_message!(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1116 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1117 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1120 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1121 /// HTLC-Success transaction (ie htlc.offered is false), preimage must be set!
1122 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<PaymentPreimage>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, ChannelError> {
1123 if tx.input.len() != 1 {
1124 panic!("Tried to sign HTLC transaction that had input count != 1!");
1126 if tx.input[0].witness.len() != 0 {
1127 panic!("Tried to re-sign HTLC transaction");
1130 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1132 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1134 if local_tx { // b, then a
1135 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1136 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1138 tx.input[0].witness.push(our_sig.serialize_der().to_vec());
1139 tx.input[0].witness.push(their_sig.serialize_der().to_vec());
1141 tx.input[0].witness[1].push(SigHashType::All as u8);
1142 tx.input[0].witness[2].push(SigHashType::All as u8);
1145 tx.input[0].witness.push(Vec::new());
1147 tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1150 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1155 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1156 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1157 /// Ok(_) if debug assertions are turned on and preconditions are met.
1158 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), ChannelError> {
1159 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1160 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1161 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1163 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1164 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1166 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1168 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1170 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1171 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1172 // these, but for now we just have to treat them as normal.
1174 let mut pending_idx = std::usize::MAX;
1175 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1176 if htlc.htlc_id == htlc_id_arg {
1177 assert_eq!(htlc.payment_hash, payment_hash_calc);
1179 InboundHTLCState::Committed => {},
1180 InboundHTLCState::LocalRemoved(ref reason) => {
1181 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1183 log_warn!(self, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1185 return Ok((None, None));
1188 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1189 // Don't return in release mode here so that we can update channel_monitor
1196 if pending_idx == std::usize::MAX {
1197 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1200 // Now update local state:
1202 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1203 // can claim it even if the channel hits the chain before we see their next commitment.
1204 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1206 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1207 for pending_update in self.holding_cell_htlc_updates.iter() {
1208 match pending_update {
1209 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1210 if htlc_id_arg == htlc_id {
1211 return Ok((None, None));
1214 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1215 if htlc_id_arg == htlc_id {
1216 log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1217 // TODO: We may actually be able to switch to a fulfill here, though its
1218 // rare enough it may not be worth the complexity burden.
1219 return Ok((None, Some(self.channel_monitor.clone())));
1225 log_trace!(self, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1226 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1227 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1229 return Ok((None, Some(self.channel_monitor.clone())));
1233 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1234 if let InboundHTLCState::Committed = htlc.state {
1236 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1237 return Ok((None, Some(self.channel_monitor.clone())));
1239 log_trace!(self, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1240 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1243 Ok((Some(msgs::UpdateFulfillHTLC {
1244 channel_id: self.channel_id(),
1245 htlc_id: htlc_id_arg,
1246 payment_preimage: payment_preimage_arg,
1247 }), Some(self.channel_monitor.clone())))
1250 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), ChannelError> {
1251 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1252 (Some(update_fulfill_htlc), _) => {
1253 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1254 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1256 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1257 (None, None) => Ok((None, None))
1261 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1262 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1263 /// Ok(_) if debug assertions are turned on and preconditions are met.
1264 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1265 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1266 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1268 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1270 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1271 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1272 // these, but for now we just have to treat them as normal.
1274 let mut pending_idx = std::usize::MAX;
1275 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1276 if htlc.htlc_id == htlc_id_arg {
1278 InboundHTLCState::Committed => {},
1279 InboundHTLCState::LocalRemoved(_) => {
1283 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1284 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1290 if pending_idx == std::usize::MAX {
1291 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1294 // Now update local state:
1295 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1296 for pending_update in self.holding_cell_htlc_updates.iter() {
1297 match pending_update {
1298 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1299 if htlc_id_arg == htlc_id {
1300 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1303 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1304 if htlc_id_arg == htlc_id {
1305 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1311 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1312 htlc_id: htlc_id_arg,
1319 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1320 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1323 Ok(Some(msgs::UpdateFailHTLC {
1324 channel_id: self.channel_id(),
1325 htlc_id: htlc_id_arg,
1330 // Message handlers:
1332 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig) -> Result<(), ChannelError> {
1333 // Check sanity of message fields:
1334 if !self.channel_outbound {
1335 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1337 if self.channel_state != ChannelState::OurInitSent as u32 {
1338 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1340 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1341 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1343 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1344 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1346 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1347 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1349 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1350 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1352 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1353 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1355 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1356 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1358 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1359 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1361 if msg.max_accepted_htlcs < 1 {
1362 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel"));
1364 if msg.max_accepted_htlcs > 483 {
1365 return Err(ChannelError::Close("max_accepted_htlcs > 483"));
1368 // Now check against optional parameters as set by config...
1369 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
1370 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1372 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
1373 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1375 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
1376 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1378 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
1379 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1381 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
1382 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1384 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
1385 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1387 if msg.minimum_depth > config.channel_limits.max_minimum_depth {
1388 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1391 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1393 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1394 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1395 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1396 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1397 self.their_to_self_delay = msg.to_self_delay;
1398 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1399 self.minimum_depth = msg.minimum_depth;
1400 self.their_funding_pubkey = Some(msg.funding_pubkey);
1401 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1402 self.their_payment_basepoint = Some(msg.payment_basepoint);
1403 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1404 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1405 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1407 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1408 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1409 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1411 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1416 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), ChannelError> {
1417 let funding_script = self.get_funding_redeemscript();
1419 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1420 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1421 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1423 // They sign the "local" commitment transaction...
1424 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer");
1426 // ...and we sign it, allowing us to broadcast the tx if we wish
1427 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1429 let remote_keys = self.build_remote_transaction_keys()?;
1430 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1431 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1433 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1434 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1437 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), ChannelError> {
1438 if self.channel_outbound {
1439 return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1441 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1442 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1443 // remember the channel, so it's safe to just send an error_message here and drop the
1445 return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1447 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1448 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1449 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1450 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1453 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1454 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1455 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1457 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1460 self.channel_monitor.unset_funding_info();
1465 // Now that we're past error-generating stuff, update our local state:
1467 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1468 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1469 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new());
1470 self.channel_state = ChannelState::FundingSent as u32;
1471 self.channel_id = funding_txo.to_channel_id();
1472 self.cur_remote_commitment_transaction_number -= 1;
1473 self.cur_local_commitment_transaction_number -= 1;
1475 Ok((msgs::FundingSigned {
1476 channel_id: self.channel_id,
1477 signature: our_signature
1478 }, self.channel_monitor.clone()))
1481 /// Handles a funding_signed message from the remote end.
1482 /// If this call is successful, broadcast the funding transaction (and not before!)
1483 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, ChannelError> {
1484 if !self.channel_outbound {
1485 return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1487 if self.channel_state != ChannelState::FundingCreated as u32 {
1488 return Err(ChannelError::Close("Received funding_signed in strange state!"));
1490 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1491 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1492 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1493 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1496 let funding_script = self.get_funding_redeemscript();
1498 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1499 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1500 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1502 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1503 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer");
1505 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1506 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1507 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1508 self.channel_state = ChannelState::FundingSent as u32;
1509 self.cur_local_commitment_transaction_number -= 1;
1511 Ok(self.channel_monitor.clone())
1514 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1515 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1516 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1519 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1521 if non_shutdown_state == ChannelState::FundingSent as u32 {
1522 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1523 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1524 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1525 self.channel_update_count += 1;
1526 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1527 // Note that funding_signed/funding_created will have decremented both by 1!
1528 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1529 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1530 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1531 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1533 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1536 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1539 self.their_prev_commitment_point = self.their_cur_commitment_point;
1540 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1544 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1545 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1546 let mut htlc_inbound_value_msat = 0;
1547 for ref htlc in self.pending_inbound_htlcs.iter() {
1548 htlc_inbound_value_msat += htlc.amount_msat;
1550 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1553 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1555 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1556 let mut htlc_outbound_value_msat = 0;
1557 for ref htlc in self.pending_outbound_htlcs.iter() {
1558 htlc_outbound_value_msat += htlc.amount_msat;
1561 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1562 for update in self.holding_cell_htlc_updates.iter() {
1563 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1564 htlc_outbound_count += 1;
1565 htlc_outbound_value_msat += amount_msat;
1569 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1572 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1573 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1574 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1576 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1577 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1579 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1580 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1582 if msg.amount_msat < self.our_htlc_minimum_msat {
1583 return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1586 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1587 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1588 return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1590 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1591 // Check our_max_htlc_value_in_flight_msat
1592 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1593 return Err(ChannelError::Close("Remote HTLC add would put them over their max HTLC value in flight"));
1595 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1596 // the reserve_satoshis we told them to always have as direct payment so that they lose
1597 // something if we punish them for broadcasting an old state).
1598 // Note that we don't really care about having a small/no to_remote output in our local
1599 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1600 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1601 // present in the next commitment transaction we send them (at least for fulfilled ones,
1602 // failed ones won't modify value_to_self).
1603 // Note that we will send HTLCs which another instance of rust-lightning would think
1604 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1605 // Channel state once they will not be present in the next received commitment
1607 let mut removed_outbound_total_msat = 0;
1608 for ref htlc in self.pending_outbound_htlcs.iter() {
1609 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1610 removed_outbound_total_msat += htlc.amount_msat;
1611 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1612 removed_outbound_total_msat += htlc.amount_msat;
1615 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1616 return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1618 if self.next_remote_htlc_id != msg.htlc_id {
1619 return Err(ChannelError::Close("Remote skipped HTLC ID"));
1621 if msg.cltv_expiry >= 500000000 {
1622 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1625 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1627 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1628 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1629 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1633 // Now update local state:
1634 self.next_remote_htlc_id += 1;
1635 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1636 htlc_id: msg.htlc_id,
1637 amount_msat: msg.amount_msat,
1638 payment_hash: msg.payment_hash,
1639 cltv_expiry: msg.cltv_expiry,
1640 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1645 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1647 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1648 for htlc in self.pending_outbound_htlcs.iter_mut() {
1649 if htlc.htlc_id == htlc_id {
1650 match check_preimage {
1652 Some(payment_hash) =>
1653 if payment_hash != htlc.payment_hash {
1654 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1658 OutboundHTLCState::LocalAnnounced(_) =>
1659 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1660 OutboundHTLCState::Committed => {
1661 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1663 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1664 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1666 return Ok(&htlc.source);
1669 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1672 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1673 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1674 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1676 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1677 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1680 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1681 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1684 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1685 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1686 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1688 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1689 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1692 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1696 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1697 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1698 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1700 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1701 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1704 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1708 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1709 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1710 return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state"));
1712 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1713 return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish"));
1715 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1716 return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds"));
1719 let funding_script = self.get_funding_redeemscript();
1721 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1723 let mut update_fee = false;
1724 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1726 self.pending_update_fee.unwrap()
1731 let mut local_commitment_tx = {
1732 let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1733 let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1734 (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1736 let local_commitment_txid = local_commitment_tx.0.txid();
1737 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1738 log_trace!(self, "Checking commitment tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey.unwrap().serialize()), encode::serialize_hex(&local_commitment_tx.0), encode::serialize_hex(&funding_script));
1739 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
1741 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1743 let num_htlcs = local_commitment_tx.1;
1744 let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1746 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1747 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee"));
1751 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1752 return Err(ChannelError::Close("Got wrong number of HTLC signatures from remote"));
1755 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1 + 1);
1756 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1757 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1759 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1760 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1761 if let Some(_) = htlc.transaction_output_index {
1762 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1763 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1764 log_trace!(self, "Checking HTLC tx signature {} by key {} against tx {} with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript));
1765 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1766 secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
1767 let htlc_sig = if htlc.offered {
1768 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, &htlc, &local_keys)?;
1769 new_local_commitment_txn.push(htlc_tx);
1772 self.create_htlc_tx_signature(&htlc_tx, &htlc, &local_keys)?.1
1774 htlcs_and_sigs.push((htlc, Some((msg.htlc_signatures[idx], htlc_sig)), source));
1776 htlcs_and_sigs.push((htlc, None, source));
1780 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1781 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1783 // Update state now that we've passed all the can-fail calls...
1784 let mut need_our_commitment = false;
1785 if !self.channel_outbound {
1786 if let Some(fee_update) = self.pending_update_fee {
1787 self.feerate_per_kw = fee_update;
1788 // We later use the presence of pending_update_fee to indicate we should generate a
1789 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1790 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1791 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1792 need_our_commitment = true;
1793 self.pending_update_fee = None;
1798 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1799 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1800 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1801 self.monitor_pending_order = None;
1804 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1806 for htlc in self.pending_inbound_htlcs.iter_mut() {
1807 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1808 Some(forward_info.clone())
1810 if let Some(forward_info) = new_forward {
1811 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1812 need_our_commitment = true;
1815 for htlc in self.pending_outbound_htlcs.iter_mut() {
1816 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1817 Some(fail_reason.take())
1819 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1820 need_our_commitment = true;
1824 self.cur_local_commitment_transaction_number -= 1;
1825 self.last_local_commitment_txn = new_local_commitment_txn;
1826 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1828 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1829 // In case we initially failed monitor updating without requiring a response, we need
1830 // to make sure the RAA gets sent first.
1831 if !self.monitor_pending_commitment_signed {
1832 self.monitor_pending_order = Some(RAACommitmentOrder::RevokeAndACKFirst);
1834 self.monitor_pending_revoke_and_ack = true;
1835 if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1836 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1837 // the corresponding HTLC status updates so that get_last_commitment_update
1838 // includes the right HTLCs.
1839 // Note that this generates a monitor update that we ignore! This is OK since we
1840 // won't actually send the commitment_signed that generated the update to the other
1841 // side until the latest monitor has been pulled from us and stored.
1842 self.monitor_pending_commitment_signed = true;
1843 self.send_commitment_no_status_check()?;
1845 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1846 // re-send the message on restoration)
1847 return Err(ChannelError::Ignore("Previous monitor update failure prevented generation of RAA"));
1850 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1851 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1852 // we'll send one right away when we get the revoke_and_ack when we
1853 // free_holding_cell_htlcs().
1854 let (msg, monitor) = self.send_commitment_no_status_check()?;
1855 (Some(msg), monitor, None)
1856 } else if !need_our_commitment {
1857 (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1858 } else { (None, self.channel_monitor.clone(), None) };
1860 Ok((msgs::RevokeAndACK {
1861 channel_id: self.channel_id,
1862 per_commitment_secret: per_commitment_secret,
1863 next_per_commitment_point: next_per_commitment_point,
1864 }, our_commitment_signed, closing_signed, monitor_update))
1867 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1868 /// fulfilling or failing the last pending HTLC)
1869 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, ChannelError> {
1870 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1871 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1872 log_trace!(self, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
1874 let mut htlc_updates = Vec::new();
1875 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1876 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1877 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1878 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1880 for htlc_update in htlc_updates.drain(..) {
1881 // Note that this *can* fail, though it should be due to rather-rare conditions on
1882 // fee races with adding too many outputs which push our total payments just over
1883 // the limit. In case it's less rare than I anticipate, we may want to revisit
1884 // handling this case better and maybe fulfilling some of the HTLCs while attempting
1885 // to rebalance channels.
1886 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1887 self.holding_cell_htlc_updates.push(htlc_update);
1889 match &htlc_update {
1890 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
1891 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1892 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1895 ChannelError::Ignore(ref msg) => {
1896 log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
1899 log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
1906 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
1907 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
1908 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1910 if let ChannelError::Ignore(_) = e {}
1912 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1917 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1918 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1919 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1921 if let ChannelError::Ignore(_) = e {}
1923 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1930 self.holding_cell_htlc_updates.push(htlc_update);
1931 if let Some(ChannelError::Ignore(_)) = err {
1932 // If we failed to add the HTLC, but got an Ignore error, we should
1933 // still send the new commitment_signed, so reset the err to None.
1939 //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
1940 //fail it back the route, if it's a temporary issue we can ignore it...
1943 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1944 // This should never actually happen and indicates we got some Errs back
1945 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1946 // case there is some strange way to hit duplicate HTLC removes.
1949 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1950 self.pending_update_fee = self.holding_cell_update_fee.take();
1951 Some(msgs::UpdateFee {
1952 channel_id: self.channel_id,
1953 feerate_per_kw: feerate as u32,
1958 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1959 Ok(Some((msgs::CommitmentUpdate {
1961 update_fulfill_htlcs,
1963 update_fail_malformed_htlcs: Vec::new(),
1964 update_fee: update_fee,
1966 }, monitor_update)))
1975 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1976 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1977 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1978 /// generating an appropriate error *after* the channel state has been updated based on the
1979 /// revoke_and_ack message.
1980 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1981 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1982 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
1984 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1985 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
1987 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1988 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
1991 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1992 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
1993 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
1996 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
1997 .map_err(|e| ChannelError::Close(e.0))?;
1999 // Update state now that we've passed all the can-fail calls...
2000 // (note that we may still fail to generate the new commitment_signed message, but that's
2001 // OK, we step the channel here and *then* if the new generation fails we can fail the
2002 // channel based on that, but stepping stuff here should be safe either way.
2003 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2004 self.their_prev_commitment_point = self.their_cur_commitment_point;
2005 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2006 self.cur_remote_commitment_transaction_number -= 1;
2007 self.received_commitment_while_awaiting_raa = false;
2008 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
2009 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
2010 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
2011 self.monitor_pending_order = None;
2014 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2015 let mut to_forward_infos = Vec::new();
2016 let mut revoked_htlcs = Vec::new();
2017 let mut update_fail_htlcs = Vec::new();
2018 let mut update_fail_malformed_htlcs = Vec::new();
2019 let mut require_commitment = false;
2020 let mut value_to_self_msat_diff: i64 = 0;
2023 // Take references explicitly so that we can hold multiple references to self.
2024 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2025 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2026 let logger = LogHolder { logger: &self.logger };
2028 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2029 pending_inbound_htlcs.retain(|htlc| {
2030 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2031 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2032 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2033 value_to_self_msat_diff += htlc.amount_msat as i64;
2038 pending_outbound_htlcs.retain(|htlc| {
2039 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2040 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2041 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2042 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2044 // They fulfilled, so we sent them money
2045 value_to_self_msat_diff -= htlc.amount_msat as i64;
2050 for htlc in pending_inbound_htlcs.iter_mut() {
2051 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2052 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2054 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2055 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2059 let mut state = InboundHTLCState::Committed;
2060 mem::swap(&mut state, &mut htlc.state);
2062 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2063 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2064 require_commitment = true;
2065 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2066 match forward_info {
2067 PendingHTLCStatus::Fail(fail_msg) => {
2068 require_commitment = true;
2070 HTLCFailureMsg::Relay(msg) => {
2071 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2072 update_fail_htlcs.push(msg)
2074 HTLCFailureMsg::Malformed(msg) => {
2075 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2076 update_fail_malformed_htlcs.push(msg)
2080 PendingHTLCStatus::Forward(forward_info) => {
2081 to_forward_infos.push((forward_info, htlc.htlc_id));
2082 htlc.state = InboundHTLCState::Committed;
2088 for htlc in pending_outbound_htlcs.iter_mut() {
2089 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2090 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2091 htlc.state = OutboundHTLCState::Committed;
2093 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2094 Some(fail_reason.take())
2096 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2097 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2098 require_commitment = true;
2102 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2104 if self.channel_outbound {
2105 if let Some(feerate) = self.pending_update_fee.take() {
2106 self.feerate_per_kw = feerate;
2109 if let Some(feerate) = self.pending_update_fee {
2110 // Because a node cannot send two commitment_signeds in a row without getting a
2111 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2112 // it should use to create keys with) and because a node can't send a
2113 // commitment_signed without changes, checking if the feerate is equal to the
2114 // pending feerate update is sufficient to detect require_commitment.
2115 if feerate == self.feerate_per_kw {
2116 require_commitment = true;
2117 self.pending_update_fee = None;
2122 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2123 // We can't actually generate a new commitment transaction (incl by freeing holding
2124 // cells) while we can't update the monitor, so we just return what we have.
2125 if require_commitment {
2126 self.monitor_pending_commitment_signed = true;
2127 // When the monitor updating is restored we'll call get_last_commitment_update(),
2128 // which does not update state, but we're definitely now awaiting a remote revoke
2129 // before we can step forward any more, so set it here.
2130 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
2132 self.monitor_pending_forwards.append(&mut to_forward_infos);
2133 self.monitor_pending_failures.append(&mut revoked_htlcs);
2134 return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2137 match self.free_holding_cell_htlcs()? {
2138 Some(mut commitment_update) => {
2139 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2140 for fail_msg in update_fail_htlcs.drain(..) {
2141 commitment_update.0.update_fail_htlcs.push(fail_msg);
2143 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2144 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2145 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2147 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2150 if require_commitment {
2151 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2152 Ok((Some(msgs::CommitmentUpdate {
2153 update_add_htlcs: Vec::new(),
2154 update_fulfill_htlcs: Vec::new(),
2156 update_fail_malformed_htlcs,
2159 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2161 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2168 /// Adds a pending update to this channel. See the doc for send_htlc for
2169 /// further details on the optionness of the return value.
2170 /// You MUST call send_commitment prior to any other calls on this Channel
2171 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2172 if !self.channel_outbound {
2173 panic!("Cannot send fee from inbound channel");
2175 if !self.is_usable() {
2176 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2178 if !self.is_live() {
2179 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2182 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2183 self.holding_cell_update_fee = Some(feerate_per_kw);
2187 debug_assert!(self.pending_update_fee.is_none());
2188 self.pending_update_fee = Some(feerate_per_kw);
2190 Some(msgs::UpdateFee {
2191 channel_id: self.channel_id,
2192 feerate_per_kw: feerate_per_kw as u32,
2196 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
2197 match self.send_update_fee(feerate_per_kw) {
2198 Some(update_fee) => {
2199 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2200 Ok(Some((update_fee, commitment_signed, monitor_update)))
2206 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2207 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2208 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2209 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2210 /// No further message handling calls may be made until a channel_reestablish dance has
2212 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2213 let mut outbound_drops = Vec::new();
2215 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2216 if self.channel_state < ChannelState::FundingSent as u32 {
2217 self.channel_state = ChannelState::ShutdownComplete as u32;
2218 return outbound_drops;
2220 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2221 // will be retransmitted.
2222 self.last_sent_closing_fee = None;
2224 let mut inbound_drop_count = 0;
2225 self.pending_inbound_htlcs.retain(|htlc| {
2227 InboundHTLCState::RemoteAnnounced(_) => {
2228 // They sent us an update_add_htlc but we never got the commitment_signed.
2229 // We'll tell them what commitment_signed we're expecting next and they'll drop
2230 // this HTLC accordingly
2231 inbound_drop_count += 1;
2234 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2235 // We received a commitment_signed updating this HTLC and (at least hopefully)
2236 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2237 // in response to it yet, so don't touch it.
2240 InboundHTLCState::Committed => true,
2241 InboundHTLCState::LocalRemoved(_) => {
2242 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2243 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2244 // (that we missed). Keep this around for now and if they tell us they missed
2245 // the commitment_signed we can re-transmit the update then.
2250 self.next_remote_htlc_id -= inbound_drop_count;
2252 for htlc in self.pending_outbound_htlcs.iter_mut() {
2253 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2254 // They sent us an update to remove this but haven't yet sent the corresponding
2255 // commitment_signed, we need to move it back to Committed and they can re-send
2256 // the update upon reconnection.
2257 htlc.state = OutboundHTLCState::Committed;
2261 self.holding_cell_htlc_updates.retain(|htlc_update| {
2263 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2264 outbound_drops.push((source.clone(), payment_hash.clone()));
2267 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2270 self.channel_state |= ChannelState::PeerDisconnected as u32;
2271 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2275 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2276 /// updates are partially paused.
2277 /// This must be called immediately after the call which generated the ChannelMonitor update
2278 /// which failed, with the order argument set to the type of call it represented (ie a
2279 /// commitment update or a revoke_and_ack generation). The messages which were generated from
2280 /// that original call must *not* have been sent to the remote end, and must instead have been
2281 /// dropped. They will be regenerated when monitor_updating_restored is called.
2282 pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2283 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2284 self.monitor_pending_revoke_and_ack = resend_raa;
2285 self.monitor_pending_commitment_signed = resend_commitment;
2286 self.monitor_pending_order = Some(order);
2287 assert!(self.monitor_pending_forwards.is_empty());
2288 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2289 assert!(self.monitor_pending_failures.is_empty());
2290 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2291 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2294 /// Indicates that the latest ChannelMonitor update has been committed by the client
2295 /// successfully and we should restore normal operation. Returns messages which should be sent
2296 /// to the remote side.
2297 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2298 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2299 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2301 let mut forwards = Vec::new();
2302 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2303 let mut failures = Vec::new();
2304 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2306 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2307 // Leave monitor_pending_order so we can order our channel_reestablish responses
2308 self.monitor_pending_revoke_and_ack = false;
2309 self.monitor_pending_commitment_signed = false;
2310 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2313 let raa = if self.monitor_pending_revoke_and_ack {
2314 Some(self.get_last_revoke_and_ack())
2316 let commitment_update = if self.monitor_pending_commitment_signed {
2317 Some(self.get_last_commitment_update())
2320 self.monitor_pending_revoke_and_ack = false;
2321 self.monitor_pending_commitment_signed = false;
2322 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2325 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2326 if self.channel_outbound {
2327 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2329 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2330 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2332 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2333 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2334 self.channel_update_count += 1;
2338 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2339 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2340 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2341 msgs::RevokeAndACK {
2342 channel_id: self.channel_id,
2343 per_commitment_secret,
2344 next_per_commitment_point,
2348 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2349 let mut update_add_htlcs = Vec::new();
2350 let mut update_fulfill_htlcs = Vec::new();
2351 let mut update_fail_htlcs = Vec::new();
2352 let mut update_fail_malformed_htlcs = Vec::new();
2354 for htlc in self.pending_outbound_htlcs.iter() {
2355 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2356 update_add_htlcs.push(msgs::UpdateAddHTLC {
2357 channel_id: self.channel_id(),
2358 htlc_id: htlc.htlc_id,
2359 amount_msat: htlc.amount_msat,
2360 payment_hash: htlc.payment_hash,
2361 cltv_expiry: htlc.cltv_expiry,
2362 onion_routing_packet: (**onion_packet).clone(),
2367 for htlc in self.pending_inbound_htlcs.iter() {
2368 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2370 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2371 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2372 channel_id: self.channel_id(),
2373 htlc_id: htlc.htlc_id,
2374 reason: err_packet.clone()
2377 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2378 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2379 channel_id: self.channel_id(),
2380 htlc_id: htlc.htlc_id,
2381 sha256_of_onion: sha256_of_onion.clone(),
2382 failure_code: failure_code.clone(),
2385 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2386 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2387 channel_id: self.channel_id(),
2388 htlc_id: htlc.htlc_id,
2389 payment_preimage: payment_preimage.clone(),
2396 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2397 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2398 msgs::CommitmentUpdate {
2399 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2400 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2401 commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2405 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2406 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2407 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2408 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2409 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2410 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2411 // just close here instead of trying to recover.
2412 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2415 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2416 msg.next_local_commitment_number == 0 {
2417 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2420 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2421 // remaining cases either succeed or ErrorMessage-fail).
2422 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2424 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2425 Some(msgs::Shutdown {
2426 channel_id: self.channel_id,
2427 scriptpubkey: self.get_closing_scriptpubkey(),
2431 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2432 if self.channel_state & ChannelState::OurFundingLocked as u32 == 0 {
2433 if msg.next_remote_commitment_number != 0 {
2434 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2436 // Short circuit the whole handler as there is nothing we can resend them
2437 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2440 // We have OurFundingLocked set!
2441 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2442 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2443 return Ok((Some(msgs::FundingLocked {
2444 channel_id: self.channel_id(),
2445 next_per_commitment_point: next_per_commitment_point,
2446 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2449 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2450 // Remote isn't waiting on any RevokeAndACK from us!
2451 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2453 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2454 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2455 self.monitor_pending_revoke_and_ack = true;
2458 Some(self.get_last_revoke_and_ack())
2461 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2464 // We increment cur_remote_commitment_transaction_number only upon receipt of
2465 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2466 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2467 // the corresponding revoke_and_ack back yet.
2468 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2470 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2471 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2472 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2473 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2474 Some(msgs::FundingLocked {
2475 channel_id: self.channel_id(),
2476 next_per_commitment_point: next_per_commitment_point,
2480 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2481 RAACommitmentOrder::CommitmentFirst
2483 RAACommitmentOrder::RevokeAndACKFirst
2486 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2487 if required_revoke.is_some() {
2488 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2490 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2493 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2494 self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2495 // We're up-to-date and not waiting on a remote revoke (if we are our
2496 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2497 // have received some updates while we were disconnected. Free the holding cell
2499 match self.free_holding_cell_htlcs() {
2500 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2501 Err(ChannelError::Ignore(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2502 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order, shutdown_msg)),
2503 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg)),
2506 return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg));
2508 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2509 if required_revoke.is_some() {
2510 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2512 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2515 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2516 self.monitor_pending_commitment_signed = true;
2517 return Ok((resend_funding_locked, None, None, None, order, shutdown_msg));
2520 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order, shutdown_msg));
2522 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2526 fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2527 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2528 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2529 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2533 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2534 if self.feerate_per_kw > proposed_feerate {
2535 proposed_feerate = self.feerate_per_kw;
2537 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2538 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2540 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2541 let funding_redeemscript = self.get_funding_redeemscript();
2542 let sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2544 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2545 Some(msgs::ClosingSigned {
2546 channel_id: self.channel_id,
2547 fee_satoshis: total_fee_satoshis,
2548 signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2552 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError> {
2553 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2554 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2556 if self.channel_state < ChannelState::FundingSent as u32 {
2557 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2558 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2559 // can do that via error message without getting a connection fail anyway...
2560 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2562 for htlc in self.pending_inbound_htlcs.iter() {
2563 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2564 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2567 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2569 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2570 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2571 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2572 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2575 //Check shutdown_scriptpubkey form as BOLT says we must
2576 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2577 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2580 if self.their_shutdown_scriptpubkey.is_some() {
2581 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2582 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2585 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2588 // From here on out, we may not fail!
2590 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2591 self.channel_update_count += 1;
2593 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2594 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2595 // cell HTLCs and return them to fail the payment.
2596 self.holding_cell_update_fee = None;
2597 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2598 self.holding_cell_htlc_updates.retain(|htlc_update| {
2600 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2601 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2607 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2608 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2609 // any further commitment updates after we set LocalShutdownSent.
2611 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2614 Some(msgs::Shutdown {
2615 channel_id: self.channel_id,
2616 scriptpubkey: self.get_closing_scriptpubkey(),
2620 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2621 self.channel_update_count += 1;
2622 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2625 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError> {
2626 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2627 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2629 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2630 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2632 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2633 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2635 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2636 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2639 let funding_redeemscript = self.get_funding_redeemscript();
2640 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2641 if used_total_fee != msg.fee_satoshis {
2642 return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2644 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2646 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2649 // The remote end may have decided to revoke their output due to inconsistent dust
2650 // limits, so check for that case by re-checking the signature here.
2651 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2652 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2653 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer");
2657 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2658 if last_fee == msg.fee_satoshis {
2659 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2660 self.channel_state = ChannelState::ShutdownComplete as u32;
2661 self.channel_update_count += 1;
2662 return Ok((None, Some(closing_tx)));
2666 macro_rules! propose_new_feerate {
2667 ($new_feerate: expr) => {
2668 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2669 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2670 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2671 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2672 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2673 return Ok((Some(msgs::ClosingSigned {
2674 channel_id: self.channel_id,
2675 fee_satoshis: used_total_fee,
2681 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2682 if self.channel_outbound {
2683 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2684 if proposed_sat_per_kw > our_max_feerate {
2685 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2686 if our_max_feerate <= last_feerate {
2687 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2690 propose_new_feerate!(our_max_feerate);
2693 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2694 if proposed_sat_per_kw < our_min_feerate {
2695 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2696 if our_min_feerate >= last_feerate {
2697 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2700 propose_new_feerate!(our_min_feerate);
2704 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2705 self.channel_state = ChannelState::ShutdownComplete as u32;
2706 self.channel_update_count += 1;
2708 Ok((Some(msgs::ClosingSigned {
2709 channel_id: self.channel_id,
2710 fee_satoshis: msg.fee_satoshis,
2712 }), Some(closing_tx)))
2715 // Public utilities:
2717 pub fn channel_id(&self) -> [u8; 32] {
2721 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2722 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2723 pub fn get_user_id(&self) -> u64 {
2727 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2728 pub fn channel_monitor(&self) -> ChannelMonitor {
2729 if self.channel_state < ChannelState::FundingCreated as u32 {
2730 panic!("Can't get a channel monitor until funding has been created");
2732 self.channel_monitor.clone()
2735 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2736 /// is_usable() returns true).
2737 /// Allowed in any state (including after shutdown)
2738 pub fn get_short_channel_id(&self) -> Option<u64> {
2739 self.short_channel_id
2742 /// Returns the funding_txo we either got from our peer, or were given by
2743 /// get_outbound_funding_created.
2744 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2745 self.channel_monitor.get_funding_txo()
2748 /// Allowed in any state (including after shutdown)
2749 pub fn get_their_node_id(&self) -> PublicKey {
2753 /// Allowed in any state (including after shutdown)
2754 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2755 self.our_htlc_minimum_msat
2758 /// Allowed in any state (including after shutdown)
2759 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2760 self.our_htlc_minimum_msat
2763 pub fn get_value_satoshis(&self) -> u64 {
2764 self.channel_value_satoshis
2767 pub fn get_fee_proportional_millionths(&self) -> u32 {
2768 self.config.fee_proportional_millionths
2772 pub fn get_feerate(&self) -> u64 {
2776 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2777 self.cur_local_commitment_transaction_number + 1
2780 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2781 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2784 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2785 self.cur_remote_commitment_transaction_number + 2
2788 //TODO: Testing purpose only, should be changed in another way after #81
2790 pub fn get_local_keys(&self) -> &ChannelKeys {
2795 pub fn get_value_stat(&self) -> ChannelValueStat {
2797 value_to_self_msat: self.value_to_self_msat,
2798 channel_value_msat: self.channel_value_satoshis * 1000,
2799 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2800 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2801 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2802 holding_cell_outbound_amount_msat: {
2804 for h in self.holding_cell_htlc_updates.iter() {
2806 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2814 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2818 /// Allowed in any state (including after shutdown)
2819 pub fn get_channel_update_count(&self) -> u32 {
2820 self.channel_update_count
2823 pub fn should_announce(&self) -> bool {
2824 self.config.announced_channel
2827 pub fn is_outbound(&self) -> bool {
2828 self.channel_outbound
2831 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2832 /// Allowed in any state (including after shutdown)
2833 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2834 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2835 // output value back into a transaction with the regular channel output:
2837 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2838 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2840 if self.channel_outbound {
2841 // + the marginal fee increase cost to us in the commitment transaction:
2842 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2845 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2846 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2851 /// Returns true if we've ever received a message from the remote end for this Channel
2852 pub fn have_received_message(&self) -> bool {
2853 self.channel_state > (ChannelState::OurInitSent as u32)
2856 /// Returns true if this channel is fully established and not known to be closing.
2857 /// Allowed in any state (including after shutdown)
2858 pub fn is_usable(&self) -> bool {
2859 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2860 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2863 /// Returns true if this channel is currently available for use. This is a superset of
2864 /// is_usable() and considers things like the channel being temporarily disabled.
2865 /// Allowed in any state (including after shutdown)
2866 pub fn is_live(&self) -> bool {
2867 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2870 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2871 /// Allowed in any state (including after shutdown)
2872 pub fn is_awaiting_monitor_update(&self) -> bool {
2873 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2876 /// Returns true if funding_created was sent/received.
2877 pub fn is_funding_initiated(&self) -> bool {
2878 self.channel_state >= ChannelState::FundingCreated as u32
2881 /// Returns true if this channel is fully shut down. True here implies that no further actions
2882 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2883 /// will be handled appropriately by the chain monitor.
2884 pub fn is_shutdown(&self) -> bool {
2885 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2886 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2891 /// Called by channelmanager based on chain blocks being connected.
2892 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2893 /// the channel_monitor.
2894 /// In case of Err, the channel may have been closed, at which point the standard requirements
2895 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2896 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2897 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
2898 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2899 if header.bitcoin_hash() != self.last_block_connected {
2900 self.last_block_connected = header.bitcoin_hash();
2901 self.channel_monitor.last_block_hash = self.last_block_connected;
2902 if self.funding_tx_confirmations > 0 {
2903 self.funding_tx_confirmations += 1;
2904 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2905 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2906 self.channel_state |= ChannelState::OurFundingLocked as u32;
2908 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2909 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2910 self.channel_update_count += 1;
2912 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2913 // We got a reorg but not enough to trigger a force close, just update
2914 // funding_tx_confirmed_in and return.
2916 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2917 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2919 // We got a reorg but not enough to trigger a force close, just update
2920 // funding_tx_confirmed_in and return.
2923 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2925 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2926 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2927 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2928 //a protocol oversight, but I assume I'm just missing something.
2929 if need_commitment_update {
2930 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2931 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2932 return Ok(Some(msgs::FundingLocked {
2933 channel_id: self.channel_id,
2934 next_per_commitment_point: next_per_commitment_point,
2940 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2941 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2942 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2943 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2944 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2945 tx.output[txo_idx].value != self.channel_value_satoshis {
2946 if self.channel_outbound {
2947 // If we generated the funding transaction and it doesn't match what it
2948 // should, the client is really broken and we should just panic and
2949 // tell them off. That said, because hash collisions happen with high
2950 // probability in fuzztarget mode, if we're fuzzing we just close the
2951 // channel and move on.
2952 #[cfg(not(feature = "fuzztarget"))]
2953 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2955 self.channel_state = ChannelState::ShutdownComplete as u32;
2956 self.channel_update_count += 1;
2957 return Err(msgs::ErrorMessage {
2958 channel_id: self.channel_id(),
2959 data: "funding tx had wrong script/value".to_owned()
2962 if self.channel_outbound {
2963 for input in tx.input.iter() {
2964 if input.witness.is_empty() {
2965 // We generated a malleable funding transaction, implying we've
2966 // just exposed ourselves to funds loss to our counterparty.
2967 #[cfg(not(feature = "fuzztarget"))]
2968 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2972 self.funding_tx_confirmations = 1;
2973 self.short_channel_id = Some(((height as u64) << (5*8)) |
2974 ((*index_in_block as u64) << (2*8)) |
2975 ((txo_idx as u64) << (0*8)));
2983 /// Called by channelmanager based on chain blocks being disconnected.
2984 /// Returns true if we need to close the channel now due to funding transaction
2985 /// unconfirmation/reorg.
2986 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2987 if self.funding_tx_confirmations > 0 {
2988 self.funding_tx_confirmations -= 1;
2989 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2993 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2994 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2996 self.last_block_connected = header.bitcoin_hash();
2997 self.channel_monitor.last_block_hash = self.last_block_connected;
3001 // Methods to get unprompted messages to send to the remote end (or where we already returned
3002 // something in the handler for the message that prompted this message):
3004 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
3005 if !self.channel_outbound {
3006 panic!("Tried to open a channel for an inbound channel?");
3008 if self.channel_state != ChannelState::OurInitSent as u32 {
3009 panic!("Cannot generate an open_channel after we've moved forward");
3012 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3013 panic!("Tried to send an open_channel for a channel that has already advanced");
3016 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3019 chain_hash: chain_hash,
3020 temporary_channel_id: self.channel_id,
3021 funding_satoshis: self.channel_value_satoshis,
3022 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3023 dust_limit_satoshis: self.our_dust_limit_satoshis,
3024 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3025 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3026 htlc_minimum_msat: self.our_htlc_minimum_msat,
3027 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3028 to_self_delay: BREAKDOWN_TIMEOUT,
3029 max_accepted_htlcs: OUR_MAX_HTLCS,
3030 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3031 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3032 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3033 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3034 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3035 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3036 channel_flags: if self.config.announced_channel {1} else {0},
3037 shutdown_scriptpubkey: OptionalField::Absent
3041 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3042 if self.channel_outbound {
3043 panic!("Tried to send accept_channel for an outbound channel?");
3045 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3046 panic!("Tried to send accept_channel after channel had moved forward");
3048 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3049 panic!("Tried to send an accept_channel for a channel that has already advanced");
3052 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3054 msgs::AcceptChannel {
3055 temporary_channel_id: self.channel_id,
3056 dust_limit_satoshis: self.our_dust_limit_satoshis,
3057 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3058 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3059 htlc_minimum_msat: self.our_htlc_minimum_msat,
3060 minimum_depth: self.minimum_depth,
3061 to_self_delay: BREAKDOWN_TIMEOUT,
3062 max_accepted_htlcs: OUR_MAX_HTLCS,
3063 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
3064 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
3065 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
3066 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
3067 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
3068 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3069 shutdown_scriptpubkey: OptionalField::Absent
3073 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3074 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
3075 let funding_script = self.get_funding_redeemscript();
3077 let remote_keys = self.build_remote_transaction_keys()?;
3078 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3079 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
3081 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
3082 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
3085 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3086 /// a funding_created message for the remote peer.
3087 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3088 /// or if called on an inbound channel.
3089 /// Note that channel_id changes during this call!
3090 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3091 /// If an Err is returned, it is a ChannelError::Close.
3092 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), ChannelError> {
3093 if !self.channel_outbound {
3094 panic!("Tried to create outbound funding_created message on an inbound channel!");
3096 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3097 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)");
3099 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
3100 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3101 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3102 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3105 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
3106 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
3108 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3111 log_error!(self, "Got bad signatures: {:?}!", e);
3112 self.channel_monitor.unset_funding_info();
3117 let temporary_channel_id = self.channel_id;
3119 // Now that we're past error-generating stuff, update our local state:
3120 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3121 self.channel_state = ChannelState::FundingCreated as u32;
3122 self.channel_id = funding_txo.to_channel_id();
3123 self.cur_remote_commitment_transaction_number -= 1;
3125 Ok((msgs::FundingCreated {
3126 temporary_channel_id: temporary_channel_id,
3127 funding_txid: funding_txo.txid,
3128 funding_output_index: funding_txo.index,
3129 signature: our_signature
3130 }, self.channel_monitor.clone()))
3133 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3134 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3135 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3136 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3137 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3139 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3140 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3141 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3142 if !self.config.announced_channel {
3143 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3145 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3146 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3148 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3149 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3152 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3153 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3155 let msg = msgs::UnsignedChannelAnnouncement {
3156 features: msgs::GlobalFeatures::new(),
3157 chain_hash: chain_hash,
3158 short_channel_id: self.get_short_channel_id().unwrap(),
3159 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3160 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3161 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3162 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3163 excess_data: Vec::new(),
3166 let msghash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
3167 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3172 /// May panic if called on a channel that wasn't immediately-previously
3173 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3174 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3175 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3176 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3177 msgs::ChannelReestablish {
3178 channel_id: self.channel_id(),
3179 // The protocol has two different commitment number concepts - the "commitment
3180 // transaction number", which starts from 0 and counts up, and the "revocation key
3181 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3182 // commitment transaction numbers by the index which will be used to reveal the
3183 // revocation key for that commitment transaction, which means we have to convert them
3184 // to protocol-level commitment numbers here...
3186 // next_local_commitment_number is the next commitment_signed number we expect to
3187 // receive (indicating if they need to resend one that we missed).
3188 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3189 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3190 // receive, however we track it by the next commitment number for a remote transaction
3191 // (which is one further, as they always revoke previous commitment transaction, not
3192 // the one we send) so we have to decrement by 1. Note that if
3193 // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3194 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3196 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3197 data_loss_protect: OptionalField::Absent,
3202 // Send stuff to our remote peers:
3204 /// Adds a pending outbound HTLC to this channel, note that you probably want
3205 /// send_htlc_and_commit instead cause you'll want both messages at once.
3206 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3207 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3208 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3209 /// You MUST call send_commitment prior to any other calls on this Channel
3210 /// If an Err is returned, it's a ChannelError::Ignore!
3211 pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<msgs::UpdateAddHTLC>, ChannelError> {
3212 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3213 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3216 if amount_msat > self.channel_value_satoshis * 1000 {
3217 return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3219 if amount_msat < self.their_htlc_minimum_msat {
3220 return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3223 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3224 // Note that this should never really happen, if we're !is_live() on receipt of an
3225 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3226 // the user to send directly into a !is_live() channel. However, if we
3227 // disconnected during the time the previous hop was doing the commitment dance we may
3228 // end up getting here after the forwarding delay. In any case, returning an
3229 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3230 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3233 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3234 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3235 return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3237 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3238 // Check their_max_htlc_value_in_flight_msat
3239 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3240 return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight"));
3243 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3244 // reserve for them to have something to claim if we misbehave)
3245 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3246 return Err(ChannelError::Ignore("Cannot send value that would put us over the reserve value"));
3249 //TODO: Check cltv_expiry? Do this in channel manager?
3251 // Now update local state:
3252 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3253 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3254 amount_msat: amount_msat,
3255 payment_hash: payment_hash,
3256 cltv_expiry: cltv_expiry,
3258 onion_routing_packet: onion_routing_packet,
3259 time_created: Instant::now(),
3264 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3265 htlc_id: self.next_local_htlc_id,
3266 amount_msat: amount_msat,
3267 payment_hash: payment_hash.clone(),
3268 cltv_expiry: cltv_expiry,
3269 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3273 let res = msgs::UpdateAddHTLC {
3274 channel_id: self.channel_id,
3275 htlc_id: self.next_local_htlc_id,
3276 amount_msat: amount_msat,
3277 payment_hash: payment_hash,
3278 cltv_expiry: cltv_expiry,
3279 onion_routing_packet: onion_routing_packet,
3281 self.next_local_htlc_id += 1;
3286 /// Creates a signed commitment transaction to send to the remote peer.
3287 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3288 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3289 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3290 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3291 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3292 panic!("Cannot create commitment tx until channel is fully established");
3294 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3295 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3297 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3298 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3300 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3301 panic!("Cannot create commitment tx while awaiting monitor update unfreeze, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3303 let mut have_updates = self.pending_update_fee.is_some();
3304 for htlc in self.pending_outbound_htlcs.iter() {
3305 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3306 have_updates = true;
3308 if have_updates { break; }
3310 for htlc in self.pending_inbound_htlcs.iter() {
3311 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3312 have_updates = true;
3314 if have_updates { break; }
3317 panic!("Cannot create commitment tx until we have some updates to send");
3319 self.send_commitment_no_status_check()
3321 /// Only fails in case of bad keys
3322 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3323 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3324 // fail to generate this, we still are at least at a position where upgrading their status
3326 for htlc in self.pending_inbound_htlcs.iter_mut() {
3327 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3328 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3330 if let Some(state) = new_state {
3334 for htlc in self.pending_outbound_htlcs.iter_mut() {
3335 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3336 Some(fail_reason.take())
3338 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3342 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3343 Ok((res, (remote_commitment_tx, mut htlcs))) => {
3344 // Update state now that we've passed all the can-fail calls...
3345 let htlcs_no_ref = htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3346 (res, remote_commitment_tx, htlcs_no_ref)
3348 Err(e) => return Err(e),
3351 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx, htlcs, self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3352 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3353 Ok((res, self.channel_monitor.clone()))
3356 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3357 /// when we shouldn't change HTLC/channel state.
3358 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3359 let funding_script = self.get_funding_redeemscript();
3361 let mut feerate_per_kw = self.feerate_per_kw;
3362 if let Some(feerate) = self.pending_update_fee {
3363 if self.channel_outbound {
3364 feerate_per_kw = feerate;
3368 let remote_keys = self.build_remote_transaction_keys()?;
3369 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3370 let remote_commitment_txid = remote_commitment_tx.0.txid();
3371 let remote_sighash = hash_to_message!(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
3372 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3373 log_trace!(self, "Signing remote commitment tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&remote_commitment_tx.0), encode::serialize_hex(&funding_script), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize()), log_bytes!(our_sig.serialize_compact()[..]));
3375 let mut htlc_sigs = Vec::with_capacity(remote_commitment_tx.1);
3376 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3377 if let Some(_) = htlc.transaction_output_index {
3378 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3379 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3380 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
3381 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
3382 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3383 log_trace!(self, "Signing remote HTLC tx {} with redeemscript {} with pubkey {} -> {}", encode::serialize_hex(&htlc_tx), encode::serialize_hex(&htlc_redeemscript), log_bytes!(PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key).serialize()), log_bytes!(htlc_sigs.last().unwrap().serialize_compact()[..]));
3387 Ok((msgs::CommitmentSigned {
3388 channel_id: self.channel_id,
3390 htlc_signatures: htlc_sigs,
3391 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3394 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3395 /// to send to the remote peer in one go.
3396 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3398 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
3399 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3400 Some(update_add_htlc) => {
3401 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3402 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3408 /// Begins the shutdown process, getting a message for the remote peer and returning all
3409 /// holding cell HTLCs for payment failure.
3410 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3411 for htlc in self.pending_outbound_htlcs.iter() {
3412 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3413 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3416 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3417 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3418 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3420 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3421 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3424 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3425 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3426 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3429 let our_closing_script = self.get_closing_scriptpubkey();
3431 // From here on out, we may not fail!
3432 if self.channel_state < ChannelState::FundingSent as u32 {
3433 self.channel_state = ChannelState::ShutdownComplete as u32;
3435 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3437 self.channel_update_count += 1;
3439 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3440 // our shutdown until we've committed all of the pending changes.
3441 self.holding_cell_update_fee = None;
3442 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3443 self.holding_cell_htlc_updates.retain(|htlc_update| {
3445 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3446 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3453 Ok((msgs::Shutdown {
3454 channel_id: self.channel_id,
3455 scriptpubkey: our_closing_script,
3456 }, dropped_outbound_htlcs))
3459 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3460 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3461 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3462 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3463 /// immediately (others we will have to allow to time out).
3464 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>) {
3465 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3467 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3468 // return them to fail the payment.
3469 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3470 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3472 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3473 dropped_outbound_htlcs.push((source, payment_hash));
3479 for _htlc in self.pending_outbound_htlcs.drain(..) {
3480 //TODO: Do something with the remaining HTLCs
3481 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3485 self.channel_state = ChannelState::ShutdownComplete as u32;
3486 self.channel_update_count += 1;
3487 let mut res = Vec::new();
3488 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3489 (res, dropped_outbound_htlcs)
3493 const SERIALIZATION_VERSION: u8 = 1;
3494 const MIN_SERIALIZATION_VERSION: u8 = 1;
3496 impl Writeable for InboundHTLCRemovalReason {
3497 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3499 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3501 error_packet.write(writer)?;
3503 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3505 onion_hash.write(writer)?;
3506 err_code.write(writer)?;
3508 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3510 payment_preimage.write(writer)?;
3517 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3518 fn read(reader: &mut R) -> Result<Self, DecodeError> {
3519 Ok(match <u8 as Readable<R>>::read(reader)? {
3520 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3521 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3522 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3523 _ => return Err(DecodeError::InvalidValue),
3528 impl Writeable for Channel {
3529 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3530 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3531 // called but include holding cell updates (and obviously we don't modify self).
3533 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3534 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3536 self.user_id.write(writer)?;
3537 self.config.write(writer)?;
3539 self.channel_id.write(writer)?;
3540 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3541 self.channel_outbound.write(writer)?;
3542 self.channel_value_satoshis.write(writer)?;
3544 self.local_keys.write(writer)?;
3545 self.shutdown_pubkey.write(writer)?;
3547 self.cur_local_commitment_transaction_number.write(writer)?;
3548 self.cur_remote_commitment_transaction_number.write(writer)?;
3549 self.value_to_self_msat.write(writer)?;
3551 self.received_commitment_while_awaiting_raa.write(writer)?;
3553 let mut dropped_inbound_htlcs = 0;
3554 for htlc in self.pending_inbound_htlcs.iter() {
3555 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3556 dropped_inbound_htlcs += 1;
3559 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3560 for htlc in self.pending_inbound_htlcs.iter() {
3561 htlc.htlc_id.write(writer)?;
3562 htlc.amount_msat.write(writer)?;
3563 htlc.cltv_expiry.write(writer)?;
3564 htlc.payment_hash.write(writer)?;
3566 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3567 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3569 htlc_state.write(writer)?;
3571 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3573 htlc_state.write(writer)?;
3575 &InboundHTLCState::Committed => {
3578 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3580 removal_reason.write(writer)?;
3585 macro_rules! write_option {
3588 &None => 0u8.write(writer)?,
3597 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3598 for htlc in self.pending_outbound_htlcs.iter() {
3599 htlc.htlc_id.write(writer)?;
3600 htlc.amount_msat.write(writer)?;
3601 htlc.cltv_expiry.write(writer)?;
3602 htlc.payment_hash.write(writer)?;
3603 htlc.source.write(writer)?;
3605 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3607 onion_packet.write(writer)?;
3609 &OutboundHTLCState::Committed => {
3612 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3614 write_option!(*fail_reason);
3616 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3618 write_option!(*fail_reason);
3620 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3622 write_option!(*fail_reason);
3627 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3628 for update in self.holding_cell_htlc_updates.iter() {
3630 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, time_created: _ } => {
3632 amount_msat.write(writer)?;
3633 cltv_expiry.write(writer)?;
3634 payment_hash.write(writer)?;
3635 source.write(writer)?;
3636 onion_routing_packet.write(writer)?;
3637 // time_created is not serialized - we re-init the timeout upon deserialization
3639 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3641 payment_preimage.write(writer)?;
3642 htlc_id.write(writer)?;
3644 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3646 htlc_id.write(writer)?;
3647 err_packet.write(writer)?;
3652 self.monitor_pending_revoke_and_ack.write(writer)?;
3653 self.monitor_pending_commitment_signed.write(writer)?;
3654 match self.monitor_pending_order {
3655 None => 0u8.write(writer)?,
3656 Some(RAACommitmentOrder::CommitmentFirst) => 1u8.write(writer)?,
3657 Some(RAACommitmentOrder::RevokeAndACKFirst) => 2u8.write(writer)?,
3660 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3661 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3662 pending_forward.write(writer)?;
3663 htlc_id.write(writer)?;
3666 (self.monitor_pending_failures.len() as u64).write(writer)?;
3667 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3668 htlc_source.write(writer)?;
3669 payment_hash.write(writer)?;
3670 fail_reason.write(writer)?;
3673 write_option!(self.pending_update_fee);
3674 write_option!(self.holding_cell_update_fee);
3676 self.next_local_htlc_id.write(writer)?;
3677 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3678 self.channel_update_count.write(writer)?;
3679 self.feerate_per_kw.write(writer)?;
3681 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3682 for tx in self.last_local_commitment_txn.iter() {
3683 if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3685 encode::Error::Io(e) => return Err(e),
3686 _ => panic!("last_local_commitment_txn must have been well-formed!"),
3691 match self.last_sent_closing_fee {
3692 Some((feerate, fee)) => {
3694 feerate.write(writer)?;
3697 None => 0u8.write(writer)?,
3700 write_option!(self.funding_tx_confirmed_in);
3701 write_option!(self.short_channel_id);
3703 self.last_block_connected.write(writer)?;
3704 self.funding_tx_confirmations.write(writer)?;
3706 self.their_dust_limit_satoshis.write(writer)?;
3707 self.our_dust_limit_satoshis.write(writer)?;
3708 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3709 self.their_channel_reserve_satoshis.write(writer)?;
3710 self.their_htlc_minimum_msat.write(writer)?;
3711 self.our_htlc_minimum_msat.write(writer)?;
3712 self.their_to_self_delay.write(writer)?;
3713 self.their_max_accepted_htlcs.write(writer)?;
3714 self.minimum_depth.write(writer)?;
3716 write_option!(self.their_funding_pubkey);
3717 write_option!(self.their_revocation_basepoint);
3718 write_option!(self.their_payment_basepoint);
3719 write_option!(self.their_delayed_payment_basepoint);
3720 write_option!(self.their_htlc_basepoint);
3721 write_option!(self.their_cur_commitment_point);
3723 write_option!(self.their_prev_commitment_point);
3724 self.their_node_id.write(writer)?;
3726 write_option!(self.their_shutdown_scriptpubkey);
3728 self.channel_monitor.write_for_disk(writer)?;
3733 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3734 fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3735 let _ver: u8 = Readable::read(reader)?;
3736 let min_ver: u8 = Readable::read(reader)?;
3737 if min_ver > SERIALIZATION_VERSION {
3738 return Err(DecodeError::UnknownVersion);
3741 let user_id = Readable::read(reader)?;
3742 let config: ChannelConfig = Readable::read(reader)?;
3744 let channel_id = Readable::read(reader)?;
3745 let channel_state = Readable::read(reader)?;
3746 let channel_outbound = Readable::read(reader)?;
3747 let channel_value_satoshis = Readable::read(reader)?;
3749 let local_keys = Readable::read(reader)?;
3750 let shutdown_pubkey = Readable::read(reader)?;
3752 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3753 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3754 let value_to_self_msat = Readable::read(reader)?;
3756 let received_commitment_while_awaiting_raa = Readable::read(reader)?;
3758 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3759 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3760 for _ in 0..pending_inbound_htlc_count {
3761 pending_inbound_htlcs.push(InboundHTLCOutput {
3762 htlc_id: Readable::read(reader)?,
3763 amount_msat: Readable::read(reader)?,
3764 cltv_expiry: Readable::read(reader)?,
3765 payment_hash: Readable::read(reader)?,
3766 state: match <u8 as Readable<R>>::read(reader)? {
3767 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3768 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3769 3 => InboundHTLCState::Committed,
3770 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3771 _ => return Err(DecodeError::InvalidValue),
3776 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3777 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3778 for _ in 0..pending_outbound_htlc_count {
3779 pending_outbound_htlcs.push(OutboundHTLCOutput {
3780 htlc_id: Readable::read(reader)?,
3781 amount_msat: Readable::read(reader)?,
3782 cltv_expiry: Readable::read(reader)?,
3783 payment_hash: Readable::read(reader)?,
3784 source: Readable::read(reader)?,
3785 state: match <u8 as Readable<R>>::read(reader)? {
3786 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3787 1 => OutboundHTLCState::Committed,
3788 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
3789 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
3790 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
3791 _ => return Err(DecodeError::InvalidValue),
3796 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3797 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3798 for _ in 0..holding_cell_htlc_update_count {
3799 holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3800 0 => HTLCUpdateAwaitingACK::AddHTLC {
3801 amount_msat: Readable::read(reader)?,
3802 cltv_expiry: Readable::read(reader)?,
3803 payment_hash: Readable::read(reader)?,
3804 source: Readable::read(reader)?,
3805 onion_routing_packet: Readable::read(reader)?,
3806 time_created: Instant::now(),
3808 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3809 payment_preimage: Readable::read(reader)?,
3810 htlc_id: Readable::read(reader)?,
3812 2 => HTLCUpdateAwaitingACK::FailHTLC {
3813 htlc_id: Readable::read(reader)?,
3814 err_packet: Readable::read(reader)?,
3816 _ => return Err(DecodeError::InvalidValue),
3820 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3821 let monitor_pending_commitment_signed = Readable::read(reader)?;
3823 let monitor_pending_order = match <u8 as Readable<R>>::read(reader)? {
3825 1 => Some(RAACommitmentOrder::CommitmentFirst),
3826 2 => Some(RAACommitmentOrder::RevokeAndACKFirst),
3827 _ => return Err(DecodeError::InvalidValue),
3830 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3831 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3832 for _ in 0..monitor_pending_forwards_count {
3833 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3836 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3837 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3838 for _ in 0..monitor_pending_failures_count {
3839 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3842 let pending_update_fee = Readable::read(reader)?;
3843 let holding_cell_update_fee = Readable::read(reader)?;
3845 let next_local_htlc_id = Readable::read(reader)?;
3846 let next_remote_htlc_id = Readable::read(reader)?;
3847 let channel_update_count = Readable::read(reader)?;
3848 let feerate_per_kw = Readable::read(reader)?;
3850 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3851 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3852 for _ in 0..last_local_commitment_txn_count {
3853 last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3855 Err(_) => return Err(DecodeError::InvalidValue),
3859 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3861 1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3862 _ => return Err(DecodeError::InvalidValue),
3865 let funding_tx_confirmed_in = Readable::read(reader)?;
3866 let short_channel_id = Readable::read(reader)?;
3868 let last_block_connected = Readable::read(reader)?;
3869 let funding_tx_confirmations = Readable::read(reader)?;
3871 let their_dust_limit_satoshis = Readable::read(reader)?;
3872 let our_dust_limit_satoshis = Readable::read(reader)?;
3873 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3874 let their_channel_reserve_satoshis = Readable::read(reader)?;
3875 let their_htlc_minimum_msat = Readable::read(reader)?;
3876 let our_htlc_minimum_msat = Readable::read(reader)?;
3877 let their_to_self_delay = Readable::read(reader)?;
3878 let their_max_accepted_htlcs = Readable::read(reader)?;
3879 let minimum_depth = Readable::read(reader)?;
3881 let their_funding_pubkey = Readable::read(reader)?;
3882 let their_revocation_basepoint = Readable::read(reader)?;
3883 let their_payment_basepoint = Readable::read(reader)?;
3884 let their_delayed_payment_basepoint = Readable::read(reader)?;
3885 let their_htlc_basepoint = Readable::read(reader)?;
3886 let their_cur_commitment_point = Readable::read(reader)?;
3888 let their_prev_commitment_point = Readable::read(reader)?;
3889 let their_node_id = Readable::read(reader)?;
3891 let their_shutdown_scriptpubkey = Readable::read(reader)?;
3892 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3893 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3894 // doing full block connection operations on the internal CHannelMonitor copies
3895 if monitor_last_block != last_block_connected {
3896 return Err(DecodeError::InvalidValue);
3906 secp_ctx: Secp256k1::new(),
3907 channel_value_satoshis,
3912 cur_local_commitment_transaction_number,
3913 cur_remote_commitment_transaction_number,
3916 received_commitment_while_awaiting_raa,
3917 pending_inbound_htlcs,
3918 pending_outbound_htlcs,
3919 holding_cell_htlc_updates,
3921 monitor_pending_revoke_and_ack,
3922 monitor_pending_commitment_signed,
3923 monitor_pending_order,
3924 monitor_pending_forwards,
3925 monitor_pending_failures,
3928 holding_cell_update_fee,
3930 next_remote_htlc_id,
3931 channel_update_count,
3934 #[cfg(debug_assertions)]
3935 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3936 #[cfg(debug_assertions)]
3937 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3939 last_local_commitment_txn,
3941 last_sent_closing_fee,
3943 funding_tx_confirmed_in,
3945 last_block_connected,
3946 funding_tx_confirmations,
3948 their_dust_limit_satoshis,
3949 our_dust_limit_satoshis,
3950 their_max_htlc_value_in_flight_msat,
3951 their_channel_reserve_satoshis,
3952 their_htlc_minimum_msat,
3953 our_htlc_minimum_msat,
3954 their_to_self_delay,
3955 their_max_accepted_htlcs,
3958 their_funding_pubkey,
3959 their_revocation_basepoint,
3960 their_payment_basepoint,
3961 their_delayed_payment_basepoint,
3962 their_htlc_basepoint,
3963 their_cur_commitment_point,
3965 their_prev_commitment_point,
3968 their_shutdown_scriptpubkey,
3979 use bitcoin::util::bip143;
3980 use bitcoin::consensus::encode::serialize;
3981 use bitcoin::blockdata::script::{Script, Builder};
3982 use bitcoin::blockdata::transaction::Transaction;
3983 use bitcoin::blockdata::opcodes;
3984 use bitcoin_hashes::hex::FromHex;
3986 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
3987 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3988 use ln::channel::MAX_FUNDING_SATOSHIS;
3990 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3991 use chain::keysinterface::KeysInterface;
3992 use chain::transaction::OutPoint;
3993 use util::config::UserConfig;
3994 use util::test_utils;
3995 use util::logger::Logger;
3996 use secp256k1::{Secp256k1,Message,Signature};
3997 use secp256k1::key::{SecretKey,PublicKey};
3998 use bitcoin_hashes::sha256::Hash as Sha256;
3999 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
4000 use bitcoin_hashes::hash160::Hash as Hash160;
4001 use bitcoin_hashes::Hash;
4004 struct TestFeeEstimator {
4007 impl FeeEstimator for TestFeeEstimator {
4008 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4014 fn test_max_funding_satoshis() {
4015 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4016 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4020 chan_keys: ChannelKeys,
4022 impl KeysInterface for Keys {
4023 fn get_node_secret(&self) -> SecretKey { panic!(); }
4024 fn get_destination_script(&self) -> Script {
4025 let secp_ctx = Secp256k1::signing_only();
4026 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4027 let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4028 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4031 fn get_shutdown_pubkey(&self) -> PublicKey {
4032 let secp_ctx = Secp256k1::signing_only();
4033 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4034 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4037 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
4038 fn get_session_key(&self) -> SecretKey { panic!(); }
4039 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4043 fn outbound_commitment_test() {
4044 // Test vectors from BOLT 3 Appendix C:
4045 let feeest = TestFeeEstimator{fee_est: 15000};
4046 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4047 let secp_ctx = Secp256k1::new();
4049 let chan_keys = ChannelKeys {
4050 funding_key: SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4051 payment_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4052 delayed_payment_base_key: SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4053 htlc_base_key: SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4055 // These aren't set in the test vectors:
4056 revocation_base_key: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4057 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],
4059 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
4060 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4061 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
4063 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4064 let mut config = UserConfig::new();
4065 config.channel_options.announced_channel = false;
4066 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4067 chan.their_to_self_delay = 144;
4068 chan.our_dust_limit_satoshis = 546;
4070 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4071 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
4073 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4074 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
4075 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4077 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
4078 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
4079 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4081 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4082 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
4083 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4085 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
4087 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4088 // derived from a commitment_seed, so instead we copy it here and call
4089 // build_commitment_transaction.
4090 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
4091 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4092 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4093 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
4094 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
4096 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4098 macro_rules! test_commitment {
4099 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
4101 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4102 let htlcs = res.2.drain(..)
4103 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4107 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4108 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();
4109 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
4111 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
4113 assert_eq!(serialize(&unsigned_tx.0)[..],
4114 hex::decode($tx_hex).unwrap()[..]);
4118 macro_rules! test_htlc_output {
4119 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4120 let remote_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4122 let ref htlc = unsigned_tx.1[$htlc_idx];
4123 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4124 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4125 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4126 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4128 let mut preimage: Option<PaymentPreimage> = None;
4131 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4132 if out == htlc.payment_hash {
4133 preimage = Some(PaymentPreimage([i; 32]));
4137 assert!(preimage.is_some());
4140 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
4141 assert_eq!(serialize(&htlc_tx)[..],
4142 hex::decode($tx_hex).unwrap()[..]);
4147 // simple commitment tx with no HTLCs
4148 chan.value_to_self_msat = 7000000000;
4150 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4151 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4152 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4155 chan.pending_inbound_htlcs.push({
4156 let mut out = InboundHTLCOutput{
4158 amount_msat: 1000000,
4160 payment_hash: PaymentHash([0; 32]),
4161 state: InboundHTLCState::Committed,
4163 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4166 chan.pending_inbound_htlcs.push({
4167 let mut out = InboundHTLCOutput{
4169 amount_msat: 2000000,
4171 payment_hash: PaymentHash([0; 32]),
4172 state: InboundHTLCState::Committed,
4174 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4177 chan.pending_outbound_htlcs.push({
4178 let mut out = OutboundHTLCOutput{
4180 amount_msat: 2000000,
4182 payment_hash: PaymentHash([0; 32]),
4183 state: OutboundHTLCState::Committed,
4184 source: HTLCSource::dummy(),
4186 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4189 chan.pending_outbound_htlcs.push({
4190 let mut out = OutboundHTLCOutput{
4192 amount_msat: 3000000,
4194 payment_hash: PaymentHash([0; 32]),
4195 state: OutboundHTLCState::Committed,
4196 source: HTLCSource::dummy(),
4198 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4201 chan.pending_inbound_htlcs.push({
4202 let mut out = InboundHTLCOutput{
4204 amount_msat: 4000000,
4206 payment_hash: PaymentHash([0; 32]),
4207 state: InboundHTLCState::Committed,
4209 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4214 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4215 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4216 chan.feerate_per_kw = 0;
4218 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4219 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4220 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4222 assert_eq!(unsigned_tx.1.len(), 5);
4224 test_htlc_output!(0,
4225 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4226 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4227 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4229 test_htlc_output!(1,
4230 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4231 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4232 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4234 test_htlc_output!(2,
4235 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4236 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4237 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4239 test_htlc_output!(3,
4240 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4241 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4242 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4244 test_htlc_output!(4,
4245 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4246 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4247 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4251 // commitment tx with seven outputs untrimmed (maximum feerate)
4252 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4253 chan.feerate_per_kw = 647;
4255 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4256 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4257 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4259 assert_eq!(unsigned_tx.1.len(), 5);
4261 test_htlc_output!(0,
4262 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4263 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4264 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4266 test_htlc_output!(1,
4267 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4268 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4269 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4271 test_htlc_output!(2,
4272 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4273 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4274 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4276 test_htlc_output!(3,
4277 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4278 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4279 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4281 test_htlc_output!(4,
4282 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4283 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4284 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4288 // commitment tx with six outputs untrimmed (minimum feerate)
4289 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4290 chan.feerate_per_kw = 648;
4292 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4293 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4294 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4296 assert_eq!(unsigned_tx.1.len(), 4);
4298 test_htlc_output!(0,
4299 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4300 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4301 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4303 test_htlc_output!(1,
4304 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4305 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4306 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4308 test_htlc_output!(2,
4309 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4310 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4311 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4313 test_htlc_output!(3,
4314 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4315 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4316 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4320 // commitment tx with six outputs untrimmed (maximum feerate)
4321 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4322 chan.feerate_per_kw = 2069;
4324 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4325 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4326 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4328 assert_eq!(unsigned_tx.1.len(), 4);
4330 test_htlc_output!(0,
4331 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4332 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4333 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4335 test_htlc_output!(1,
4336 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4337 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4338 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4340 test_htlc_output!(2,
4341 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4342 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4343 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4345 test_htlc_output!(3,
4346 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4347 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4348 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4352 // commitment tx with five outputs untrimmed (minimum feerate)
4353 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4354 chan.feerate_per_kw = 2070;
4356 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4357 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4358 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4360 assert_eq!(unsigned_tx.1.len(), 3);
4362 test_htlc_output!(0,
4363 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4364 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4365 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4367 test_htlc_output!(1,
4368 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4369 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4370 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4372 test_htlc_output!(2,
4373 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4374 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4375 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4379 // commitment tx with five outputs untrimmed (maximum feerate)
4380 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4381 chan.feerate_per_kw = 2194;
4383 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4384 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4385 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4387 assert_eq!(unsigned_tx.1.len(), 3);
4389 test_htlc_output!(0,
4390 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4391 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4392 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4394 test_htlc_output!(1,
4395 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4396 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4397 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4399 test_htlc_output!(2,
4400 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4401 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4402 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4406 // commitment tx with four outputs untrimmed (minimum feerate)
4407 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4408 chan.feerate_per_kw = 2195;
4410 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4411 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4412 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4414 assert_eq!(unsigned_tx.1.len(), 2);
4416 test_htlc_output!(0,
4417 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4418 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4419 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4421 test_htlc_output!(1,
4422 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4423 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4424 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4428 // commitment tx with four outputs untrimmed (maximum feerate)
4429 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4430 chan.feerate_per_kw = 3702;
4432 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4433 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4434 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4436 assert_eq!(unsigned_tx.1.len(), 2);
4438 test_htlc_output!(0,
4439 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4440 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4441 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4443 test_htlc_output!(1,
4444 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4445 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4446 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4450 // commitment tx with three outputs untrimmed (minimum feerate)
4451 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4452 chan.feerate_per_kw = 3703;
4454 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4455 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4456 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4458 assert_eq!(unsigned_tx.1.len(), 1);
4460 test_htlc_output!(0,
4461 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4462 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4463 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4467 // commitment tx with three outputs untrimmed (maximum feerate)
4468 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4469 chan.feerate_per_kw = 4914;
4471 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4472 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4473 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4475 assert_eq!(unsigned_tx.1.len(), 1);
4477 test_htlc_output!(0,
4478 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4479 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4480 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4484 // commitment tx with two outputs untrimmed (minimum feerate)
4485 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4486 chan.feerate_per_kw = 4915;
4488 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4489 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4490 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4492 assert_eq!(unsigned_tx.1.len(), 0);
4496 // commitment tx with two outputs untrimmed (maximum feerate)
4497 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4498 chan.feerate_per_kw = 9651180;
4500 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4501 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4502 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4504 assert_eq!(unsigned_tx.1.len(), 0);
4508 // commitment tx with one output untrimmed (minimum feerate)
4509 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4510 chan.feerate_per_kw = 9651181;
4512 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4513 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4514 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4516 assert_eq!(unsigned_tx.1.len(), 0);
4520 // commitment tx with fee greater than funder amount
4521 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4522 chan.feerate_per_kw = 9651936;
4524 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4525 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4526 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4528 assert_eq!(unsigned_tx.1.len(), 0);
4533 fn test_per_commitment_secret_gen() {
4534 // Test vectors from BOLT 3 Appendix D:
4536 let mut seed = [0; 32];
4537 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4538 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4539 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4541 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4542 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4543 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4545 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4546 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4548 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4549 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4551 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4552 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4553 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4557 fn test_key_derivation() {
4558 // Test vectors from BOLT 3 Appendix E:
4559 let secp_ctx = Secp256k1::new();
4561 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4562 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4564 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4565 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4567 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4568 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4570 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4571 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4573 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4574 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4576 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4577 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4579 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4580 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());