1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 use bitcoin::blockdata::script::{Script,Builder};
11 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
12 use bitcoin::blockdata::opcodes;
13 use bitcoin::util::bip143;
14 use bitcoin::consensus::encode;
16 use bitcoin::hashes::Hash;
17 use bitcoin::hashes::sha256::Hash as Sha256;
18 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
20 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
21 use bitcoin::secp256k1::{Secp256k1,Signature};
22 use bitcoin::secp256k1;
24 use ln::{PaymentPreimage, PaymentHash};
25 use ln::features::{ChannelFeatures, InitFeatures};
27 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
28 use ln::channelmanager::{BestBlock, PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
29 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor};
31 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
32 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
33 use chain::transaction::{OutPoint, TransactionData};
34 use chain::keysinterface::{Sign, KeysInterface};
35 use util::transaction_utils;
36 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
37 use util::logger::Logger;
38 use util::errors::APIError;
39 use util::config::{UserConfig,ChannelConfig};
40 use util::scid_utils::scid_from_parts;
43 use std::{cmp,mem,fmt};
45 #[cfg(any(test, feature = "fuzztarget"))]
47 use bitcoin::hashes::hex::ToHex;
48 use bitcoin::blockdata::opcodes::all::OP_PUSHBYTES_0;
51 pub struct ChannelValueStat {
52 pub value_to_self_msat: u64,
53 pub channel_value_msat: u64,
54 pub channel_reserve_msat: u64,
55 pub pending_outbound_htlcs_amount_msat: u64,
56 pub pending_inbound_htlcs_amount_msat: u64,
57 pub holding_cell_outbound_amount_msat: u64,
58 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
59 pub counterparty_dust_limit_msat: u64,
62 enum InboundHTLCRemovalReason {
63 FailRelay(msgs::OnionErrorPacket),
64 FailMalformed(([u8; 32], u16)),
65 Fulfill(PaymentPreimage),
68 enum InboundHTLCState {
69 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
70 /// update_add_htlc message for this HTLC.
71 RemoteAnnounced(PendingHTLCStatus),
72 /// Included in a received commitment_signed message (implying we've
73 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
74 /// state (see the example below). We have not yet included this HTLC in a
75 /// commitment_signed message because we are waiting on the remote's
76 /// aforementioned state revocation. One reason this missing remote RAA
77 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
78 /// is because every time we create a new "state", i.e. every time we sign a
79 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
80 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
81 /// sent provided the per_commitment_point for our current commitment tx.
82 /// The other reason we should not send a commitment_signed without their RAA
83 /// is because their RAA serves to ACK our previous commitment_signed.
85 /// Here's an example of how an HTLC could come to be in this state:
86 /// remote --> update_add_htlc(prev_htlc) --> local
87 /// remote --> commitment_signed(prev_htlc) --> local
88 /// remote <-- revoke_and_ack <-- local
89 /// remote <-- commitment_signed(prev_htlc) <-- local
90 /// [note that here, the remote does not respond with a RAA]
91 /// remote --> update_add_htlc(this_htlc) --> local
92 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
93 /// Now `this_htlc` will be assigned this state. It's unable to be officially
94 /// accepted, i.e. included in a commitment_signed, because we're missing the
95 /// RAA that provides our next per_commitment_point. The per_commitment_point
96 /// is used to derive commitment keys, which are used to construct the
97 /// signatures in a commitment_signed message.
98 /// Implies AwaitingRemoteRevoke.
100 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
101 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
102 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
103 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
104 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
105 /// channel (before it can then get forwarded and/or removed).
106 /// Implies AwaitingRemoteRevoke.
107 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
109 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
110 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
112 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
113 /// commitment transaction without it as otherwise we'll have to force-close the channel to
114 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
115 /// anyway). That said, ChannelMonitor does this for us (see
116 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
117 /// local state before then, once we're sure that the next commitment_signed and
118 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
119 LocalRemoved(InboundHTLCRemovalReason),
122 struct InboundHTLCOutput {
126 payment_hash: PaymentHash,
127 state: InboundHTLCState,
130 enum OutboundHTLCState {
131 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
132 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
133 /// we will promote to Committed (note that they may not accept it until the next time we
134 /// revoke, but we don't really care about that:
135 /// * they've revoked, so worst case we can announce an old state and get our (option on)
136 /// money back (though we won't), and,
137 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
138 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
139 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
140 /// we'll never get out of sync).
141 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
142 /// OutboundHTLCOutput's size just for a temporary bit
143 LocalAnnounced(Box<msgs::OnionPacket>),
145 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
146 /// the change (though they'll need to revoke before we fail the payment).
147 RemoteRemoved(Option<HTLCFailReason>),
148 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
149 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
150 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
151 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
152 /// remote revoke_and_ack on a previous state before we can do so.
153 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
154 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
155 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
156 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
157 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
158 /// revoke_and_ack to drop completely.
159 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
162 struct OutboundHTLCOutput {
166 payment_hash: PaymentHash,
167 state: OutboundHTLCState,
171 /// See AwaitingRemoteRevoke ChannelState for more info
172 enum HTLCUpdateAwaitingACK {
173 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
177 payment_hash: PaymentHash,
179 onion_routing_packet: msgs::OnionPacket,
182 payment_preimage: PaymentPreimage,
187 err_packet: msgs::OnionErrorPacket,
191 /// There are a few "states" and then a number of flags which can be applied:
192 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
193 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
194 /// move on to ChannelFunded.
195 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
196 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
197 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
199 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
200 OurInitSent = 1 << 0,
201 /// Implies we have received their open_channel/accept_channel message
202 TheirInitSent = 1 << 1,
203 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
204 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
205 /// upon receipt of funding_created, so simply skip this state.
207 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
208 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
209 /// and our counterparty consider the funding transaction confirmed.
211 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
212 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
213 TheirFundingLocked = 1 << 4,
214 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
215 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
216 OurFundingLocked = 1 << 5,
218 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
219 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
221 PeerDisconnected = 1 << 7,
222 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
223 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
224 /// outbound messages until they've managed to do so.
225 MonitorUpdateFailed = 1 << 8,
226 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
227 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
228 /// messages as then we will be unable to determine which HTLCs they included in their
229 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
231 /// Flag is set on ChannelFunded.
232 AwaitingRemoteRevoke = 1 << 9,
233 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
234 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
235 /// to respond with our own shutdown message when possible.
236 RemoteShutdownSent = 1 << 10,
237 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
238 /// point, we may not add any new HTLCs to the channel.
239 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
240 /// us their shutdown.
241 LocalShutdownSent = 1 << 11,
242 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
243 /// to drop us, but we store this anyway.
244 ShutdownComplete = 4096,
246 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
247 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
249 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
251 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
252 /// If channel is public, network should have a liveness view announced by us on a
253 /// best-effort, which means we may filter out some status transitions to avoid spam.
254 /// See further timer_tick_occurred.
257 /// Status has been gossiped.
259 /// Status has been changed.
261 /// Status has been marked to be gossiped at next flush
265 /// An enum indicating whether the local or remote side offered a given HTLC.
271 /// Used when calculating whether we or the remote can afford an additional HTLC.
272 struct HTLCCandidate {
274 origin: HTLCInitiator,
278 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
286 /// Information needed for constructing an invoice route hint for this channel.
288 pub struct CounterpartyForwardingInfo {
289 /// Base routing fee in millisatoshis.
290 pub fee_base_msat: u32,
291 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
292 pub fee_proportional_millionths: u32,
293 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
294 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
295 /// `cltv_expiry_delta` for more details.
296 pub cltv_expiry_delta: u16,
299 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
300 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
301 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
304 // Holder designates channel data owned for the benefice of the user client.
305 // Counterparty designates channel data owned by the another channel participant entity.
306 pub(super) struct Channel<Signer: Sign> {
307 config: ChannelConfig,
311 channel_id: [u8; 32],
313 secp_ctx: Secp256k1<secp256k1::All>,
314 channel_value_satoshis: u64,
316 latest_monitor_update_id: u64,
318 holder_signer: Signer,
319 shutdown_pubkey: PublicKey,
320 destination_script: Script,
322 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
323 // generation start at 0 and count up...this simplifies some parts of implementation at the
324 // cost of others, but should really just be changed.
326 cur_holder_commitment_transaction_number: u64,
327 cur_counterparty_commitment_transaction_number: u64,
328 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
329 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
330 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
331 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
333 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
334 /// need to ensure we resend them in the order we originally generated them. Note that because
335 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
336 /// sufficient to simply set this to the opposite of any message we are generating as we
337 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
338 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
340 resend_order: RAACommitmentOrder,
342 monitor_pending_funding_locked: bool,
343 monitor_pending_revoke_and_ack: bool,
344 monitor_pending_commitment_signed: bool,
345 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
346 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
348 // pending_update_fee is filled when sending and receiving update_fee
349 // For outbound channel, feerate_per_kw is updated with the value from
350 // pending_update_fee when revoke_and_ack is received
352 // For inbound channel, feerate_per_kw is updated when it receives
353 // commitment_signed and revoke_and_ack is generated
354 // The pending value is kept when another pair of update_fee and commitment_signed
355 // is received during AwaitingRemoteRevoke and relieved when the expected
356 // revoke_and_ack is received and new commitment_signed is generated to be
357 // sent to the funder. Otherwise, the pending value is removed when receiving
358 // commitment_signed.
359 pending_update_fee: Option<u32>,
360 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
361 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
362 // is received. holding_cell_update_fee is updated when there are additional
363 // update_fee() during ChannelState::AwaitingRemoteRevoke.
364 holding_cell_update_fee: Option<u32>,
365 next_holder_htlc_id: u64,
366 next_counterparty_htlc_id: u64,
367 update_time_counter: u32,
370 #[cfg(debug_assertions)]
371 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
372 holder_max_commitment_tx_output: ::std::sync::Mutex<(u64, u64)>,
373 #[cfg(debug_assertions)]
374 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
375 counterparty_max_commitment_tx_output: ::std::sync::Mutex<(u64, u64)>,
377 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
379 /// The hash of the block in which the funding transaction was included.
380 funding_tx_confirmed_in: Option<BlockHash>,
381 funding_tx_confirmation_height: u32,
382 short_channel_id: Option<u64>,
384 counterparty_dust_limit_satoshis: u64,
386 pub(super) holder_dust_limit_satoshis: u64,
388 holder_dust_limit_satoshis: u64,
390 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
392 counterparty_max_htlc_value_in_flight_msat: u64,
393 //get_holder_max_htlc_value_in_flight_msat(): u64,
394 /// minimum channel reserve for self to maintain - set by them.
395 counterparty_selected_channel_reserve_satoshis: u64,
396 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
397 counterparty_htlc_minimum_msat: u64,
398 holder_htlc_minimum_msat: u64,
400 pub counterparty_max_accepted_htlcs: u16,
402 counterparty_max_accepted_htlcs: u16,
403 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
406 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
408 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
409 funding_transaction: Option<Transaction>,
411 counterparty_cur_commitment_point: Option<PublicKey>,
412 counterparty_prev_commitment_point: Option<PublicKey>,
413 counterparty_node_id: PublicKey,
415 counterparty_shutdown_scriptpubkey: Option<Script>,
417 commitment_secrets: CounterpartyCommitmentSecrets,
419 network_sync: UpdateStatus,
421 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
422 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
423 // be, by comparing the cached values to the fee of the tranaction generated by
424 // `build_commitment_transaction`.
425 #[cfg(any(test, feature = "fuzztarget"))]
426 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
427 #[cfg(any(test, feature = "fuzztarget"))]
428 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
431 #[cfg(any(test, feature = "fuzztarget"))]
432 struct CommitmentTxInfoCached {
434 total_pending_htlcs: usize,
435 next_holder_htlc_id: u64,
436 next_counterparty_htlc_id: u64,
440 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
441 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
444 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
446 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
448 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
450 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
452 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
454 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
456 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
457 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
458 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
459 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
460 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
461 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
462 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
463 /// upper bound to avoid negotiation conflicts with other implementations.
464 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
466 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
467 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
468 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
469 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
470 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
472 /// Used to return a simple Error back to ChannelManager. Will get converted to a
473 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
474 /// channel_id in ChannelManager.
475 pub(super) enum ChannelError {
478 CloseDelayBroadcast(String),
481 impl fmt::Debug for ChannelError {
482 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
484 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
485 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
486 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
491 macro_rules! secp_check {
492 ($res: expr, $err: expr) => {
495 Err(_) => return Err(ChannelError::Close($err)),
500 impl<Signer: Sign> Channel<Signer> {
501 // Convert constants + channel value to limits:
502 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
503 channel_value_satoshis * 1000 / 10 //TODO
506 /// Returns a minimum channel reserve value the remote needs to maintain,
509 /// Guaranteed to return a value no larger than channel_value_satoshis
510 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
511 let (q, _) = channel_value_satoshis.overflowing_div(100);
512 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
516 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
517 where K::Target: KeysInterface<Signer = Signer>,
518 F::Target: FeeEstimator,
520 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
521 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
522 let pubkeys = holder_signer.pubkeys().clone();
524 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
525 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
527 let channel_value_msat = channel_value_satoshis * 1000;
528 if push_msat > channel_value_msat {
529 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
531 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
532 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
534 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
535 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
536 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
539 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
541 let mut secp_ctx = Secp256k1::new();
542 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
546 config: config.channel_options.clone(),
548 channel_id: keys_provider.get_secure_random_bytes(),
549 channel_state: ChannelState::OurInitSent as u32,
551 channel_value_satoshis,
553 latest_monitor_update_id: 0,
556 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
557 destination_script: keys_provider.get_destination_script(),
559 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
560 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
561 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
563 pending_inbound_htlcs: Vec::new(),
564 pending_outbound_htlcs: Vec::new(),
565 holding_cell_htlc_updates: Vec::new(),
566 pending_update_fee: None,
567 holding_cell_update_fee: None,
568 next_holder_htlc_id: 0,
569 next_counterparty_htlc_id: 0,
570 update_time_counter: 1,
572 resend_order: RAACommitmentOrder::CommitmentFirst,
574 monitor_pending_funding_locked: false,
575 monitor_pending_revoke_and_ack: false,
576 monitor_pending_commitment_signed: false,
577 monitor_pending_forwards: Vec::new(),
578 monitor_pending_failures: Vec::new(),
580 #[cfg(debug_assertions)]
581 holder_max_commitment_tx_output: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
582 #[cfg(debug_assertions)]
583 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
585 last_sent_closing_fee: None,
587 funding_tx_confirmed_in: None,
588 funding_tx_confirmation_height: 0,
589 short_channel_id: None,
591 feerate_per_kw: feerate,
592 counterparty_dust_limit_satoshis: 0,
593 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
594 counterparty_max_htlc_value_in_flight_msat: 0,
595 counterparty_selected_channel_reserve_satoshis: 0,
596 counterparty_htlc_minimum_msat: 0,
597 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
598 counterparty_max_accepted_htlcs: 0,
599 minimum_depth: 0, // Filled in in accept_channel
601 counterparty_forwarding_info: None,
603 channel_transaction_parameters: ChannelTransactionParameters {
604 holder_pubkeys: pubkeys,
605 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
606 is_outbound_from_holder: true,
607 counterparty_parameters: None,
608 funding_outpoint: None
610 funding_transaction: None,
612 counterparty_cur_commitment_point: None,
613 counterparty_prev_commitment_point: None,
614 counterparty_node_id,
616 counterparty_shutdown_scriptpubkey: None,
618 commitment_secrets: CounterpartyCommitmentSecrets::new(),
620 network_sync: UpdateStatus::Fresh,
622 #[cfg(any(test, feature = "fuzztarget"))]
623 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
624 #[cfg(any(test, feature = "fuzztarget"))]
625 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
629 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
630 where F::Target: FeeEstimator
632 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
633 if feerate_per_kw < lower_limit {
634 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
636 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 2;
637 if feerate_per_kw as u64 > upper_limit {
638 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
643 /// Creates a new channel from a remote sides' request for one.
644 /// Assumes chain_hash has already been checked and corresponds with what we expect!
645 pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, ChannelError>
646 where K::Target: KeysInterface<Signer = Signer>,
647 F::Target: FeeEstimator
649 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
650 let pubkeys = holder_signer.pubkeys().clone();
651 let counterparty_pubkeys = ChannelPublicKeys {
652 funding_pubkey: msg.funding_pubkey,
653 revocation_basepoint: msg.revocation_basepoint,
654 payment_point: msg.payment_point,
655 delayed_payment_basepoint: msg.delayed_payment_basepoint,
656 htlc_basepoint: msg.htlc_basepoint
658 let mut local_config = (*config).channel_options.clone();
660 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
661 return Err(ChannelError::Close(format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks. It must be greater than {}", config.own_channel_config.our_to_self_delay, BREAKDOWN_TIMEOUT)));
664 // Check sanity of message fields:
665 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
666 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
668 if msg.channel_reserve_satoshis > msg.funding_satoshis {
669 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
671 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
672 if msg.push_msat > funding_value {
673 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
675 if msg.dust_limit_satoshis > msg.funding_satoshis {
676 return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than funding_satoshis {}. Peer never wants payout outputs?", msg.dust_limit_satoshis, msg.funding_satoshis)));
678 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
679 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
681 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
682 if msg.htlc_minimum_msat >= full_channel_value_msat {
683 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
685 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
687 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
688 if msg.to_self_delay > max_counterparty_selected_contest_delay {
689 return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_counterparty_selected_contest_delay, msg.to_self_delay)));
691 if msg.max_accepted_htlcs < 1 {
692 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
694 if msg.max_accepted_htlcs > MAX_HTLCS {
695 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
698 // Now check against optional parameters as set by config...
699 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
700 return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", msg.funding_satoshis, config.peer_channel_config_limits.min_funding_satoshis)));
702 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
703 return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, config.peer_channel_config_limits.max_htlc_minimum_msat)));
705 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
706 return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
708 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
709 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
711 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
712 return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
714 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
715 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
717 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
718 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
721 // Convert things into internal flags and prep our state:
723 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
724 if config.peer_channel_config_limits.force_announced_channel_preference {
725 if local_config.announced_channel != announce {
726 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
729 // we either accept their preference or the preferences match
730 local_config.announced_channel = announce;
732 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
734 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
735 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
736 return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
738 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
739 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
741 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
742 return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", msg.dust_limit_satoshis, holder_selected_channel_reserve_satoshis)));
745 // check if the funder's amount for the initial commitment tx is sufficient
746 // for full fee payment
747 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
748 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
749 if funders_amount_msat < lower_limit {
750 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
753 let to_local_msat = msg.push_msat;
754 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
755 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
756 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
759 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
760 match &msg.shutdown_scriptpubkey {
761 &OptionalField::Present(ref script) => {
762 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
763 if script.len() == 0 {
765 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
766 } else if is_unsupported_shutdown_script(&their_features, script) {
767 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
772 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
773 &OptionalField::Absent => {
774 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
779 let mut secp_ctx = Secp256k1::new();
780 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
784 config: local_config,
786 channel_id: msg.temporary_channel_id,
787 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
790 latest_monitor_update_id: 0,
793 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
794 destination_script: keys_provider.get_destination_script(),
796 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
797 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
798 value_to_self_msat: msg.push_msat,
800 pending_inbound_htlcs: Vec::new(),
801 pending_outbound_htlcs: Vec::new(),
802 holding_cell_htlc_updates: Vec::new(),
803 pending_update_fee: None,
804 holding_cell_update_fee: None,
805 next_holder_htlc_id: 0,
806 next_counterparty_htlc_id: 0,
807 update_time_counter: 1,
809 resend_order: RAACommitmentOrder::CommitmentFirst,
811 monitor_pending_funding_locked: false,
812 monitor_pending_revoke_and_ack: false,
813 monitor_pending_commitment_signed: false,
814 monitor_pending_forwards: Vec::new(),
815 monitor_pending_failures: Vec::new(),
817 #[cfg(debug_assertions)]
818 holder_max_commitment_tx_output: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
819 #[cfg(debug_assertions)]
820 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
822 last_sent_closing_fee: None,
824 funding_tx_confirmed_in: None,
825 funding_tx_confirmation_height: 0,
826 short_channel_id: None,
828 feerate_per_kw: msg.feerate_per_kw,
829 channel_value_satoshis: msg.funding_satoshis,
830 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
831 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
832 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
833 counterparty_selected_channel_reserve_satoshis: msg.channel_reserve_satoshis,
834 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
835 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
836 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
837 minimum_depth: config.own_channel_config.minimum_depth,
839 counterparty_forwarding_info: None,
841 channel_transaction_parameters: ChannelTransactionParameters {
842 holder_pubkeys: pubkeys,
843 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
844 is_outbound_from_holder: false,
845 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
846 selected_contest_delay: msg.to_self_delay,
847 pubkeys: counterparty_pubkeys,
849 funding_outpoint: None
851 funding_transaction: None,
853 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
854 counterparty_prev_commitment_point: None,
855 counterparty_node_id,
857 counterparty_shutdown_scriptpubkey,
859 commitment_secrets: CounterpartyCommitmentSecrets::new(),
861 network_sync: UpdateStatus::Fresh,
863 #[cfg(any(test, feature = "fuzztarget"))]
864 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
865 #[cfg(any(test, feature = "fuzztarget"))]
866 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
872 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
873 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
874 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
875 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
876 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
878 /// @local is used only to convert relevant internal structures which refer to remote vs local
879 /// to decide value of outputs and direction of HTLCs.
880 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
881 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
882 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
883 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
884 /// which peer generated this transaction and "to whom" this transaction flows.
885 /// Returns (the transaction info, the number of HTLC outputs which were present in the
886 /// transaction, the list of HTLCs which were not ignored when building the transaction).
887 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
888 /// sources are provided only for outbound HTLCs in the third return value.
890 fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u32, logger: &L) -> (CommitmentTransaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
891 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
892 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
893 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
895 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
896 let mut remote_htlc_total_msat = 0;
897 let mut local_htlc_total_msat = 0;
898 let mut value_to_self_msat_offset = 0;
900 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
902 macro_rules! get_htlc_in_commitment {
903 ($htlc: expr, $offered: expr) => {
904 HTLCOutputInCommitment {
906 amount_msat: $htlc.amount_msat,
907 cltv_expiry: $htlc.cltv_expiry,
908 payment_hash: $htlc.payment_hash,
909 transaction_output_index: None
914 macro_rules! add_htlc_output {
915 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
916 if $outbound == local { // "offered HTLC output"
917 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
918 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
919 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
920 included_non_dust_htlcs.push((htlc_in_tx, $source));
922 log_trace!(logger, " ...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);
923 included_dust_htlcs.push((htlc_in_tx, $source));
926 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
927 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
928 log_trace!(logger, " ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
929 included_non_dust_htlcs.push((htlc_in_tx, $source));
931 log_trace!(logger, " ...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);
932 included_dust_htlcs.push((htlc_in_tx, $source));
938 for ref htlc in self.pending_inbound_htlcs.iter() {
939 let (include, state_name) = match htlc.state {
940 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
941 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
942 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
943 InboundHTLCState::Committed => (true, "Committed"),
944 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
948 add_htlc_output!(htlc, false, None, state_name);
949 remote_htlc_total_msat += htlc.amount_msat;
951 log_trace!(logger, " ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
953 &InboundHTLCState::LocalRemoved(ref reason) => {
954 if generated_by_local {
955 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
956 value_to_self_msat_offset += htlc.amount_msat as i64;
965 for ref htlc in self.pending_outbound_htlcs.iter() {
966 let (include, state_name) = match htlc.state {
967 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
968 OutboundHTLCState::Committed => (true, "Committed"),
969 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
970 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
971 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
975 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
976 local_htlc_total_msat += htlc.amount_msat;
978 log_trace!(logger, " ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
980 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
981 value_to_self_msat_offset -= htlc.amount_msat as i64;
983 OutboundHTLCState::RemoteRemoved(None) => {
984 if !generated_by_local {
985 value_to_self_msat_offset -= htlc.amount_msat as i64;
993 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
994 assert!(value_to_self_msat >= 0);
995 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
996 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
997 // "violate" their reserve value by couting those against it. Thus, we have to convert
998 // everything to i64 before subtracting as otherwise we can overflow.
999 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
1000 assert!(value_to_remote_msat >= 0);
1002 #[cfg(debug_assertions)]
1004 // Make sure that the to_self/to_remote is always either past the appropriate
1005 // channel_reserve *or* it is making progress towards it.
1006 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1007 self.holder_max_commitment_tx_output.lock().unwrap()
1009 self.counterparty_max_commitment_tx_output.lock().unwrap()
1011 debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis as i64);
1012 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1013 debug_assert!(broadcaster_max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
1014 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1017 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (included_non_dust_htlcs.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1018 let (value_to_self, value_to_remote) = if self.is_outbound() {
1019 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1021 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1024 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1025 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1027 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1028 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1033 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1034 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1039 let num_nondust_htlcs = included_non_dust_htlcs.len();
1041 let channel_parameters =
1042 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1043 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1044 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1049 &mut included_non_dust_htlcs,
1052 let mut htlcs_included = included_non_dust_htlcs;
1053 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1054 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1055 htlcs_included.append(&mut included_dust_htlcs);
1057 (tx, num_nondust_htlcs, htlcs_included)
1061 fn get_closing_scriptpubkey(&self) -> Script {
1062 let channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1063 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_close_key_hash[..]).into_script()
1067 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1072 1 + // script length (0)
1076 )*4 + // * 4 for non-witness parts
1077 2 + // witness marker and flag
1078 1 + // witness element count
1079 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1080 self.get_funding_redeemscript().len() as u64 + // funding witness script
1081 2*(1 + 71); // two signatures + sighash type flags
1082 if let Some(spk) = a_scriptpubkey {
1083 ret += ((8+1) + // output values and script length
1084 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1086 if let Some(spk) = b_scriptpubkey {
1087 ret += ((8+1) + // output values and script length
1088 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1094 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1096 let mut ins: Vec<TxIn> = Vec::new();
1098 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1099 script_sig: Script::new(),
1100 sequence: 0xffffffff,
1101 witness: Vec::new(),
1106 assert!(self.pending_inbound_htlcs.is_empty());
1107 assert!(self.pending_outbound_htlcs.is_empty());
1108 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1110 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1111 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1112 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.is_outbound() { 0 } else { total_fee_satoshis as i64 };
1114 if value_to_self < 0 {
1115 assert!(self.is_outbound());
1116 total_fee_satoshis += (-value_to_self) as u64;
1117 } else if value_to_remote < 0 {
1118 assert!(!self.is_outbound());
1119 total_fee_satoshis += (-value_to_remote) as u64;
1122 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1123 txouts.push((TxOut {
1124 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1125 value: value_to_remote as u64
1129 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1130 txouts.push((TxOut {
1131 script_pubkey: self.get_closing_scriptpubkey(),
1132 value: value_to_self as u64
1136 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1138 let mut outputs: Vec<TxOut> = Vec::new();
1139 for out in txouts.drain(..) {
1140 outputs.push(out.0);
1148 }, total_fee_satoshis)
1151 fn funding_outpoint(&self) -> OutPoint {
1152 self.channel_transaction_parameters.funding_outpoint.unwrap()
1156 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1157 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1158 /// our counterparty!)
1159 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1160 /// TODO Some magic rust shit to compile-time check this?
1161 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1162 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1163 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1164 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1165 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1167 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys".to_owned()))
1171 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1172 /// will sign and send to our counterparty.
1173 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1174 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1175 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1176 //may see payments to it!
1177 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1178 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1179 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1181 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &self.counterparty_cur_commitment_point.unwrap(), &counterparty_pubkeys.delayed_payment_basepoint, &counterparty_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint), "Remote tx keys generation got bogus keys".to_owned()))
1184 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1185 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1186 /// Panics if called before accept_channel/new_from_req
1187 pub fn get_funding_redeemscript(&self) -> Script {
1188 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1191 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1192 /// @local is used only to convert relevant internal structures which refer to remote vs local
1193 /// to decide value of outputs and direction of HTLCs.
1194 fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u32) -> Transaction {
1195 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.get_counterparty_selected_contest_delay() } else { self.get_holder_selected_contest_delay() }, htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key)
1198 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1199 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1200 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1202 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1203 /// but then have a reorg which settles on an HTLC-failure on chain.
1204 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1205 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1206 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1207 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1209 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1210 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1212 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1214 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1216 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1217 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1218 // these, but for now we just have to treat them as normal.
1220 let mut pending_idx = std::usize::MAX;
1221 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1222 if htlc.htlc_id == htlc_id_arg {
1223 assert_eq!(htlc.payment_hash, payment_hash_calc);
1225 InboundHTLCState::Committed => {},
1226 InboundHTLCState::LocalRemoved(ref reason) => {
1227 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1229 log_warn!(logger, "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()));
1231 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1232 return Ok((None, None));
1235 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1236 // Don't return in release mode here so that we can update channel_monitor
1243 if pending_idx == std::usize::MAX {
1244 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1247 // Now update local state:
1249 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1250 // can claim it even if the channel hits the chain before we see their next commitment.
1251 self.latest_monitor_update_id += 1;
1252 let monitor_update = ChannelMonitorUpdate {
1253 update_id: self.latest_monitor_update_id,
1254 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1255 payment_preimage: payment_preimage_arg.clone(),
1259 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1260 for pending_update in self.holding_cell_htlc_updates.iter() {
1261 match pending_update {
1262 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1263 if htlc_id_arg == htlc_id {
1264 // Make sure we don't leave latest_monitor_update_id incremented here:
1265 self.latest_monitor_update_id -= 1;
1266 debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1267 return Ok((None, None));
1270 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1271 if htlc_id_arg == htlc_id {
1272 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1273 // TODO: We may actually be able to switch to a fulfill here, though its
1274 // rare enough it may not be worth the complexity burden.
1275 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1276 return Ok((None, Some(monitor_update)));
1282 log_trace!(logger, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1283 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1284 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1286 return Ok((None, Some(monitor_update)));
1290 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1291 if let InboundHTLCState::Committed = htlc.state {
1293 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1294 return Ok((None, Some(monitor_update)));
1296 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1297 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1300 Ok((Some(msgs::UpdateFulfillHTLC {
1301 channel_id: self.channel_id(),
1302 htlc_id: htlc_id_arg,
1303 payment_preimage: payment_preimage_arg,
1304 }), Some(monitor_update)))
1307 pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1308 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger)? {
1309 (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1310 let (commitment, mut additional_update) = self.send_commitment_no_status_check(logger)?;
1311 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1312 // strictly increasing by one, so decrement it here.
1313 self.latest_monitor_update_id = monitor_update.update_id;
1314 monitor_update.updates.append(&mut additional_update.updates);
1315 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1317 (Some(update_fulfill_htlc), None) => {
1318 let (commitment, monitor_update) = self.send_commitment_no_status_check(logger)?;
1319 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1321 (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1322 (None, None) => Ok((None, None))
1326 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1327 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1328 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1330 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1331 /// but then have a reorg which settles on an HTLC-failure on chain.
1332 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1333 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1334 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1336 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1338 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1339 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1340 // these, but for now we just have to treat them as normal.
1342 let mut pending_idx = std::usize::MAX;
1343 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1344 if htlc.htlc_id == htlc_id_arg {
1346 InboundHTLCState::Committed => {},
1347 InboundHTLCState::LocalRemoved(_) => {
1348 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1352 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1353 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1359 if pending_idx == std::usize::MAX {
1360 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1363 // Now update local state:
1364 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1365 for pending_update in self.holding_cell_htlc_updates.iter() {
1366 match pending_update {
1367 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1368 if htlc_id_arg == htlc_id {
1369 debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1370 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1373 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1374 if htlc_id_arg == htlc_id {
1375 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1376 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1382 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1383 htlc_id: htlc_id_arg,
1390 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1391 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1394 Ok(Some(msgs::UpdateFailHTLC {
1395 channel_id: self.channel_id(),
1396 htlc_id: htlc_id_arg,
1401 // Message handlers:
1403 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1404 // Check sanity of message fields:
1405 if !self.is_outbound() {
1406 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1408 if self.channel_state != ChannelState::OurInitSent as u32 {
1409 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1411 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1412 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1414 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1415 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1417 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1418 return Err(ChannelError::Close(format!("Bogus channel_reserve ({}) and dust_limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
1420 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1421 return Err(ChannelError::Close(format!("Peer never wants payout outputs? channel_reserve_satoshis was ({}). dust_limit is ({})", msg.channel_reserve_satoshis, self.holder_dust_limit_satoshis)));
1423 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1424 if msg.dust_limit_satoshis > remote_reserve {
1425 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1427 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1428 if msg.htlc_minimum_msat >= full_channel_value_msat {
1429 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1431 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1432 if msg.to_self_delay > max_delay_acceptable {
1433 return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.to_self_delay)));
1435 if msg.max_accepted_htlcs < 1 {
1436 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1438 if msg.max_accepted_htlcs > MAX_HTLCS {
1439 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1442 // Now check against optional parameters as set by config...
1443 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1444 return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, config.peer_channel_config_limits.max_htlc_minimum_msat)));
1446 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1447 return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
1449 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1450 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
1452 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1453 return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
1455 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1456 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1458 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1459 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1461 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1462 return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", config.peer_channel_config_limits.max_minimum_depth, msg.minimum_depth)));
1465 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1466 match &msg.shutdown_scriptpubkey {
1467 &OptionalField::Present(ref script) => {
1468 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1469 if script.len() == 0 {
1471 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1472 } else if is_unsupported_shutdown_script(&their_features, script) {
1473 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
1475 Some(script.clone())
1478 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1479 &OptionalField::Absent => {
1480 return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
1485 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1486 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1487 self.counterparty_selected_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1488 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1489 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1490 self.minimum_depth = msg.minimum_depth;
1492 let counterparty_pubkeys = ChannelPublicKeys {
1493 funding_pubkey: msg.funding_pubkey,
1494 revocation_basepoint: msg.revocation_basepoint,
1495 payment_point: msg.payment_point,
1496 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1497 htlc_basepoint: msg.htlc_basepoint
1500 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1501 selected_contest_delay: msg.to_self_delay,
1502 pubkeys: counterparty_pubkeys,
1505 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1506 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1508 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1513 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1514 let funding_script = self.get_funding_redeemscript();
1516 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1517 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1519 let trusted_tx = initial_commitment_tx.trust();
1520 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1521 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1522 // They sign the holder commitment transaction...
1523 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]), encode::serialize_hex(&funding_script));
1524 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1527 let counterparty_keys = self.build_remote_transaction_keys()?;
1528 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
1530 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1531 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1532 log_trace!(logger, "Initial counterparty ID {} tx {}", counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1534 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1535 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1537 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1538 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1541 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1542 &self.get_counterparty_pubkeys().funding_pubkey
1545 pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, best_block: BestBlock, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError> where L::Target: Logger {
1546 if self.is_outbound() {
1547 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1549 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1550 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1551 // remember the channel, so it's safe to just send an error_message here and drop the
1553 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1555 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1556 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1557 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1558 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1561 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1562 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1563 // This is an externally observable change before we finish all our checks. In particular
1564 // funding_created_signature may fail.
1565 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1567 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1569 Err(ChannelError::Close(e)) => {
1570 self.channel_transaction_parameters.funding_outpoint = None;
1571 return Err(ChannelError::Close(e));
1574 // The only error we know how to handle is ChannelError::Close, so we fall over here
1575 // to make sure we don't continue with an inconsistent state.
1576 panic!("unexpected error type from funding_created_signature {:?}", e);
1580 let holder_commitment_tx = HolderCommitmentTransaction::new(
1581 initial_commitment_tx,
1584 &self.get_holder_pubkeys().funding_pubkey,
1585 self.counterparty_funding_pubkey()
1588 // Now that we're past error-generating stuff, update our local state:
1590 let funding_redeemscript = self.get_funding_redeemscript();
1591 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1592 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1593 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1594 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1595 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1596 &self.channel_transaction_parameters,
1597 funding_redeemscript.clone(), self.channel_value_satoshis,
1599 holder_commitment_tx, best_block);
1601 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_commitment_txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1603 self.channel_state = ChannelState::FundingSent as u32;
1604 self.channel_id = funding_txo.to_channel_id();
1605 self.cur_counterparty_commitment_transaction_number -= 1;
1606 self.cur_holder_commitment_transaction_number -= 1;
1608 Ok((msgs::FundingSigned {
1609 channel_id: self.channel_id,
1611 }, channel_monitor))
1614 /// Handles a funding_signed message from the remote end.
1615 /// If this call is successful, broadcast the funding transaction (and not before!)
1616 pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, best_block: BestBlock, logger: &L) -> Result<(ChannelMonitor<Signer>, Transaction), ChannelError> where L::Target: Logger {
1617 if !self.is_outbound() {
1618 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1620 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1621 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1623 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1624 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1625 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1626 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1629 let funding_script = self.get_funding_redeemscript();
1631 let counterparty_keys = self.build_remote_transaction_keys()?;
1632 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
1633 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1634 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1636 log_trace!(logger, "Initial counterparty ID {} tx {}", counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1638 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1639 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1641 let trusted_tx = initial_commitment_tx.trust();
1642 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1643 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1644 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1645 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1646 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1650 let holder_commitment_tx = HolderCommitmentTransaction::new(
1651 initial_commitment_tx,
1654 &self.get_holder_pubkeys().funding_pubkey,
1655 self.counterparty_funding_pubkey()
1659 let funding_redeemscript = self.get_funding_redeemscript();
1660 let funding_txo = self.get_funding_txo().unwrap();
1661 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1662 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1663 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1664 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1665 &self.destination_script, (funding_txo, funding_txo_script),
1666 &self.channel_transaction_parameters,
1667 funding_redeemscript.clone(), self.channel_value_satoshis,
1669 holder_commitment_tx, best_block);
1671 channel_monitor.provide_latest_counterparty_commitment_tx(counterparty_initial_bitcoin_tx.txid, Vec::new(), self.cur_counterparty_commitment_transaction_number, self.counterparty_cur_commitment_point.unwrap(), logger);
1673 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1674 self.channel_state = ChannelState::FundingSent as u32;
1675 self.cur_holder_commitment_transaction_number -= 1;
1676 self.cur_counterparty_commitment_transaction_number -= 1;
1678 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1681 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1682 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1683 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish".to_owned()));
1686 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1688 if non_shutdown_state == ChannelState::FundingSent as u32 {
1689 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1690 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1691 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1692 self.update_time_counter += 1;
1693 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1694 // Note that funding_signed/funding_created will have decremented both by 1!
1695 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1696 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1697 // If we reconnected before sending our funding locked they may still resend theirs:
1698 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1699 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1700 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1701 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1703 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1706 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1709 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1710 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1714 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1715 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1716 let mut htlc_inbound_value_msat = 0;
1717 for ref htlc in self.pending_inbound_htlcs.iter() {
1718 htlc_inbound_value_msat += htlc.amount_msat;
1720 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1723 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1725 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1726 let mut htlc_outbound_value_msat = 0;
1727 for ref htlc in self.pending_outbound_htlcs.iter() {
1728 htlc_outbound_value_msat += htlc.amount_msat;
1731 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1732 for update in self.holding_cell_htlc_updates.iter() {
1733 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1734 htlc_outbound_count += 1;
1735 htlc_outbound_value_msat += amount_msat;
1739 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1742 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1743 /// Doesn't bother handling the
1744 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1745 /// corner case properly.
1746 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1747 // Note that we have to handle overflow due to the above case.
1748 (cmp::max(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1749 cmp::max(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1752 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1753 // Note that num_htlcs should not include dust HTLCs.
1754 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1755 // Note that we need to divide before multiplying to round properly,
1756 // since the lowest denomination of bitcoin on-chain is the satoshi.
1757 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1760 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1761 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1762 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1764 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1765 assert!(self.is_outbound());
1767 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1768 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1770 let mut addl_htlcs = 0;
1771 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1773 HTLCInitiator::LocalOffered => {
1774 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1778 HTLCInitiator::RemoteOffered => {
1779 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1785 let mut included_htlcs = 0;
1786 for ref htlc in self.pending_inbound_htlcs.iter() {
1787 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1790 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1791 // transaction including this HTLC if it times out before they RAA.
1792 included_htlcs += 1;
1795 for ref htlc in self.pending_outbound_htlcs.iter() {
1796 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1800 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1801 OutboundHTLCState::Committed => included_htlcs += 1,
1802 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1803 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1804 // transaction won't be generated until they send us their next RAA, which will mean
1805 // dropping any HTLCs in this state.
1810 for htlc in self.holding_cell_htlc_updates.iter() {
1812 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1813 if amount_msat / 1000 < real_dust_limit_timeout_sat {
1818 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1819 // ack we're guaranteed to never include them in commitment txs anymore.
1823 let num_htlcs = included_htlcs + addl_htlcs;
1824 let res = self.commit_tx_fee_msat(num_htlcs);
1825 #[cfg(any(test, feature = "fuzztarget"))]
1828 if fee_spike_buffer_htlc.is_some() {
1829 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1831 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1832 + self.holding_cell_htlc_updates.len();
1833 let commitment_tx_info = CommitmentTxInfoCached {
1835 total_pending_htlcs,
1836 next_holder_htlc_id: match htlc.origin {
1837 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1838 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1840 next_counterparty_htlc_id: match htlc.origin {
1841 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1842 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1844 feerate: self.feerate_per_kw,
1846 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1851 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1852 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1853 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1855 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1856 assert!(!self.is_outbound());
1858 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1859 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1861 let mut addl_htlcs = 0;
1862 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1864 HTLCInitiator::LocalOffered => {
1865 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1869 HTLCInitiator::RemoteOffered => {
1870 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1876 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
1877 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
1878 // committed outbound HTLCs, see below.
1879 let mut included_htlcs = 0;
1880 for ref htlc in self.pending_inbound_htlcs.iter() {
1881 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
1884 included_htlcs += 1;
1887 for ref htlc in self.pending_outbound_htlcs.iter() {
1888 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
1891 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
1892 // i.e. if they've responded to us with an RAA after announcement.
1894 OutboundHTLCState::Committed => included_htlcs += 1,
1895 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1896 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
1901 let num_htlcs = included_htlcs + addl_htlcs;
1902 let res = self.commit_tx_fee_msat(num_htlcs);
1903 #[cfg(any(test, feature = "fuzztarget"))]
1906 if fee_spike_buffer_htlc.is_some() {
1907 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1909 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1910 let commitment_tx_info = CommitmentTxInfoCached {
1912 total_pending_htlcs,
1913 next_holder_htlc_id: match htlc.origin {
1914 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1915 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1917 next_counterparty_htlc_id: match htlc.origin {
1918 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1919 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1921 feerate: self.feerate_per_kw,
1923 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1928 pub fn update_add_htlc<F, L: Deref>(&mut self, msg: &msgs::UpdateAddHTLC, mut pending_forward_status: PendingHTLCStatus, create_pending_htlc_status: F, logger: &L) -> Result<(), ChannelError>
1929 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
1930 // We can't accept HTLCs sent after we've sent a shutdown.
1931 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1932 if local_sent_shutdown {
1933 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
1935 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
1936 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1937 if remote_sent_shutdown {
1938 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
1940 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1941 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
1943 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1944 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
1946 if msg.amount_msat == 0 {
1947 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
1949 if msg.amount_msat < self.holder_htlc_minimum_msat {
1950 return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.holder_htlc_minimum_msat, msg.amount_msat)));
1953 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1954 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1955 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
1957 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
1958 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
1959 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
1961 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1962 // the reserve_satoshis we told them to always have as direct payment so that they lose
1963 // something if we punish them for broadcasting an old state).
1964 // Note that we don't really care about having a small/no to_remote output in our local
1965 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1966 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1967 // present in the next commitment transaction we send them (at least for fulfilled ones,
1968 // failed ones won't modify value_to_self).
1969 // Note that we will send HTLCs which another instance of rust-lightning would think
1970 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1971 // Channel state once they will not be present in the next received commitment
1973 let mut removed_outbound_total_msat = 0;
1974 for ref htlc in self.pending_outbound_htlcs.iter() {
1975 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1976 removed_outbound_total_msat += htlc.amount_msat;
1977 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1978 removed_outbound_total_msat += htlc.amount_msat;
1982 let pending_value_to_self_msat =
1983 self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
1984 let pending_remote_value_msat =
1985 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
1986 if pending_remote_value_msat < msg.amount_msat {
1987 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
1990 // Check that the remote can afford to pay for this HTLC on-chain at the current
1991 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
1992 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
1993 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
1994 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
1996 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
1997 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2000 let chan_reserve_msat =
2001 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2002 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2003 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2006 if !self.is_outbound() {
2007 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2008 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2009 // receiver's side, only on the sender's.
2010 // Note that when we eventually remove support for fee updates and switch to anchor output
2011 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2012 // the extra htlc when calculating the next remote commitment transaction fee as we should
2013 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2014 // sensitive to fee spikes.
2015 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2016 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2017 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2018 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2019 // the HTLC, i.e. its status is already set to failing.
2020 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation");
2021 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2024 // Check that they won't violate our local required channel reserve by adding this HTLC.
2025 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2026 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2027 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis * 1000 + local_commit_tx_fee_msat {
2028 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2031 if self.next_counterparty_htlc_id != msg.htlc_id {
2032 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2034 if msg.cltv_expiry >= 500000000 {
2035 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2038 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2039 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2040 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2044 // Now update local state:
2045 self.next_counterparty_htlc_id += 1;
2046 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2047 htlc_id: msg.htlc_id,
2048 amount_msat: msg.amount_msat,
2049 payment_hash: msg.payment_hash,
2050 cltv_expiry: msg.cltv_expiry,
2051 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2056 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2058 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
2059 for htlc in self.pending_outbound_htlcs.iter_mut() {
2060 if htlc.htlc_id == htlc_id {
2061 match check_preimage {
2063 Some(payment_hash) =>
2064 if payment_hash != htlc.payment_hash {
2065 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2069 OutboundHTLCState::LocalAnnounced(_) =>
2070 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2071 OutboundHTLCState::Committed => {
2072 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2074 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2075 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2077 return Ok(&htlc.source);
2080 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2083 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
2084 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2085 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2087 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2088 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2091 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2092 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
2095 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2096 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2097 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2099 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2100 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2103 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2107 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2108 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2109 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2111 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2112 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2115 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2119 pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
2120 where F::Target: FeeEstimator,
2123 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2124 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2126 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2127 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2129 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2130 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2133 let funding_script = self.get_funding_redeemscript();
2135 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2137 let mut update_fee = false;
2138 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2140 self.pending_update_fee.unwrap()
2145 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2146 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2147 let commitment_txid = {
2148 let trusted_tx = commitment_tx.0.trust();
2149 let bitcoin_tx = trusted_tx.built_transaction();
2150 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2152 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction), log_bytes!(sighash[..]), encode::serialize_hex(&funding_script));
2153 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2154 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2158 let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2159 (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2162 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2163 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2165 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2166 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2167 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2170 #[cfg(any(test, feature = "fuzztarget"))]
2172 if self.is_outbound() {
2173 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2174 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2175 if let Some(info) = projected_commit_tx_info {
2176 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2177 + self.holding_cell_htlc_updates.len();
2178 if info.total_pending_htlcs == total_pending_htlcs
2179 && info.next_holder_htlc_id == self.next_holder_htlc_id
2180 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2181 && info.feerate == self.feerate_per_kw {
2182 assert_eq!(total_fee, info.fee / 1000);
2188 if msg.htlc_signatures.len() != num_htlcs {
2189 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2192 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2193 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2194 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2195 if let Some(_) = htlc.transaction_output_index {
2196 let htlc_tx = self.build_htlc_transaction(&commitment_txid, &htlc, true, &keys, feerate_per_kw);
2197 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2198 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2199 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript));
2200 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2201 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2203 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2205 htlcs_and_sigs.push((htlc, None, source));
2209 let holder_commitment_tx = HolderCommitmentTransaction::new(
2212 msg.htlc_signatures.clone(),
2213 &self.get_holder_pubkeys().funding_pubkey,
2214 self.counterparty_funding_pubkey()
2217 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2218 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2220 // Update state now that we've passed all the can-fail calls...
2221 let mut need_commitment = false;
2222 if !self.is_outbound() {
2223 if let Some(fee_update) = self.pending_update_fee {
2224 self.feerate_per_kw = fee_update;
2225 // We later use the presence of pending_update_fee to indicate we should generate a
2226 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2227 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2228 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2229 need_commitment = true;
2230 self.pending_update_fee = None;
2235 self.latest_monitor_update_id += 1;
2236 let mut monitor_update = ChannelMonitorUpdate {
2237 update_id: self.latest_monitor_update_id,
2238 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2239 commitment_tx: holder_commitment_tx,
2240 htlc_outputs: htlcs_and_sigs
2244 for htlc in self.pending_inbound_htlcs.iter_mut() {
2245 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2246 Some(forward_info.clone())
2248 if let Some(forward_info) = new_forward {
2249 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2250 need_commitment = true;
2253 for htlc in self.pending_outbound_htlcs.iter_mut() {
2254 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2255 Some(fail_reason.take())
2257 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2258 need_commitment = true;
2262 self.cur_holder_commitment_transaction_number -= 1;
2263 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2264 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2265 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2267 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2268 // In case we initially failed monitor updating without requiring a response, we need
2269 // to make sure the RAA gets sent first.
2270 self.monitor_pending_revoke_and_ack = true;
2271 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2272 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2273 // the corresponding HTLC status updates so that get_last_commitment_update
2274 // includes the right HTLCs.
2275 self.monitor_pending_commitment_signed = true;
2276 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2277 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2278 // strictly increasing by one, so decrement it here.
2279 self.latest_monitor_update_id = monitor_update.update_id;
2280 monitor_update.updates.append(&mut additional_update.updates);
2282 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2283 // re-send the message on restoration)
2284 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2287 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2288 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2289 // we'll send one right away when we get the revoke_and_ack when we
2290 // free_holding_cell_htlcs().
2291 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2292 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2293 // strictly increasing by one, so decrement it here.
2294 self.latest_monitor_update_id = monitor_update.update_id;
2295 monitor_update.updates.append(&mut additional_update.updates);
2297 } else if !need_commitment {
2298 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2299 } else { (None, None) };
2301 Ok((msgs::RevokeAndACK {
2302 channel_id: self.channel_id,
2303 per_commitment_secret,
2304 next_per_commitment_point,
2305 }, commitment_signed, closing_signed, monitor_update))
2308 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2309 /// fulfilling or failing the last pending HTLC)
2310 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2311 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2312 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2313 log_trace!(logger, "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 { "" });
2315 let mut monitor_update = ChannelMonitorUpdate {
2316 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2317 updates: Vec::new(),
2320 let mut htlc_updates = Vec::new();
2321 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2322 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2323 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2324 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2325 let mut htlcs_to_fail = Vec::new();
2326 for htlc_update in htlc_updates.drain(..) {
2327 // Note that this *can* fail, though it should be due to rather-rare conditions on
2328 // fee races with adding too many outputs which push our total payments just over
2329 // the limit. In case it's less rare than I anticipate, we may want to revisit
2330 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2331 // to rebalance channels.
2332 match &htlc_update {
2333 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2334 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2335 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2338 ChannelError::Ignore(ref msg) => {
2339 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2340 // If we fail to send here, then this HTLC should
2341 // be failed backwards. Failing to send here
2342 // indicates that this HTLC may keep being put back
2343 // into the holding cell without ever being
2344 // successfully forwarded/failed/fulfilled, causing
2345 // our counterparty to eventually close on us.
2346 htlcs_to_fail.push((source.clone(), *payment_hash));
2349 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2355 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2356 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2357 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2358 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2359 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2360 monitor_update.updates.append(&mut additional_monitor_update.updates);
2364 if let ChannelError::Ignore(_) = e {}
2366 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2371 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2372 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2373 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2375 if let ChannelError::Ignore(_) = e {}
2377 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2384 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2385 return Ok((None, htlcs_to_fail));
2387 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2388 self.pending_update_fee = self.holding_cell_update_fee.take();
2389 Some(msgs::UpdateFee {
2390 channel_id: self.channel_id,
2391 feerate_per_kw: feerate as u32,
2397 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2398 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2399 // but we want them to be strictly increasing by one, so reset it here.
2400 self.latest_monitor_update_id = monitor_update.update_id;
2401 monitor_update.updates.append(&mut additional_update.updates);
2403 Ok((Some((msgs::CommitmentUpdate {
2405 update_fulfill_htlcs,
2407 update_fail_malformed_htlcs: Vec::new(),
2410 }, monitor_update)), htlcs_to_fail))
2412 Ok((None, Vec::new()))
2416 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2417 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2418 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2419 /// generating an appropriate error *after* the channel state has been updated based on the
2420 /// revoke_and_ack message.
2421 pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2422 where F::Target: FeeEstimator,
2425 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2426 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2428 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2429 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2431 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2432 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2435 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2436 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned())) != counterparty_prev_commitment_point {
2437 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2441 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2442 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2443 // haven't given them a new commitment transaction to broadcast). We should probably
2444 // take advantage of this by updating our channel monitor, sending them an error, and
2445 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2446 // lot of work, and there's some chance this is all a misunderstanding anyway.
2447 // We have to do *something*, though, since our signer may get mad at us for otherwise
2448 // jumping a remote commitment number, so best to just force-close and move on.
2449 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2452 #[cfg(any(test, feature = "fuzztarget"))]
2454 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2455 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2458 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2459 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2460 self.latest_monitor_update_id += 1;
2461 let mut monitor_update = ChannelMonitorUpdate {
2462 update_id: self.latest_monitor_update_id,
2463 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2464 idx: self.cur_counterparty_commitment_transaction_number + 1,
2465 secret: msg.per_commitment_secret,
2469 // Update state now that we've passed all the can-fail calls...
2470 // (note that we may still fail to generate the new commitment_signed message, but that's
2471 // OK, we step the channel here and *then* if the new generation fails we can fail the
2472 // channel based on that, but stepping stuff here should be safe either way.
2473 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2474 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2475 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2476 self.cur_counterparty_commitment_transaction_number -= 1;
2478 log_trace!(logger, "Updating HTLCs on receipt of RAA...");
2479 let mut to_forward_infos = Vec::new();
2480 let mut revoked_htlcs = Vec::new();
2481 let mut update_fail_htlcs = Vec::new();
2482 let mut update_fail_malformed_htlcs = Vec::new();
2483 let mut require_commitment = false;
2484 let mut value_to_self_msat_diff: i64 = 0;
2487 // Take references explicitly so that we can hold multiple references to self.
2488 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2489 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2491 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2492 pending_inbound_htlcs.retain(|htlc| {
2493 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2494 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2495 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2496 value_to_self_msat_diff += htlc.amount_msat as i64;
2501 pending_outbound_htlcs.retain(|htlc| {
2502 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2503 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2504 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2505 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2507 // They fulfilled, so we sent them money
2508 value_to_self_msat_diff -= htlc.amount_msat as i64;
2513 for htlc in pending_inbound_htlcs.iter_mut() {
2514 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2515 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2517 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2518 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2522 let mut state = InboundHTLCState::Committed;
2523 mem::swap(&mut state, &mut htlc.state);
2525 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2526 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2527 require_commitment = true;
2528 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2529 match forward_info {
2530 PendingHTLCStatus::Fail(fail_msg) => {
2531 require_commitment = true;
2533 HTLCFailureMsg::Relay(msg) => {
2534 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2535 update_fail_htlcs.push(msg)
2537 HTLCFailureMsg::Malformed(msg) => {
2538 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2539 update_fail_malformed_htlcs.push(msg)
2543 PendingHTLCStatus::Forward(forward_info) => {
2544 to_forward_infos.push((forward_info, htlc.htlc_id));
2545 htlc.state = InboundHTLCState::Committed;
2551 for htlc in pending_outbound_htlcs.iter_mut() {
2552 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2553 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2554 htlc.state = OutboundHTLCState::Committed;
2556 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2557 Some(fail_reason.take())
2559 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2560 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2561 require_commitment = true;
2565 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2567 if self.is_outbound() {
2568 if let Some(feerate) = self.pending_update_fee.take() {
2569 self.feerate_per_kw = feerate;
2572 if let Some(feerate) = self.pending_update_fee {
2573 // Because a node cannot send two commitment_signeds in a row without getting a
2574 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2575 // it should use to create keys with) and because a node can't send a
2576 // commitment_signed without changes, checking if the feerate is equal to the
2577 // pending feerate update is sufficient to detect require_commitment.
2578 if feerate == self.feerate_per_kw {
2579 require_commitment = true;
2580 self.pending_update_fee = None;
2585 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2586 // We can't actually generate a new commitment transaction (incl by freeing holding
2587 // cells) while we can't update the monitor, so we just return what we have.
2588 if require_commitment {
2589 self.monitor_pending_commitment_signed = true;
2590 // When the monitor updating is restored we'll call get_last_commitment_update(),
2591 // which does not update state, but we're definitely now awaiting a remote revoke
2592 // before we can step forward any more, so set it here.
2593 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2594 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2595 // strictly increasing by one, so decrement it here.
2596 self.latest_monitor_update_id = monitor_update.update_id;
2597 monitor_update.updates.append(&mut additional_update.updates);
2599 self.monitor_pending_forwards.append(&mut to_forward_infos);
2600 self.monitor_pending_failures.append(&mut revoked_htlcs);
2601 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2604 match self.free_holding_cell_htlcs(logger)? {
2605 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2606 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2607 for fail_msg in update_fail_htlcs.drain(..) {
2608 commitment_update.update_fail_htlcs.push(fail_msg);
2610 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2611 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2612 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2615 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2616 // strictly increasing by one, so decrement it here.
2617 self.latest_monitor_update_id = monitor_update.update_id;
2618 monitor_update.updates.append(&mut additional_update.updates);
2620 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2622 (None, htlcs_to_fail) => {
2623 if require_commitment {
2624 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2626 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2627 // strictly increasing by one, so decrement it here.
2628 self.latest_monitor_update_id = monitor_update.update_id;
2629 monitor_update.updates.append(&mut additional_update.updates);
2631 Ok((Some(msgs::CommitmentUpdate {
2632 update_add_htlcs: Vec::new(),
2633 update_fulfill_htlcs: Vec::new(),
2635 update_fail_malformed_htlcs,
2638 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2640 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2647 /// Adds a pending update to this channel. See the doc for send_htlc for
2648 /// further details on the optionness of the return value.
2649 /// You MUST call send_commitment prior to any other calls on this Channel
2650 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2651 if !self.is_outbound() {
2652 panic!("Cannot send fee from inbound channel");
2654 if !self.is_usable() {
2655 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2657 if !self.is_live() {
2658 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2661 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2662 self.holding_cell_update_fee = Some(feerate_per_kw);
2666 debug_assert!(self.pending_update_fee.is_none());
2667 self.pending_update_fee = Some(feerate_per_kw);
2669 Some(msgs::UpdateFee {
2670 channel_id: self.channel_id,
2675 pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2676 match self.send_update_fee(feerate_per_kw) {
2677 Some(update_fee) => {
2678 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2679 Ok(Some((update_fee, commitment_signed, monitor_update)))
2685 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2686 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2687 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2688 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2689 /// No further message handling calls may be made until a channel_reestablish dance has
2691 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Vec<(HTLCSource, PaymentHash)> where L::Target: Logger {
2692 let mut outbound_drops = Vec::new();
2694 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2695 if self.channel_state < ChannelState::FundingSent as u32 {
2696 self.channel_state = ChannelState::ShutdownComplete as u32;
2697 return outbound_drops;
2699 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2700 // will be retransmitted.
2701 self.last_sent_closing_fee = None;
2703 let mut inbound_drop_count = 0;
2704 self.pending_inbound_htlcs.retain(|htlc| {
2706 InboundHTLCState::RemoteAnnounced(_) => {
2707 // They sent us an update_add_htlc but we never got the commitment_signed.
2708 // We'll tell them what commitment_signed we're expecting next and they'll drop
2709 // this HTLC accordingly
2710 inbound_drop_count += 1;
2713 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2714 // We received a commitment_signed updating this HTLC and (at least hopefully)
2715 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2716 // in response to it yet, so don't touch it.
2719 InboundHTLCState::Committed => true,
2720 InboundHTLCState::LocalRemoved(_) => {
2721 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2722 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2723 // (that we missed). Keep this around for now and if they tell us they missed
2724 // the commitment_signed we can re-transmit the update then.
2729 self.next_counterparty_htlc_id -= inbound_drop_count;
2731 for htlc in self.pending_outbound_htlcs.iter_mut() {
2732 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2733 // They sent us an update to remove this but haven't yet sent the corresponding
2734 // commitment_signed, we need to move it back to Committed and they can re-send
2735 // the update upon reconnection.
2736 htlc.state = OutboundHTLCState::Committed;
2740 self.holding_cell_htlc_updates.retain(|htlc_update| {
2742 // Note that currently on channel reestablish we assert that there are
2743 // no holding cell HTLC update_adds, so if in the future we stop
2744 // dropping added HTLCs here and failing them backwards, then there will
2745 // need to be corresponding changes made in the Channel's re-establish
2747 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2748 outbound_drops.push((source.clone(), payment_hash.clone()));
2751 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2754 self.channel_state |= ChannelState::PeerDisconnected as u32;
2755 log_debug!(logger, "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()));
2759 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2760 /// updates are partially paused.
2761 /// This must be called immediately after the call which generated the ChannelMonitor update
2762 /// which failed. The messages which were generated from that call which generated the
2763 /// monitor update failure must *not* have been sent to the remote end, and must instead
2764 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2765 pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2766 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2767 self.monitor_pending_revoke_and_ack = resend_raa;
2768 self.monitor_pending_commitment_signed = resend_commitment;
2769 assert!(self.monitor_pending_forwards.is_empty());
2770 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2771 assert!(self.monitor_pending_failures.is_empty());
2772 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2773 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2776 /// Indicates that the latest ChannelMonitor update has been committed by the client
2777 /// successfully and we should restore normal operation. Returns messages which should be sent
2778 /// to the remote side.
2779 pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<Transaction>, Option<msgs::FundingLocked>) where L::Target: Logger {
2780 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2781 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2783 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
2784 self.funding_transaction.take()
2787 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
2788 // we assume the user never directly broadcasts the funding transaction and waits for us to
2789 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
2790 // channel which failed to persist the monitor on funding_created, and we got the funding
2791 // transaction confirmed before the monitor was persisted.
2792 let funding_locked = if self.monitor_pending_funding_locked {
2793 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
2794 self.monitor_pending_funding_locked = false;
2795 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2796 Some(msgs::FundingLocked {
2797 channel_id: self.channel_id(),
2798 next_per_commitment_point,
2802 let mut forwards = Vec::new();
2803 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2804 let mut failures = Vec::new();
2805 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2807 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2808 self.monitor_pending_revoke_and_ack = false;
2809 self.monitor_pending_commitment_signed = false;
2810 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
2813 let raa = if self.monitor_pending_revoke_and_ack {
2814 Some(self.get_last_revoke_and_ack())
2816 let commitment_update = if self.monitor_pending_commitment_signed {
2817 Some(self.get_last_commitment_update(logger))
2820 self.monitor_pending_revoke_and_ack = false;
2821 self.monitor_pending_commitment_signed = false;
2822 let order = self.resend_order.clone();
2823 log_trace!(logger, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2824 if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
2825 if commitment_update.is_some() { "a" } else { "no" },
2826 if raa.is_some() { "an" } else { "no" },
2827 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2828 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
2831 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2832 where F::Target: FeeEstimator
2834 if self.is_outbound() {
2835 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2837 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2838 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2840 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2841 self.pending_update_fee = Some(msg.feerate_per_kw);
2842 self.update_time_counter += 1;
2846 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2847 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2848 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
2849 msgs::RevokeAndACK {
2850 channel_id: self.channel_id,
2851 per_commitment_secret,
2852 next_per_commitment_point,
2856 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2857 let mut update_add_htlcs = Vec::new();
2858 let mut update_fulfill_htlcs = Vec::new();
2859 let mut update_fail_htlcs = Vec::new();
2860 let mut update_fail_malformed_htlcs = Vec::new();
2862 for htlc in self.pending_outbound_htlcs.iter() {
2863 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2864 update_add_htlcs.push(msgs::UpdateAddHTLC {
2865 channel_id: self.channel_id(),
2866 htlc_id: htlc.htlc_id,
2867 amount_msat: htlc.amount_msat,
2868 payment_hash: htlc.payment_hash,
2869 cltv_expiry: htlc.cltv_expiry,
2870 onion_routing_packet: (**onion_packet).clone(),
2875 for htlc in self.pending_inbound_htlcs.iter() {
2876 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2878 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2879 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2880 channel_id: self.channel_id(),
2881 htlc_id: htlc.htlc_id,
2882 reason: err_packet.clone()
2885 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2886 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2887 channel_id: self.channel_id(),
2888 htlc_id: htlc.htlc_id,
2889 sha256_of_onion: sha256_of_onion.clone(),
2890 failure_code: failure_code.clone(),
2893 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2894 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2895 channel_id: self.channel_id(),
2896 htlc_id: htlc.htlc_id,
2897 payment_preimage: payment_preimage.clone(),
2904 log_trace!(logger, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2905 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2906 msgs::CommitmentUpdate {
2907 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2909 commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2913 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2914 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2915 pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
2916 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2917 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2918 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2919 // just close here instead of trying to recover.
2920 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
2923 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2924 msg.next_local_commitment_number == 0 {
2925 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
2928 if msg.next_remote_commitment_number > 0 {
2929 match msg.data_loss_protect {
2930 OptionalField::Present(ref data_loss) => {
2931 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
2932 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
2933 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
2934 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
2935 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
2937 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
2938 return Err(ChannelError::CloseDelayBroadcast(
2939 "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
2943 OptionalField::Absent => {}
2947 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2948 // remaining cases either succeed or ErrorMessage-fail).
2949 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2951 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2952 Some(msgs::Shutdown {
2953 channel_id: self.channel_id,
2954 scriptpubkey: self.get_closing_scriptpubkey(),
2958 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2959 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2960 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2961 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2962 if msg.next_remote_commitment_number != 0 {
2963 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
2965 // Short circuit the whole handler as there is nothing we can resend them
2966 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2969 // We have OurFundingLocked set!
2970 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2971 return Ok((Some(msgs::FundingLocked {
2972 channel_id: self.channel_id(),
2973 next_per_commitment_point,
2974 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2977 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
2978 // Remote isn't waiting on any RevokeAndACK from us!
2979 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2981 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
2982 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2983 self.monitor_pending_revoke_and_ack = true;
2986 Some(self.get_last_revoke_and_ack())
2989 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
2992 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
2993 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2994 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2995 // the corresponding revoke_and_ack back yet.
2996 let next_counterparty_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2998 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
2999 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3000 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3001 Some(msgs::FundingLocked {
3002 channel_id: self.channel_id(),
3003 next_per_commitment_point,
3007 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3008 if required_revoke.is_some() {
3009 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3011 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3014 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3015 // Note that if in the future we no longer drop holding cell update_adds on peer
3016 // disconnect, this logic will need to be updated.
3017 for htlc_update in self.holding_cell_htlc_updates.iter() {
3018 if let &HTLCUpdateAwaitingACK::AddHTLC { .. } = htlc_update {
3019 debug_assert!(false, "There shouldn't be any add-HTLCs in the holding cell now because they should have been dropped on peer disconnect. Panic here because said HTLCs won't be handled correctly.");
3023 // We're up-to-date and not waiting on a remote revoke (if we are our
3024 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3025 // have received some updates while we were disconnected. Free the holding cell
3027 match self.free_holding_cell_htlcs(logger) {
3028 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3029 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3030 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3031 // If in the future we no longer drop holding cell update_adds on peer
3032 // disconnect, we may be handed some HTLCs to fail backwards here.
3033 assert!(htlcs_to_fail.is_empty());
3034 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg));
3036 Ok((None, htlcs_to_fail)) => {
3037 // If in the future we no longer drop holding cell update_adds on peer
3038 // disconnect, we may be handed some HTLCs to fail backwards here.
3039 assert!(htlcs_to_fail.is_empty());
3040 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
3044 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
3046 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3047 if required_revoke.is_some() {
3048 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3050 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3053 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3054 self.monitor_pending_commitment_signed = true;
3055 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
3058 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), shutdown_msg));
3060 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3064 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3065 where F::Target: FeeEstimator
3067 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3068 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3069 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3073 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3074 if self.feerate_per_kw > proposed_feerate {
3075 proposed_feerate = self.feerate_per_kw;
3077 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3078 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3080 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3081 let sig = self.holder_signer
3082 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3084 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3085 if sig.is_none() { return None; }
3087 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3088 Some(msgs::ClosingSigned {
3089 channel_id: self.channel_id,
3090 fee_satoshis: total_fee_satoshis,
3091 signature: sig.unwrap(),
3095 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3096 where F::Target: FeeEstimator
3098 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3099 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3101 if self.channel_state < ChannelState::FundingSent as u32 {
3102 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3103 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3104 // can do that via error message without getting a connection fail anyway...
3105 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3107 for htlc in self.pending_inbound_htlcs.iter() {
3108 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3109 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3112 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3114 if is_unsupported_shutdown_script(&their_features, &msg.scriptpubkey) {
3115 return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3118 if self.counterparty_shutdown_scriptpubkey.is_some() {
3119 if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3120 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3123 self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3126 // From here on out, we may not fail!
3128 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3129 self.update_time_counter += 1;
3131 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3132 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3133 // cell HTLCs and return them to fail the payment.
3134 self.holding_cell_update_fee = None;
3135 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3136 self.holding_cell_htlc_updates.retain(|htlc_update| {
3138 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3139 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3145 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3146 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3147 // any further commitment updates after we set LocalShutdownSent.
3149 let shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3152 Some(msgs::Shutdown {
3153 channel_id: self.channel_id,
3154 scriptpubkey: self.get_closing_scriptpubkey(),
3158 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3159 self.update_time_counter += 1;
3161 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
3164 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3165 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3166 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3167 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3169 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3171 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3172 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3173 if funding_key[..] < counterparty_funding_key[..] {
3174 tx.input[0].witness.push(sig.serialize_der().to_vec());
3175 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3177 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3178 tx.input[0].witness.push(sig.serialize_der().to_vec());
3180 tx.input[0].witness[1].push(SigHashType::All as u8);
3181 tx.input[0].witness[2].push(SigHashType::All as u8);
3183 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3186 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3187 where F::Target: FeeEstimator
3189 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3190 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3192 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3193 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3195 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3196 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3198 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3199 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3202 let funding_redeemscript = self.get_funding_redeemscript();
3203 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3204 if used_total_fee != msg.fee_satoshis {
3205 return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee greater than the value they can claim. Fee in message: {}", msg.fee_satoshis)));
3207 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3209 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3212 // The remote end may have decided to revoke their output due to inconsistent dust
3213 // limits, so check for that case by re-checking the signature here.
3214 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3215 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3216 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3220 let closing_tx_max_weight = self.get_closing_transaction_weight(
3221 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3222 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3223 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3224 if last_fee == msg.fee_satoshis {
3225 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3226 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3227 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3228 self.channel_state = ChannelState::ShutdownComplete as u32;
3229 self.update_time_counter += 1;
3230 return Ok((None, Some(closing_tx)));
3234 macro_rules! propose_new_feerate {
3235 ($new_feerate: expr) => {
3236 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3237 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3238 let sig = self.holder_signer
3239 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3240 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3241 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3242 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3243 return Ok((Some(msgs::ClosingSigned {
3244 channel_id: self.channel_id,
3245 fee_satoshis: used_total_fee,
3251 let mut min_feerate = 253;
3252 if self.is_outbound() {
3253 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3254 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3255 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3256 if max_feerate <= last_feerate {
3257 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something higher ({}) than our Normal feerate ({})", last_feerate, max_feerate)));
3260 propose_new_feerate!(max_feerate);
3263 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3265 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3266 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3267 if min_feerate >= last_feerate {
3268 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something lower ({}) than our Background feerate ({}).", last_feerate, min_feerate)));
3271 propose_new_feerate!(min_feerate);
3274 let sig = self.holder_signer
3275 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3276 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3277 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3278 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3279 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3281 self.channel_state = ChannelState::ShutdownComplete as u32;
3282 self.update_time_counter += 1;
3284 Ok((Some(msgs::ClosingSigned {
3285 channel_id: self.channel_id,
3286 fee_satoshis: msg.fee_satoshis,
3288 }), Some(closing_tx)))
3291 // Public utilities:
3293 pub fn channel_id(&self) -> [u8; 32] {
3297 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3298 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3299 pub fn get_user_id(&self) -> u64 {
3303 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3304 /// is_usable() returns true).
3305 /// Allowed in any state (including after shutdown)
3306 pub fn get_short_channel_id(&self) -> Option<u64> {
3307 self.short_channel_id
3310 /// Returns the funding_txo we either got from our peer, or were given by
3311 /// get_outbound_funding_created.
3312 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3313 self.channel_transaction_parameters.funding_outpoint
3316 fn get_holder_selected_contest_delay(&self) -> u16 {
3317 self.channel_transaction_parameters.holder_selected_contest_delay
3320 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3321 &self.channel_transaction_parameters.holder_pubkeys
3324 fn get_counterparty_selected_contest_delay(&self) -> u16 {
3325 self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().selected_contest_delay
3328 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3329 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3332 /// Allowed in any state (including after shutdown)
3333 pub fn get_counterparty_node_id(&self) -> PublicKey {
3334 self.counterparty_node_id
3337 /// Allowed in any state (including after shutdown)
3339 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3340 self.holder_htlc_minimum_msat
3343 /// Allowed in any state (including after shutdown)
3344 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3346 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3347 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3348 // channel might have been used to route very small values (either by honest users or as DoS).
3349 self.channel_value_satoshis * 1000 * 9 / 10,
3351 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3355 /// Allowed in any state (including after shutdown)
3356 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3357 self.counterparty_htlc_minimum_msat
3360 pub fn get_value_satoshis(&self) -> u64 {
3361 self.channel_value_satoshis
3364 pub fn get_fee_proportional_millionths(&self) -> u32 {
3365 self.config.fee_proportional_millionths
3368 pub fn get_cltv_expiry_delta(&self) -> u16 {
3369 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3373 pub fn get_feerate(&self) -> u32 {
3377 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3378 self.cur_holder_commitment_transaction_number + 1
3381 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3382 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3385 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3386 self.cur_counterparty_commitment_transaction_number + 2
3390 pub fn get_signer(&self) -> &Signer {
3395 pub fn get_value_stat(&self) -> ChannelValueStat {
3397 value_to_self_msat: self.value_to_self_msat,
3398 channel_value_msat: self.channel_value_satoshis * 1000,
3399 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis * 1000,
3400 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3401 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3402 holding_cell_outbound_amount_msat: {
3404 for h in self.holding_cell_htlc_updates.iter() {
3406 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3414 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3415 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3419 /// Allowed in any state (including after shutdown)
3420 pub fn get_update_time_counter(&self) -> u32 {
3421 self.update_time_counter
3424 pub fn get_latest_monitor_update_id(&self) -> u64 {
3425 self.latest_monitor_update_id
3428 pub fn should_announce(&self) -> bool {
3429 self.config.announced_channel
3432 pub fn is_outbound(&self) -> bool {
3433 self.channel_transaction_parameters.is_outbound_from_holder
3436 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3437 /// Allowed in any state (including after shutdown)
3438 pub fn get_holder_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3439 where F::Target: FeeEstimator
3441 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3442 // output value back into a transaction with the regular channel output:
3444 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3445 let mut res = self.feerate_per_kw as u64 * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3447 if self.is_outbound() {
3448 // + the marginal fee increase cost to us in the commitment transaction:
3449 res += self.feerate_per_kw as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3452 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3453 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as u64 * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3458 /// Returns true if we've ever received a message from the remote end for this Channel
3459 pub fn have_received_message(&self) -> bool {
3460 self.channel_state > (ChannelState::OurInitSent as u32)
3463 /// Returns true if this channel is fully established and not known to be closing.
3464 /// Allowed in any state (including after shutdown)
3465 pub fn is_usable(&self) -> bool {
3466 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3467 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3470 /// Returns true if this channel is currently available for use. This is a superset of
3471 /// is_usable() and considers things like the channel being temporarily disabled.
3472 /// Allowed in any state (including after shutdown)
3473 pub fn is_live(&self) -> bool {
3474 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3477 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3478 /// Allowed in any state (including after shutdown)
3479 pub fn is_awaiting_monitor_update(&self) -> bool {
3480 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3483 /// Returns true if funding_created was sent/received.
3484 pub fn is_funding_initiated(&self) -> bool {
3485 self.channel_state >= ChannelState::FundingSent as u32
3488 /// Returns true if this channel is fully shut down. True here implies that no further actions
3489 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3490 /// will be handled appropriately by the chain monitor.
3491 pub fn is_shutdown(&self) -> bool {
3492 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3493 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3498 pub fn to_disabled_staged(&mut self) {
3499 self.network_sync = UpdateStatus::DisabledStaged;
3502 pub fn to_disabled_marked(&mut self) {
3503 self.network_sync = UpdateStatus::DisabledMarked;
3506 pub fn to_fresh(&mut self) {
3507 self.network_sync = UpdateStatus::Fresh;
3510 pub fn is_disabled_staged(&self) -> bool {
3511 self.network_sync == UpdateStatus::DisabledStaged
3514 pub fn is_disabled_marked(&self) -> bool {
3515 self.network_sync == UpdateStatus::DisabledMarked
3518 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3519 if self.funding_tx_confirmation_height == 0 {
3523 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3524 if funding_tx_confirmations <= 0 {
3525 self.funding_tx_confirmation_height = 0;
3528 if funding_tx_confirmations < self.minimum_depth as i64 {
3532 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3533 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3534 self.channel_state |= ChannelState::OurFundingLocked as u32;
3536 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3537 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3538 self.update_time_counter += 1;
3540 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3541 // We got a reorg but not enough to trigger a force close, just ignore.
3543 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3544 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3546 // We got a reorg but not enough to trigger a force close, just ignore.
3550 if need_commitment_update {
3551 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3552 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3553 return Some(msgs::FundingLocked {
3554 channel_id: self.channel_id,
3555 next_per_commitment_point,
3558 self.monitor_pending_funding_locked = true;
3564 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3565 /// In the first case, we store the confirmation height and calculating the short channel id.
3566 /// In the second, we simply return an Err indicating we need to be force-closed now.
3567 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3568 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3569 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3570 for &(index_in_block, tx) in txdata.iter() {
3571 if let Some(funding_txo) = self.get_funding_txo() {
3572 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3573 // whether they've sent a funding_locked or not), check if we should send one.
3574 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3575 if tx.txid() == funding_txo.txid {
3576 let txo_idx = funding_txo.index as usize;
3577 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3578 tx.output[txo_idx].value != self.channel_value_satoshis {
3579 if self.is_outbound() {
3580 // If we generated the funding transaction and it doesn't match what it
3581 // should, the client is really broken and we should just panic and
3582 // tell them off. That said, because hash collisions happen with high
3583 // probability in fuzztarget mode, if we're fuzzing we just close the
3584 // channel and move on.
3585 #[cfg(not(feature = "fuzztarget"))]
3586 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3588 self.update_time_counter += 1;
3589 return Err(msgs::ErrorMessage {
3590 channel_id: self.channel_id(),
3591 data: "funding tx had wrong script/value or output index".to_owned()
3594 if self.is_outbound() {
3595 for input in tx.input.iter() {
3596 if input.witness.is_empty() {
3597 // We generated a malleable funding transaction, implying we've
3598 // just exposed ourselves to funds loss to our counterparty.
3599 #[cfg(not(feature = "fuzztarget"))]
3600 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3604 self.funding_tx_confirmation_height = height;
3605 self.funding_tx_confirmed_in = Some(*block_hash);
3606 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3607 Ok(scid) => Some(scid),
3608 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3612 // If we allow 1-conf funding, we may need to check for funding_locked here and
3613 // send it immediately instead of waiting for a best_block_updated call (which
3614 // may have already happened for this block).
3615 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3616 return Ok(Some(funding_locked));
3619 for inp in tx.input.iter() {
3620 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3621 log_trace!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(self.channel_id()));
3622 return Err(msgs::ErrorMessage {
3623 channel_id: self.channel_id(),
3624 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3633 /// When a new block is connected, we check the height of the block against outbound holding
3634 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3635 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3636 /// handled by the ChannelMonitor.
3638 /// If we return Err, the channel may have been closed, at which point the standard
3639 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3642 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3644 pub fn best_block_updated(&mut self, height: u32, highest_header_time: u32) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
3645 let mut timed_out_htlcs = Vec::new();
3646 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3647 self.holding_cell_htlc_updates.retain(|htlc_update| {
3649 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3650 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3651 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3659 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3661 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3662 return Ok((Some(funding_locked), timed_out_htlcs));
3665 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3666 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3667 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3668 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3669 if self.funding_tx_confirmation_height == 0 {
3670 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3671 // zero if it has been reorged out, however in either case, our state flags
3672 // indicate we've already sent a funding_locked
3673 funding_tx_confirmations = 0;
3676 // If we've sent funding_locked (or have both sent and received funding_locked), and
3677 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3678 // close the channel and hope we can get the latest state on chain (because presumably
3679 // the funding transaction is at least still in the mempool of most nodes).
3680 if funding_tx_confirmations < self.minimum_depth as i64 / 2 {
3681 return Err(msgs::ErrorMessage {
3682 channel_id: self.channel_id(),
3683 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth, funding_tx_confirmations),
3688 Ok((None, timed_out_htlcs))
3691 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
3692 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
3693 /// before the channel has reached funding_locked and we can just wait for more blocks.
3694 pub fn funding_transaction_unconfirmed(&mut self) -> Result<(), msgs::ErrorMessage> {
3695 if self.funding_tx_confirmation_height != 0 {
3696 // We handle the funding disconnection by calling best_block_updated with a height one
3697 // below where our funding was connected, implying a reorg back to conf_height - 1.
3698 let reorg_height = self.funding_tx_confirmation_height - 1;
3699 // We use the time field to bump the current time we set on channel updates if its
3700 // larger. If we don't know that time has moved forward, we can just set it to the last
3701 // time we saw and it will be ignored.
3702 let best_time = self.update_time_counter;
3703 match self.best_block_updated(reorg_height, best_time) {
3704 Ok((funding_locked, timed_out_htlcs)) => {
3705 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
3706 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
3712 // We never learned about the funding confirmation anyway, just ignore
3717 // Methods to get unprompted messages to send to the remote end (or where we already returned
3718 // something in the handler for the message that prompted this message):
3720 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3721 if !self.is_outbound() {
3722 panic!("Tried to open a channel for an inbound channel?");
3724 if self.channel_state != ChannelState::OurInitSent as u32 {
3725 panic!("Cannot generate an open_channel after we've moved forward");
3728 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3729 panic!("Tried to send an open_channel for a channel that has already advanced");
3732 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3733 let keys = self.get_holder_pubkeys();
3737 temporary_channel_id: self.channel_id,
3738 funding_satoshis: self.channel_value_satoshis,
3739 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3740 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3741 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3742 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3743 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3744 feerate_per_kw: self.feerate_per_kw as u32,
3745 to_self_delay: self.get_holder_selected_contest_delay(),
3746 max_accepted_htlcs: OUR_MAX_HTLCS,
3747 funding_pubkey: keys.funding_pubkey,
3748 revocation_basepoint: keys.revocation_basepoint,
3749 payment_point: keys.payment_point,
3750 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3751 htlc_basepoint: keys.htlc_basepoint,
3752 first_per_commitment_point,
3753 channel_flags: if self.config.announced_channel {1} else {0},
3754 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3758 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3759 if self.is_outbound() {
3760 panic!("Tried to send accept_channel for an outbound channel?");
3762 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3763 panic!("Tried to send accept_channel after channel had moved forward");
3765 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3766 panic!("Tried to send an accept_channel for a channel that has already advanced");
3769 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3770 let keys = self.get_holder_pubkeys();
3772 msgs::AcceptChannel {
3773 temporary_channel_id: self.channel_id,
3774 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3775 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3776 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3777 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3778 minimum_depth: self.minimum_depth,
3779 to_self_delay: self.get_holder_selected_contest_delay(),
3780 max_accepted_htlcs: OUR_MAX_HTLCS,
3781 funding_pubkey: keys.funding_pubkey,
3782 revocation_basepoint: keys.revocation_basepoint,
3783 payment_point: keys.payment_point,
3784 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3785 htlc_basepoint: keys.htlc_basepoint,
3786 first_per_commitment_point,
3787 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3791 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3792 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3793 let counterparty_keys = self.build_remote_transaction_keys()?;
3794 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
3795 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3796 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3799 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3800 /// a funding_created message for the remote peer.
3801 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3802 /// or if called on an inbound channel.
3803 /// Note that channel_id changes during this call!
3804 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3805 /// If an Err is returned, it is a ChannelError::Close.
3806 pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_transaction: Transaction, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
3807 if !self.is_outbound() {
3808 panic!("Tried to create outbound funding_created message on an inbound channel!");
3810 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3811 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)");
3813 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3814 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3815 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3816 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3819 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3820 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3822 let signature = match self.get_outbound_funding_created_signature(logger) {
3825 log_error!(logger, "Got bad signatures: {:?}!", e);
3826 self.channel_transaction_parameters.funding_outpoint = None;
3831 let temporary_channel_id = self.channel_id;
3833 // Now that we're past error-generating stuff, update our local state:
3835 self.channel_state = ChannelState::FundingCreated as u32;
3836 self.channel_id = funding_txo.to_channel_id();
3837 self.funding_transaction = Some(funding_transaction);
3839 Ok(msgs::FundingCreated {
3840 temporary_channel_id,
3841 funding_txid: funding_txo.txid,
3842 funding_output_index: funding_txo.index,
3847 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3848 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3849 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3850 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3851 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3853 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3854 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3855 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3856 if !self.config.announced_channel {
3857 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3859 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3860 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3862 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3863 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3866 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
3868 let msg = msgs::UnsignedChannelAnnouncement {
3869 features: ChannelFeatures::known(),
3871 short_channel_id: self.get_short_channel_id().unwrap(),
3872 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
3873 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
3874 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
3875 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
3876 excess_data: Vec::new(),
3879 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
3880 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
3885 /// May panic if called on a channel that wasn't immediately-previously
3886 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3887 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3888 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3889 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3890 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3891 // current to_remote balances. However, it no longer has any use, and thus is now simply
3892 // set to a dummy (but valid, as required by the spec) public key.
3893 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3894 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3895 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3896 let mut pk = [2; 33]; pk[1] = 0xff;
3897 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3898 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3899 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
3900 log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3901 OptionalField::Present(DataLossProtect {
3902 your_last_per_commitment_secret: remote_last_secret,
3903 my_current_per_commitment_point: dummy_pubkey
3906 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3907 OptionalField::Present(DataLossProtect {
3908 your_last_per_commitment_secret: [0;32],
3909 my_current_per_commitment_point: dummy_pubkey,
3912 msgs::ChannelReestablish {
3913 channel_id: self.channel_id(),
3914 // The protocol has two different commitment number concepts - the "commitment
3915 // transaction number", which starts from 0 and counts up, and the "revocation key
3916 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3917 // commitment transaction numbers by the index which will be used to reveal the
3918 // revocation key for that commitment transaction, which means we have to convert them
3919 // to protocol-level commitment numbers here...
3921 // next_local_commitment_number is the next commitment_signed number we expect to
3922 // receive (indicating if they need to resend one that we missed).
3923 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
3924 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3925 // receive, however we track it by the next commitment number for a remote transaction
3926 // (which is one further, as they always revoke previous commitment transaction, not
3927 // the one we send) so we have to decrement by 1. Note that if
3928 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3929 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3931 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
3937 // Send stuff to our remote peers:
3939 /// Adds a pending outbound HTLC to this channel, note that you probably want
3940 /// send_htlc_and_commit instead cause you'll want both messages at once.
3941 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3942 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3943 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3944 /// You MUST call send_commitment prior to any other calls on this Channel
3945 /// If an Err is returned, it's a ChannelError::Ignore!
3946 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> {
3947 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3948 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
3950 let channel_total_msat = self.channel_value_satoshis * 1000;
3951 if amount_msat > channel_total_msat {
3952 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
3955 if amount_msat == 0 {
3956 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
3959 if amount_msat < self.counterparty_htlc_minimum_msat {
3960 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
3963 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3964 // Note that this should never really happen, if we're !is_live() on receipt of an
3965 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3966 // the user to send directly into a !is_live() channel. However, if we
3967 // disconnected during the time the previous hop was doing the commitment dance we may
3968 // end up getting here after the forwarding delay. In any case, returning an
3969 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3970 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update".to_owned()));
3973 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3974 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
3975 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
3977 // Check their_max_htlc_value_in_flight_msat
3978 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
3979 return Err(ChannelError::Ignore(format!("Cannot send value that would put us over the max HTLC value in flight our peer will accept ({})", self.counterparty_max_htlc_value_in_flight_msat)));
3982 if !self.is_outbound() {
3983 // Check that we won't violate the remote channel reserve by adding this HTLC.
3984 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
3985 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
3986 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
3987 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
3988 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
3989 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
3993 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
3994 if pending_value_to_self_msat < amount_msat {
3995 return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, pending_value_to_self_msat)));
3998 // `2 *` and extra HTLC are for the fee spike buffer.
3999 let commit_tx_fee_msat = if self.is_outbound() {
4000 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4001 2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4003 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4004 return Err(ChannelError::Ignore(format!("Cannot send value that would not leave enough to pay for fees. Pending value to self: {}. local_commit_tx_fee {}", pending_value_to_self_msat, commit_tx_fee_msat)));
4007 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4008 // reserve for the remote to have something to claim if we misbehave)
4009 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis * 1000;
4010 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4011 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4014 // Now update local state:
4015 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4016 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4021 onion_routing_packet,
4026 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4027 htlc_id: self.next_holder_htlc_id,
4029 payment_hash: payment_hash.clone(),
4031 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4035 let res = msgs::UpdateAddHTLC {
4036 channel_id: self.channel_id,
4037 htlc_id: self.next_holder_htlc_id,
4041 onion_routing_packet,
4043 self.next_holder_htlc_id += 1;
4048 /// Creates a signed commitment transaction to send to the remote peer.
4049 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4050 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4051 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4052 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4053 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4054 panic!("Cannot create commitment tx until channel is fully established");
4056 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4057 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4059 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4060 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4062 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4063 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");
4065 let mut have_updates = self.pending_update_fee.is_some();
4066 for htlc in self.pending_outbound_htlcs.iter() {
4067 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4068 have_updates = true;
4070 if have_updates { break; }
4072 for htlc in self.pending_inbound_htlcs.iter() {
4073 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4074 have_updates = true;
4076 if have_updates { break; }
4079 panic!("Cannot create commitment tx until we have some updates to send");
4081 self.send_commitment_no_status_check(logger)
4083 /// Only fails in case of bad keys
4084 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4085 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4086 // fail to generate this, we still are at least at a position where upgrading their status
4088 for htlc in self.pending_inbound_htlcs.iter_mut() {
4089 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4090 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4092 if let Some(state) = new_state {
4096 for htlc in self.pending_outbound_htlcs.iter_mut() {
4097 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4098 Some(fail_reason.take())
4100 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4103 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4105 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4106 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4107 // Update state now that we've passed all the can-fail calls...
4108 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4109 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4110 (res, counterparty_commitment_tx, htlcs_no_ref)
4112 Err(e) => return Err(e),
4115 self.latest_monitor_update_id += 1;
4116 let monitor_update = ChannelMonitorUpdate {
4117 update_id: self.latest_monitor_update_id,
4118 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4119 commitment_txid: counterparty_commitment_txid,
4120 htlc_outputs: htlcs.clone(),
4121 commitment_number: self.cur_counterparty_commitment_transaction_number,
4122 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4125 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4126 Ok((res, monitor_update))
4129 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4130 /// when we shouldn't change HTLC/channel state.
4131 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4132 let mut feerate_per_kw = self.feerate_per_kw;
4133 if let Some(feerate) = self.pending_update_fee {
4134 if self.is_outbound() {
4135 feerate_per_kw = feerate;
4139 let counterparty_keys = self.build_remote_transaction_keys()?;
4140 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4141 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4142 let (signature, htlc_signatures);
4144 #[cfg(any(test, feature = "fuzztarget"))]
4146 if !self.is_outbound() {
4147 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4148 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4149 if let Some(info) = projected_commit_tx_info {
4150 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4151 if info.total_pending_htlcs == total_pending_htlcs
4152 && info.next_holder_htlc_id == self.next_holder_htlc_id
4153 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4154 && info.feerate == self.feerate_per_kw {
4155 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4156 assert_eq!(actual_fee, info.fee);
4163 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4164 for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4168 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4169 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4171 htlc_signatures = res.1;
4173 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {}",
4174 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4175 &counterparty_commitment_txid,
4176 encode::serialize_hex(&self.get_funding_redeemscript()),
4177 log_bytes!(signature.serialize_compact()[..]));
4179 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4180 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
4181 encode::serialize_hex(&chan_utils::build_htlc_transaction(&counterparty_commitment_txid, feerate_per_kw, self.get_holder_selected_contest_delay(), htlc, &counterparty_keys.broadcaster_delayed_payment_key, &counterparty_keys.revocation_key)),
4182 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4183 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4184 log_bytes!(htlc_sig.serialize_compact()[..]));
4188 Ok((msgs::CommitmentSigned {
4189 channel_id: self.channel_id,
4192 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4195 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4196 /// to send to the remote peer in one go.
4197 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4199 pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
4200 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4201 Some(update_add_htlc) => {
4202 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4203 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4209 /// Get forwarding information for the counterparty.
4210 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4211 self.counterparty_forwarding_info.clone()
4214 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4215 let usable_channel_value_msat = (self.channel_value_satoshis - self.counterparty_selected_channel_reserve_satoshis) * 1000;
4216 if msg.contents.htlc_minimum_msat >= usable_channel_value_msat {
4217 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4219 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4220 fee_base_msat: msg.contents.fee_base_msat,
4221 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4222 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4228 /// Begins the shutdown process, getting a message for the remote peer and returning all
4229 /// holding cell HTLCs for payment failure.
4230 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
4231 for htlc in self.pending_outbound_htlcs.iter() {
4232 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4233 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4236 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4237 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4238 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4240 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4241 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4244 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4245 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4246 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?".to_owned()});
4249 let closing_script = self.get_closing_scriptpubkey();
4251 // From here on out, we may not fail!
4252 if self.channel_state < ChannelState::FundingSent as u32 {
4253 self.channel_state = ChannelState::ShutdownComplete as u32;
4255 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4257 self.update_time_counter += 1;
4259 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4260 // our shutdown until we've committed all of the pending changes.
4261 self.holding_cell_update_fee = None;
4262 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4263 self.holding_cell_htlc_updates.retain(|htlc_update| {
4265 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4266 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4273 Ok((msgs::Shutdown {
4274 channel_id: self.channel_id,
4275 scriptpubkey: closing_script,
4276 }, dropped_outbound_htlcs))
4279 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4280 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4281 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4282 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4283 /// immediately (others we will have to allow to time out).
4284 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4285 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4286 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4287 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4288 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4289 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4291 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4292 // return them to fail the payment.
4293 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4294 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4296 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4297 dropped_outbound_htlcs.push((source, payment_hash));
4302 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4303 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4304 // returning a channel monitor update here would imply a channel monitor update before
4305 // we even registered the channel monitor to begin with, which is invalid.
4306 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4307 // funding transaction, don't return a funding txo (which prevents providing the
4308 // monitor update to the user, even if we return one).
4309 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4310 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4311 self.latest_monitor_update_id += 1;
4312 Some((funding_txo, ChannelMonitorUpdate {
4313 update_id: self.latest_monitor_update_id,
4314 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4319 self.channel_state = ChannelState::ShutdownComplete as u32;
4320 self.update_time_counter += 1;
4321 (monitor_update, dropped_outbound_htlcs)
4325 fn is_unsupported_shutdown_script(their_features: &InitFeatures, script: &Script) -> bool {
4326 // We restrain shutdown scripts to standards forms to avoid transactions not propagating on the p2p tx-relay network
4328 // BOLT 2 says we must only send a scriptpubkey of certain standard forms,
4329 // which for a a BIP-141-compliant witness program is at max 42 bytes in length.
4330 // So don't let the remote peer feed us some super fee-heavy script.
4331 let is_script_too_long = script.len() > 42;
4332 if is_script_too_long {
4336 if their_features.supports_shutdown_anysegwit() && script.is_witness_program() && script.as_bytes()[0] != OP_PUSHBYTES_0.into_u8() {
4340 return !script.is_p2pkh() && !script.is_p2sh() && !script.is_v0_p2wpkh() && !script.is_v0_p2wsh()
4343 const SERIALIZATION_VERSION: u8 = 1;
4344 const MIN_SERIALIZATION_VERSION: u8 = 1;
4346 impl Writeable for InboundHTLCRemovalReason {
4347 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4349 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
4351 error_packet.write(writer)?;
4353 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
4355 onion_hash.write(writer)?;
4356 err_code.write(writer)?;
4358 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
4360 payment_preimage.write(writer)?;
4367 impl Readable for InboundHTLCRemovalReason {
4368 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4369 Ok(match <u8 as Readable>::read(reader)? {
4370 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
4371 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
4372 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
4373 _ => return Err(DecodeError::InvalidValue),
4378 impl<Signer: Sign> Writeable for Channel<Signer> {
4379 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4380 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4381 // called but include holding cell updates (and obviously we don't modify self).
4383 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4384 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4386 self.user_id.write(writer)?;
4387 self.config.write(writer)?;
4389 self.channel_id.write(writer)?;
4390 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4391 self.channel_value_satoshis.write(writer)?;
4393 self.latest_monitor_update_id.write(writer)?;
4395 let mut key_data = VecWriter(Vec::new());
4396 self.holder_signer.write(&mut key_data)?;
4397 assert!(key_data.0.len() < std::usize::MAX);
4398 assert!(key_data.0.len() < std::u32::MAX as usize);
4399 (key_data.0.len() as u32).write(writer)?;
4400 writer.write_all(&key_data.0[..])?;
4402 self.shutdown_pubkey.write(writer)?;
4403 self.destination_script.write(writer)?;
4405 self.cur_holder_commitment_transaction_number.write(writer)?;
4406 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4407 self.value_to_self_msat.write(writer)?;
4409 let mut dropped_inbound_htlcs = 0;
4410 for htlc in self.pending_inbound_htlcs.iter() {
4411 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4412 dropped_inbound_htlcs += 1;
4415 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4416 for htlc in self.pending_inbound_htlcs.iter() {
4417 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4420 htlc.htlc_id.write(writer)?;
4421 htlc.amount_msat.write(writer)?;
4422 htlc.cltv_expiry.write(writer)?;
4423 htlc.payment_hash.write(writer)?;
4425 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4426 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4428 htlc_state.write(writer)?;
4430 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4432 htlc_state.write(writer)?;
4434 &InboundHTLCState::Committed => {
4437 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4439 removal_reason.write(writer)?;
4444 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4445 for htlc in self.pending_outbound_htlcs.iter() {
4446 htlc.htlc_id.write(writer)?;
4447 htlc.amount_msat.write(writer)?;
4448 htlc.cltv_expiry.write(writer)?;
4449 htlc.payment_hash.write(writer)?;
4450 htlc.source.write(writer)?;
4452 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4454 onion_packet.write(writer)?;
4456 &OutboundHTLCState::Committed => {
4459 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
4461 fail_reason.write(writer)?;
4463 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4465 fail_reason.write(writer)?;
4467 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4469 fail_reason.write(writer)?;
4474 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4475 for update in self.holding_cell_htlc_updates.iter() {
4477 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4479 amount_msat.write(writer)?;
4480 cltv_expiry.write(writer)?;
4481 payment_hash.write(writer)?;
4482 source.write(writer)?;
4483 onion_routing_packet.write(writer)?;
4485 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4487 payment_preimage.write(writer)?;
4488 htlc_id.write(writer)?;
4490 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4492 htlc_id.write(writer)?;
4493 err_packet.write(writer)?;
4498 match self.resend_order {
4499 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4500 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4503 self.monitor_pending_funding_locked.write(writer)?;
4504 self.monitor_pending_revoke_and_ack.write(writer)?;
4505 self.monitor_pending_commitment_signed.write(writer)?;
4507 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4508 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4509 pending_forward.write(writer)?;
4510 htlc_id.write(writer)?;
4513 (self.monitor_pending_failures.len() as u64).write(writer)?;
4514 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4515 htlc_source.write(writer)?;
4516 payment_hash.write(writer)?;
4517 fail_reason.write(writer)?;
4520 self.pending_update_fee.write(writer)?;
4521 self.holding_cell_update_fee.write(writer)?;
4523 self.next_holder_htlc_id.write(writer)?;
4524 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4525 self.update_time_counter.write(writer)?;
4526 self.feerate_per_kw.write(writer)?;
4528 match self.last_sent_closing_fee {
4529 Some((feerate, fee, sig)) => {
4531 feerate.write(writer)?;
4535 None => 0u8.write(writer)?,
4538 self.funding_tx_confirmed_in.write(writer)?;
4539 self.funding_tx_confirmation_height.write(writer)?;
4540 self.short_channel_id.write(writer)?;
4542 self.counterparty_dust_limit_satoshis.write(writer)?;
4543 self.holder_dust_limit_satoshis.write(writer)?;
4544 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4545 self.counterparty_selected_channel_reserve_satoshis.write(writer)?;
4546 self.counterparty_htlc_minimum_msat.write(writer)?;
4547 self.holder_htlc_minimum_msat.write(writer)?;
4548 self.counterparty_max_accepted_htlcs.write(writer)?;
4549 self.minimum_depth.write(writer)?;
4551 match &self.counterparty_forwarding_info {
4554 info.fee_base_msat.write(writer)?;
4555 info.fee_proportional_millionths.write(writer)?;
4556 info.cltv_expiry_delta.write(writer)?;
4558 None => 0u8.write(writer)?
4561 self.channel_transaction_parameters.write(writer)?;
4562 self.funding_transaction.write(writer)?;
4564 self.counterparty_cur_commitment_point.write(writer)?;
4565 self.counterparty_prev_commitment_point.write(writer)?;
4566 self.counterparty_node_id.write(writer)?;
4568 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4570 self.commitment_secrets.write(writer)?;
4575 const MAX_ALLOC_SIZE: usize = 64*1024;
4576 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4577 where K::Target: KeysInterface<Signer = Signer> {
4578 fn read<R : ::std::io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4579 let _ver: u8 = Readable::read(reader)?;
4580 let min_ver: u8 = Readable::read(reader)?;
4581 if min_ver > SERIALIZATION_VERSION {
4582 return Err(DecodeError::UnknownVersion);
4585 let user_id = Readable::read(reader)?;
4586 let config: ChannelConfig = Readable::read(reader)?;
4588 let channel_id = Readable::read(reader)?;
4589 let channel_state = Readable::read(reader)?;
4590 let channel_value_satoshis = Readable::read(reader)?;
4592 let latest_monitor_update_id = Readable::read(reader)?;
4594 let keys_len: u32 = Readable::read(reader)?;
4595 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4596 while keys_data.len() != keys_len as usize {
4597 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4598 let mut data = [0; 1024];
4599 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4600 reader.read_exact(read_slice)?;
4601 keys_data.extend_from_slice(read_slice);
4603 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4605 let shutdown_pubkey = Readable::read(reader)?;
4606 let destination_script = Readable::read(reader)?;
4608 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4609 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4610 let value_to_self_msat = Readable::read(reader)?;
4612 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4613 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4614 for _ in 0..pending_inbound_htlc_count {
4615 pending_inbound_htlcs.push(InboundHTLCOutput {
4616 htlc_id: Readable::read(reader)?,
4617 amount_msat: Readable::read(reader)?,
4618 cltv_expiry: Readable::read(reader)?,
4619 payment_hash: Readable::read(reader)?,
4620 state: match <u8 as Readable>::read(reader)? {
4621 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4622 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4623 3 => InboundHTLCState::Committed,
4624 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4625 _ => return Err(DecodeError::InvalidValue),
4630 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4631 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4632 for _ in 0..pending_outbound_htlc_count {
4633 pending_outbound_htlcs.push(OutboundHTLCOutput {
4634 htlc_id: Readable::read(reader)?,
4635 amount_msat: Readable::read(reader)?,
4636 cltv_expiry: Readable::read(reader)?,
4637 payment_hash: Readable::read(reader)?,
4638 source: Readable::read(reader)?,
4639 state: match <u8 as Readable>::read(reader)? {
4640 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4641 1 => OutboundHTLCState::Committed,
4642 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4643 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4644 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4645 _ => return Err(DecodeError::InvalidValue),
4650 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4651 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4652 for _ in 0..holding_cell_htlc_update_count {
4653 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4654 0 => HTLCUpdateAwaitingACK::AddHTLC {
4655 amount_msat: Readable::read(reader)?,
4656 cltv_expiry: Readable::read(reader)?,
4657 payment_hash: Readable::read(reader)?,
4658 source: Readable::read(reader)?,
4659 onion_routing_packet: Readable::read(reader)?,
4661 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4662 payment_preimage: Readable::read(reader)?,
4663 htlc_id: Readable::read(reader)?,
4665 2 => HTLCUpdateAwaitingACK::FailHTLC {
4666 htlc_id: Readable::read(reader)?,
4667 err_packet: Readable::read(reader)?,
4669 _ => return Err(DecodeError::InvalidValue),
4673 let resend_order = match <u8 as Readable>::read(reader)? {
4674 0 => RAACommitmentOrder::CommitmentFirst,
4675 1 => RAACommitmentOrder::RevokeAndACKFirst,
4676 _ => return Err(DecodeError::InvalidValue),
4679 let monitor_pending_funding_locked = Readable::read(reader)?;
4680 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4681 let monitor_pending_commitment_signed = Readable::read(reader)?;
4683 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4684 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4685 for _ in 0..monitor_pending_forwards_count {
4686 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4689 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4690 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4691 for _ in 0..monitor_pending_failures_count {
4692 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4695 let pending_update_fee = Readable::read(reader)?;
4696 let holding_cell_update_fee = Readable::read(reader)?;
4698 let next_holder_htlc_id = Readable::read(reader)?;
4699 let next_counterparty_htlc_id = Readable::read(reader)?;
4700 let update_time_counter = Readable::read(reader)?;
4701 let feerate_per_kw = Readable::read(reader)?;
4703 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4705 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4706 _ => return Err(DecodeError::InvalidValue),
4709 let funding_tx_confirmed_in = Readable::read(reader)?;
4710 let funding_tx_confirmation_height = Readable::read(reader)?;
4711 let short_channel_id = Readable::read(reader)?;
4713 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4714 let holder_dust_limit_satoshis = Readable::read(reader)?;
4715 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4716 let counterparty_selected_channel_reserve_satoshis = Readable::read(reader)?;
4717 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4718 let holder_htlc_minimum_msat = Readable::read(reader)?;
4719 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4720 let minimum_depth = Readable::read(reader)?;
4722 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
4724 1 => Some(CounterpartyForwardingInfo {
4725 fee_base_msat: Readable::read(reader)?,
4726 fee_proportional_millionths: Readable::read(reader)?,
4727 cltv_expiry_delta: Readable::read(reader)?,
4729 _ => return Err(DecodeError::InvalidValue),
4732 let channel_parameters = Readable::read(reader)?;
4733 let funding_transaction = Readable::read(reader)?;
4735 let counterparty_cur_commitment_point = Readable::read(reader)?;
4737 let counterparty_prev_commitment_point = Readable::read(reader)?;
4738 let counterparty_node_id = Readable::read(reader)?;
4740 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
4741 let commitment_secrets = Readable::read(reader)?;
4743 let mut secp_ctx = Secp256k1::new();
4744 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
4753 channel_value_satoshis,
4755 latest_monitor_update_id,
4761 cur_holder_commitment_transaction_number,
4762 cur_counterparty_commitment_transaction_number,
4765 pending_inbound_htlcs,
4766 pending_outbound_htlcs,
4767 holding_cell_htlc_updates,
4771 monitor_pending_funding_locked,
4772 monitor_pending_revoke_and_ack,
4773 monitor_pending_commitment_signed,
4774 monitor_pending_forwards,
4775 monitor_pending_failures,
4778 holding_cell_update_fee,
4779 next_holder_htlc_id,
4780 next_counterparty_htlc_id,
4781 update_time_counter,
4784 #[cfg(debug_assertions)]
4785 holder_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4786 #[cfg(debug_assertions)]
4787 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4789 last_sent_closing_fee,
4791 funding_tx_confirmed_in,
4792 funding_tx_confirmation_height,
4795 counterparty_dust_limit_satoshis,
4796 holder_dust_limit_satoshis,
4797 counterparty_max_htlc_value_in_flight_msat,
4798 counterparty_selected_channel_reserve_satoshis,
4799 counterparty_htlc_minimum_msat,
4800 holder_htlc_minimum_msat,
4801 counterparty_max_accepted_htlcs,
4804 counterparty_forwarding_info,
4806 channel_transaction_parameters: channel_parameters,
4807 funding_transaction,
4809 counterparty_cur_commitment_point,
4810 counterparty_prev_commitment_point,
4811 counterparty_node_id,
4813 counterparty_shutdown_scriptpubkey,
4817 network_sync: UpdateStatus::Fresh,
4819 #[cfg(any(test, feature = "fuzztarget"))]
4820 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
4821 #[cfg(any(test, feature = "fuzztarget"))]
4822 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
4829 use bitcoin::util::bip143;
4830 use bitcoin::consensus::encode::serialize;
4831 use bitcoin::blockdata::script::{Script, Builder};
4832 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
4833 use bitcoin::blockdata::constants::genesis_block;
4834 use bitcoin::blockdata::opcodes;
4835 use bitcoin::network::constants::Network;
4836 use bitcoin::hashes::hex::FromHex;
4838 use ln::{PaymentPreimage, PaymentHash};
4839 use ln::channelmanager::{BestBlock, HTLCSource};
4840 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
4841 use ln::channel::MAX_FUNDING_SATOSHIS;
4842 use ln::features::InitFeatures;
4843 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
4845 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
4846 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4847 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
4848 use chain::transaction::OutPoint;
4849 use util::config::UserConfig;
4850 use util::enforcing_trait_impls::EnforcingSigner;
4851 use util::test_utils;
4852 use util::logger::Logger;
4853 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4854 use bitcoin::secp256k1::ffi::Signature as FFISignature;
4855 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4856 use bitcoin::secp256k1::recovery::RecoverableSignature;
4857 use bitcoin::hashes::sha256::Hash as Sha256;
4858 use bitcoin::hashes::Hash;
4859 use bitcoin::hash_types::{Txid, WPubkeyHash};
4862 struct TestFeeEstimator {
4865 impl FeeEstimator for TestFeeEstimator {
4866 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
4872 fn test_max_funding_satoshis() {
4873 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4874 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4878 signer: InMemorySigner,
4880 impl KeysInterface for Keys {
4881 type Signer = InMemorySigner;
4883 fn get_node_secret(&self) -> SecretKey { panic!(); }
4884 fn get_destination_script(&self) -> Script {
4885 let secp_ctx = Secp256k1::signing_only();
4886 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4887 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4888 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
4891 fn get_shutdown_pubkey(&self) -> PublicKey {
4892 let secp_ctx = Secp256k1::signing_only();
4893 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4894 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4897 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
4900 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
4901 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
4902 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
4905 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4906 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4909 // Check that, during channel creation, we use the same feerate in the open channel message
4910 // as we do in the Channel object creation itself.
4912 fn test_open_channel_msg_fee() {
4913 let original_fee = 253;
4914 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
4915 let secp_ctx = Secp256k1::new();
4916 let seed = [42; 32];
4917 let network = Network::Testnet;
4918 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4920 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4921 let config = UserConfig::default();
4922 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4924 // Now change the fee so we can check that the fee in the open_channel message is the
4925 // same as the old fee.
4926 fee_est.fee_est = 500;
4927 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
4928 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
4932 fn test_holder_vs_counterparty_dust_limit() {
4933 // Test that when calculating the local and remote commitment transaction fees, the correct
4934 // dust limits are used.
4935 let feeest = TestFeeEstimator{fee_est: 15000};
4936 let secp_ctx = Secp256k1::new();
4937 let seed = [42; 32];
4938 let network = Network::Testnet;
4939 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4941 // Go through the flow of opening a channel between two nodes, making sure
4942 // they have different dust limits.
4944 // Create Node A's channel pointing to Node B's pubkey
4945 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4946 let config = UserConfig::default();
4947 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
4949 // Create Node B's channel by receiving Node A's open_channel message
4950 // Make sure A's dust limit is as we expect.
4951 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
4952 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4953 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
4955 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
4956 let mut accept_channel_msg = node_b_chan.get_accept_channel();
4957 accept_channel_msg.dust_limit_satoshis = 546;
4958 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4959 node_a_chan.holder_dust_limit_satoshis = 1560;
4961 // Put some inbound and outbound HTLCs in A's channel.
4962 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
4963 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
4965 amount_msat: htlc_amount_msat,
4966 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
4967 cltv_expiry: 300000000,
4968 state: InboundHTLCState::Committed,
4971 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
4973 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
4974 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
4975 cltv_expiry: 200000000,
4976 state: OutboundHTLCState::Committed,
4977 source: HTLCSource::OutboundRoute {
4979 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4980 first_hop_htlc_msat: 548,
4984 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
4985 // the dust limit check.
4986 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
4987 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
4988 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
4989 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
4991 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
4992 // of the HTLCs are seen to be above the dust limit.
4993 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
4994 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
4995 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
4996 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4997 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5001 fn test_timeout_vs_success_htlc_dust_limit() {
5002 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5003 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5004 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5005 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5006 let fee_est = TestFeeEstimator{fee_est: 253 };
5007 let secp_ctx = Secp256k1::new();
5008 let seed = [42; 32];
5009 let network = Network::Testnet;
5010 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5012 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5013 let config = UserConfig::default();
5014 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, 10000000, 100000, 42, &config).unwrap();
5016 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5017 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5019 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5020 // counted as dust when it shouldn't be.
5021 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5022 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5023 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5024 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5026 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5027 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5028 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5029 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5030 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5032 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5034 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5035 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5036 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5037 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5038 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5040 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5041 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5042 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5043 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5044 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5048 fn channel_reestablish_no_updates() {
5049 let feeest = TestFeeEstimator{fee_est: 15000};
5050 let logger = test_utils::TestLogger::new();
5051 let secp_ctx = Secp256k1::new();
5052 let seed = [42; 32];
5053 let network = Network::Testnet;
5054 let best_block = BestBlock::from_genesis(network);
5055 let chain_hash = best_block.block_hash();
5056 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5058 // Go through the flow of opening a channel between two nodes.
5060 // Create Node A's channel pointing to Node B's pubkey
5061 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5062 let config = UserConfig::default();
5063 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5065 // Create Node B's channel by receiving Node A's open_channel message
5066 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5067 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5068 let mut node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5070 // Node B --> Node A: accept channel
5071 let accept_channel_msg = node_b_chan.get_accept_channel();
5072 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5074 // Node A --> Node B: funding created
5075 let output_script = node_a_chan.get_funding_redeemscript();
5076 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5077 value: 10000000, script_pubkey: output_script.clone(),
5079 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5080 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5081 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5083 // Node B --> Node A: funding signed
5084 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5086 // Now disconnect the two nodes and check that the commitment point in
5087 // Node B's channel_reestablish message is sane.
5088 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5089 let msg = node_b_chan.get_channel_reestablish(&&logger);
5090 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5091 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5092 match msg.data_loss_protect {
5093 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5094 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5099 // Check that the commitment point in Node A's channel_reestablish message
5101 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5102 let msg = node_a_chan.get_channel_reestablish(&&logger);
5103 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5104 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5105 match msg.data_loss_protect {
5106 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5107 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5114 fn channel_update() {
5115 let feeest = TestFeeEstimator{fee_est: 15000};
5116 let secp_ctx = Secp256k1::new();
5117 let seed = [42; 32];
5118 let network = Network::Testnet;
5119 let chain_hash = genesis_block(network).header.block_hash();
5120 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5122 // Create a channel.
5123 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5124 let config = UserConfig::default();
5125 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5126 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5127 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5128 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5130 // Make sure that receiving a channel update will update the Channel as expected.
5131 let update = ChannelUpdate {
5132 contents: UnsignedChannelUpdate {
5134 short_channel_id: 0,
5137 cltv_expiry_delta: 100,
5138 htlc_minimum_msat: 5,
5139 htlc_maximum_msat: OptionalField::Absent,
5141 fee_proportional_millionths: 11,
5142 excess_data: Vec::new(),
5144 signature: Signature::from(unsafe { FFISignature::new() })
5146 node_a_chan.channel_update(&update).unwrap();
5148 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5149 // change our official htlc_minimum_msat.
5150 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5151 match node_a_chan.counterparty_forwarding_info() {
5153 assert_eq!(info.cltv_expiry_delta, 100);
5154 assert_eq!(info.fee_base_msat, 110);
5155 assert_eq!(info.fee_proportional_millionths, 11);
5157 None => panic!("expected counterparty forwarding info to be Some")
5162 fn outbound_commitment_test() {
5163 // Test vectors from BOLT 3 Appendix C:
5164 let feeest = TestFeeEstimator{fee_est: 15000};
5165 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5166 let secp_ctx = Secp256k1::new();
5168 let mut signer = InMemorySigner::new(
5170 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5171 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5172 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5173 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5174 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5176 // These aren't set in the test vectors:
5177 [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],
5182 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5183 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5184 let keys_provider = Keys { signer: signer.clone() };
5186 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5187 let mut config = UserConfig::default();
5188 config.channel_options.announced_channel = false;
5189 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5190 chan.holder_dust_limit_satoshis = 546;
5192 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5194 let counterparty_pubkeys = ChannelPublicKeys {
5195 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5196 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5197 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5198 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5199 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5201 chan.channel_transaction_parameters.counterparty_parameters = Some(
5202 CounterpartyChannelTransactionParameters {
5203 pubkeys: counterparty_pubkeys.clone(),
5204 selected_contest_delay: 144
5206 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5207 signer.ready_channel(&chan.channel_transaction_parameters);
5209 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5210 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5212 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5213 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5215 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5216 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5218 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5219 // derived from a commitment_seed, so instead we copy it here and call
5220 // build_commitment_transaction.
5221 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5222 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5223 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5224 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5225 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5227 macro_rules! test_commitment {
5228 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5229 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5231 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5232 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5234 let htlcs = res.2.drain(..)
5235 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5239 let trusted_tx = commitment_tx.trust();
5240 let unsigned_tx = trusted_tx.built_transaction();
5241 let redeemscript = chan.get_funding_redeemscript();
5242 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5243 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5244 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5246 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5247 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5248 let mut counterparty_htlc_sigs = Vec::new();
5249 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5251 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5252 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5253 counterparty_htlc_sigs.push(remote_signature);
5255 assert_eq!(htlcs.len(), per_htlc.len());
5257 let holder_commitment_tx = HolderCommitmentTransaction::new(
5258 commitment_tx.clone(),
5259 counterparty_signature,
5260 counterparty_htlc_sigs,
5261 &chan.holder_signer.pubkeys().funding_pubkey,
5262 chan.counterparty_funding_pubkey()
5264 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5265 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5267 let funding_redeemscript = chan.get_funding_redeemscript();
5268 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5269 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5271 // ((htlc, counterparty_sig), (index, holder_sig))
5272 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5275 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5277 let ref htlc = htlcs[$htlc_idx];
5278 let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.txid, &htlc, true, &keys, chan.feerate_per_kw);
5279 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5280 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5281 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5283 let mut preimage: Option<PaymentPreimage> = None;
5286 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5287 if out == htlc.payment_hash {
5288 preimage = Some(PaymentPreimage([i; 32]));
5292 assert!(preimage.is_some());
5295 let htlc_sig = htlc_sig_iter.next().unwrap();
5296 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5298 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5299 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5300 let index = (htlc_sig.1).0;
5301 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5302 let trusted_tx = holder_commitment_tx.trust();
5303 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5304 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5306 assert!(htlc_sig_iter.next().is_none());
5310 // simple commitment tx with no HTLCs
5311 chan.value_to_self_msat = 7000000000;
5313 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5314 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5315 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5317 chan.pending_inbound_htlcs.push({
5318 let mut out = InboundHTLCOutput{
5320 amount_msat: 1000000,
5322 payment_hash: PaymentHash([0; 32]),
5323 state: InboundHTLCState::Committed,
5325 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5328 chan.pending_inbound_htlcs.push({
5329 let mut out = InboundHTLCOutput{
5331 amount_msat: 2000000,
5333 payment_hash: PaymentHash([0; 32]),
5334 state: InboundHTLCState::Committed,
5336 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5339 chan.pending_outbound_htlcs.push({
5340 let mut out = OutboundHTLCOutput{
5342 amount_msat: 2000000,
5344 payment_hash: PaymentHash([0; 32]),
5345 state: OutboundHTLCState::Committed,
5346 source: HTLCSource::dummy(),
5348 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5351 chan.pending_outbound_htlcs.push({
5352 let mut out = OutboundHTLCOutput{
5354 amount_msat: 3000000,
5356 payment_hash: PaymentHash([0; 32]),
5357 state: OutboundHTLCState::Committed,
5358 source: HTLCSource::dummy(),
5360 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5363 chan.pending_inbound_htlcs.push({
5364 let mut out = InboundHTLCOutput{
5366 amount_msat: 4000000,
5368 payment_hash: PaymentHash([0; 32]),
5369 state: InboundHTLCState::Committed,
5371 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5375 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5376 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5377 chan.feerate_per_kw = 0;
5379 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5380 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5381 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5384 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5385 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5386 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5389 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5390 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5391 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5394 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5395 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5396 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5399 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5400 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5401 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5404 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5405 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5406 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5409 // commitment tx with seven outputs untrimmed (maximum feerate)
5410 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5411 chan.feerate_per_kw = 647;
5413 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5414 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5415 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5418 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5419 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5420 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5423 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5424 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5425 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5428 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5429 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5430 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5433 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5434 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5435 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5438 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5439 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5440 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5443 // commitment tx with six outputs untrimmed (minimum feerate)
5444 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5445 chan.feerate_per_kw = 648;
5447 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5448 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5449 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5452 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5453 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5454 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5457 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5458 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5459 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5462 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5463 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5464 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5467 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5468 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5469 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5472 // commitment tx with six outputs untrimmed (maximum feerate)
5473 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5474 chan.feerate_per_kw = 2069;
5476 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5477 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5478 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5481 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5482 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5483 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5486 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5487 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5488 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5491 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5492 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5493 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5496 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5497 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5498 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5501 // commitment tx with five outputs untrimmed (minimum feerate)
5502 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5503 chan.feerate_per_kw = 2070;
5505 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5506 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5507 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5510 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5511 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5512 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5515 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5516 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5517 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5520 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5521 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5522 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5525 // commitment tx with five outputs untrimmed (maximum feerate)
5526 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5527 chan.feerate_per_kw = 2194;
5529 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5530 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5531 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5534 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5535 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5536 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5539 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5540 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5541 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5544 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5545 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5546 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5549 // commitment tx with four outputs untrimmed (minimum feerate)
5550 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5551 chan.feerate_per_kw = 2195;
5553 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5554 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5555 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5558 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5559 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5560 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5563 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5564 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5565 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5568 // commitment tx with four outputs untrimmed (maximum feerate)
5569 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5570 chan.feerate_per_kw = 3702;
5572 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5573 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5574 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5577 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5578 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5579 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5582 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5583 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5584 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5587 // commitment tx with three outputs untrimmed (minimum feerate)
5588 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5589 chan.feerate_per_kw = 3703;
5591 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5592 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5593 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5596 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5597 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5598 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5601 // commitment tx with three outputs untrimmed (maximum feerate)
5602 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5603 chan.feerate_per_kw = 4914;
5605 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5606 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5607 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5610 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5611 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5612 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5615 // commitment tx with two outputs untrimmed (minimum feerate)
5616 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5617 chan.feerate_per_kw = 4915;
5619 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5620 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5621 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5623 // commitment tx with two outputs untrimmed (maximum feerate)
5624 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5625 chan.feerate_per_kw = 9651180;
5627 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5628 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5629 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5631 // commitment tx with one output untrimmed (minimum feerate)
5632 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5633 chan.feerate_per_kw = 9651181;
5635 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5636 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5637 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5639 // commitment tx with fee greater than funder amount
5640 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5641 chan.feerate_per_kw = 9651936;
5643 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5644 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5645 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5647 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5648 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5649 chan.feerate_per_kw = 253;
5650 chan.pending_inbound_htlcs.clear();
5651 chan.pending_inbound_htlcs.push({
5652 let mut out = InboundHTLCOutput{
5654 amount_msat: 2000000,
5656 payment_hash: PaymentHash([0; 32]),
5657 state: InboundHTLCState::Committed,
5659 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5662 chan.pending_outbound_htlcs.clear();
5663 chan.pending_outbound_htlcs.push({
5664 let mut out = OutboundHTLCOutput{
5666 amount_msat: 5000000,
5668 payment_hash: PaymentHash([0; 32]),
5669 state: OutboundHTLCState::Committed,
5670 source: HTLCSource::dummy(),
5672 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5675 chan.pending_outbound_htlcs.push({
5676 let mut out = OutboundHTLCOutput{
5678 amount_msat: 5000000,
5680 payment_hash: PaymentHash([0; 32]),
5681 state: OutboundHTLCState::Committed,
5682 source: HTLCSource::dummy(),
5684 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5688 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
5689 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
5690 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5693 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
5694 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
5695 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5697 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
5698 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
5699 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
5701 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
5702 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
5703 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
5708 fn test_per_commitment_secret_gen() {
5709 // Test vectors from BOLT 3 Appendix D:
5711 let mut seed = [0; 32];
5712 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5713 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5714 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5716 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5717 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5718 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5720 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5721 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5723 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5724 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5726 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5727 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5728 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5732 fn test_key_derivation() {
5733 // Test vectors from BOLT 3 Appendix E:
5734 let secp_ctx = Secp256k1::new();
5736 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5737 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5739 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5740 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5742 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5743 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5745 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5746 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5748 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5749 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
5751 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5752 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
5754 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
5755 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());