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::util::bip143;
13 use bitcoin::consensus::encode;
15 use bitcoin::hashes::Hash;
16 use bitcoin::hashes::sha256::Hash as Sha256;
17 use bitcoin::hashes::sha256d::Hash as Sha256d;
18 use bitcoin::hash_types::{Txid, BlockHash};
20 use bitcoin::secp256k1::constants::PUBLIC_KEY_SIZE;
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
25 use ln::{PaymentPreimage, PaymentHash};
26 use ln::features::{ChannelFeatures, InitFeatures};
28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
29 use ln::script::ShutdownScript;
30 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
31 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};
34 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
35 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
36 use chain::transaction::{OutPoint, TransactionData};
37 use chain::keysinterface::{Sign, KeysInterface};
38 use util::transaction_utils;
39 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
40 use util::logger::Logger;
41 use util::errors::APIError;
42 use util::config::{UserConfig,ChannelConfig};
43 use util::scid_utils::scid_from_parts;
47 use core::{cmp,mem,fmt};
48 use core::convert::TryFrom;
50 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
52 use bitcoin::hashes::hex::ToHex;
55 pub struct ChannelValueStat {
56 pub value_to_self_msat: u64,
57 pub channel_value_msat: u64,
58 pub channel_reserve_msat: u64,
59 pub pending_outbound_htlcs_amount_msat: u64,
60 pub pending_inbound_htlcs_amount_msat: u64,
61 pub holding_cell_outbound_amount_msat: u64,
62 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
63 pub counterparty_dust_limit_msat: u64,
66 enum InboundHTLCRemovalReason {
67 FailRelay(msgs::OnionErrorPacket),
68 FailMalformed(([u8; 32], u16)),
69 Fulfill(PaymentPreimage),
72 enum InboundHTLCState {
73 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
74 /// update_add_htlc message for this HTLC.
75 RemoteAnnounced(PendingHTLCStatus),
76 /// Included in a received commitment_signed message (implying we've
77 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
78 /// state (see the example below). We have not yet included this HTLC in a
79 /// commitment_signed message because we are waiting on the remote's
80 /// aforementioned state revocation. One reason this missing remote RAA
81 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
82 /// is because every time we create a new "state", i.e. every time we sign a
83 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
84 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
85 /// sent provided the per_commitment_point for our current commitment tx.
86 /// The other reason we should not send a commitment_signed without their RAA
87 /// is because their RAA serves to ACK our previous commitment_signed.
89 /// Here's an example of how an HTLC could come to be in this state:
90 /// remote --> update_add_htlc(prev_htlc) --> local
91 /// remote --> commitment_signed(prev_htlc) --> local
92 /// remote <-- revoke_and_ack <-- local
93 /// remote <-- commitment_signed(prev_htlc) <-- local
94 /// [note that here, the remote does not respond with a RAA]
95 /// remote --> update_add_htlc(this_htlc) --> local
96 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
97 /// Now `this_htlc` will be assigned this state. It's unable to be officially
98 /// accepted, i.e. included in a commitment_signed, because we're missing the
99 /// RAA that provides our next per_commitment_point. The per_commitment_point
100 /// is used to derive commitment keys, which are used to construct the
101 /// signatures in a commitment_signed message.
102 /// Implies AwaitingRemoteRevoke.
104 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
105 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
106 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
107 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
108 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
109 /// channel (before it can then get forwarded and/or removed).
110 /// Implies AwaitingRemoteRevoke.
111 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
113 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
114 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
116 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
117 /// commitment transaction without it as otherwise we'll have to force-close the channel to
118 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
119 /// anyway). That said, ChannelMonitor does this for us (see
120 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
121 /// our own local state before then, once we're sure that the next commitment_signed and
122 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
123 LocalRemoved(InboundHTLCRemovalReason),
126 struct InboundHTLCOutput {
130 payment_hash: PaymentHash,
131 state: InboundHTLCState,
134 enum OutboundHTLCState {
135 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
136 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
137 /// we will promote to Committed (note that they may not accept it until the next time we
138 /// revoke, but we don't really care about that:
139 /// * they've revoked, so worst case we can announce an old state and get our (option on)
140 /// money back (though we won't), and,
141 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
142 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
143 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
144 /// we'll never get out of sync).
145 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
146 /// OutboundHTLCOutput's size just for a temporary bit
147 LocalAnnounced(Box<msgs::OnionPacket>),
149 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
150 /// the change (though they'll need to revoke before we fail the payment).
151 RemoteRemoved(Option<HTLCFailReason>),
152 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
153 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
154 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
155 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
156 /// remote revoke_and_ack on a previous state before we can do so.
157 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
158 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
159 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
160 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
161 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
162 /// revoke_and_ack to drop completely.
163 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
166 struct OutboundHTLCOutput {
170 payment_hash: PaymentHash,
171 state: OutboundHTLCState,
175 /// See AwaitingRemoteRevoke ChannelState for more info
176 enum HTLCUpdateAwaitingACK {
177 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
181 payment_hash: PaymentHash,
183 onion_routing_packet: msgs::OnionPacket,
186 payment_preimage: PaymentPreimage,
191 err_packet: msgs::OnionErrorPacket,
195 /// There are a few "states" and then a number of flags which can be applied:
196 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
197 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
198 /// move on to ChannelFunded.
199 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
200 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
201 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
203 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
204 OurInitSent = 1 << 0,
205 /// Implies we have received their open_channel/accept_channel message
206 TheirInitSent = 1 << 1,
207 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
208 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
209 /// upon receipt of funding_created, so simply skip this state.
211 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
212 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
213 /// and our counterparty consider the funding transaction confirmed.
215 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
216 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
217 TheirFundingLocked = 1 << 4,
218 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
219 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
220 OurFundingLocked = 1 << 5,
222 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
223 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
225 PeerDisconnected = 1 << 7,
226 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
227 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
228 /// outbound messages until they've managed to do so.
229 MonitorUpdateFailed = 1 << 8,
230 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
231 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
232 /// messages as then we will be unable to determine which HTLCs they included in their
233 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
235 /// Flag is set on ChannelFunded.
236 AwaitingRemoteRevoke = 1 << 9,
237 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
238 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
239 /// to respond with our own shutdown message when possible.
240 RemoteShutdownSent = 1 << 10,
241 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
242 /// point, we may not add any new HTLCs to the channel.
243 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
244 /// us their shutdown.
245 LocalShutdownSent = 1 << 11,
246 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
247 /// to drop us, but we store this anyway.
248 ShutdownComplete = 4096,
250 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
251 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
253 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
255 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
256 /// our counterparty or not. However, we don't want to announce updates right away to avoid
257 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
258 /// our channel_update message and track the current state here.
259 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
260 #[derive(Clone, Copy, PartialEq)]
261 pub(super) enum ChannelUpdateStatus {
262 /// We've announced the channel as enabled and are connected to our peer.
264 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
266 /// Our channel is live again, but we haven't announced the channel as enabled yet.
268 /// We've announced the channel as disabled.
272 /// An enum indicating whether the local or remote side offered a given HTLC.
278 /// Used when calculating whether we or the remote can afford an additional HTLC.
279 struct HTLCCandidate {
281 origin: HTLCInitiator,
285 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
293 /// Information needed for constructing an invoice route hint for this channel.
294 #[derive(Clone, Debug, PartialEq)]
295 pub struct CounterpartyForwardingInfo {
296 /// Base routing fee in millisatoshis.
297 pub fee_base_msat: u32,
298 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
299 pub fee_proportional_millionths: u32,
300 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
301 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
302 /// `cltv_expiry_delta` for more details.
303 pub cltv_expiry_delta: u16,
306 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
308 enum UpdateFulfillFetch {
310 monitor_update: ChannelMonitorUpdate,
311 htlc_value_msat: u64,
312 msg: Option<msgs::UpdateFulfillHTLC>,
317 /// The return type of get_update_fulfill_htlc_and_commit.
318 pub enum UpdateFulfillCommitFetch {
319 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
320 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
321 /// previously placed in the holding cell (and has since been removed).
323 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
324 monitor_update: ChannelMonitorUpdate,
325 /// The value of the HTLC which was claimed, in msat.
326 htlc_value_msat: u64,
327 /// The update_fulfill message and commitment_signed message (if the claim was not placed
328 /// in the holding cell).
329 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
331 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
332 /// or has been forgotten (presumably previously claimed).
336 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
337 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
338 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
341 // Holder designates channel data owned for the benefice of the user client.
342 // Counterparty designates channel data owned by the another channel participant entity.
343 pub(super) struct Channel<Signer: Sign> {
344 #[cfg(any(test, feature = "_test_utils"))]
345 pub(crate) config: ChannelConfig,
346 #[cfg(not(any(test, feature = "_test_utils")))]
347 config: ChannelConfig,
351 channel_id: [u8; 32],
353 secp_ctx: Secp256k1<secp256k1::All>,
354 channel_value_satoshis: u64,
356 latest_monitor_update_id: u64,
358 holder_signer: Signer,
359 shutdown_scriptpubkey: Option<ShutdownScript>,
360 destination_script: Script,
362 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
363 // generation start at 0 and count up...this simplifies some parts of implementation at the
364 // cost of others, but should really just be changed.
366 cur_holder_commitment_transaction_number: u64,
367 cur_counterparty_commitment_transaction_number: u64,
368 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
369 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
370 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
371 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
373 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
374 /// need to ensure we resend them in the order we originally generated them. Note that because
375 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
376 /// sufficient to simply set this to the opposite of any message we are generating as we
377 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
378 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
380 resend_order: RAACommitmentOrder,
382 monitor_pending_funding_locked: bool,
383 monitor_pending_revoke_and_ack: bool,
384 monitor_pending_commitment_signed: bool,
385 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
386 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
388 // pending_update_fee is filled when sending and receiving update_fee
389 // For outbound channel, feerate_per_kw is updated with the value from
390 // pending_update_fee when revoke_and_ack is received
392 // For inbound channel, feerate_per_kw is updated when it receives
393 // commitment_signed and revoke_and_ack is generated
394 // The pending value is kept when another pair of update_fee and commitment_signed
395 // is received during AwaitingRemoteRevoke and relieved when the expected
396 // revoke_and_ack is received and new commitment_signed is generated to be
397 // sent to the funder. Otherwise, the pending value is removed when receiving
398 // commitment_signed.
399 pending_update_fee: Option<u32>,
400 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
401 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
402 // is received. holding_cell_update_fee is updated when there are additional
403 // update_fee() during ChannelState::AwaitingRemoteRevoke.
404 holding_cell_update_fee: Option<u32>,
405 next_holder_htlc_id: u64,
406 next_counterparty_htlc_id: u64,
407 update_time_counter: u32,
410 #[cfg(debug_assertions)]
411 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
412 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
413 #[cfg(debug_assertions)]
414 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
415 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
417 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
419 /// The hash of the block in which the funding transaction was included.
420 funding_tx_confirmed_in: Option<BlockHash>,
421 funding_tx_confirmation_height: u32,
422 short_channel_id: Option<u64>,
424 counterparty_dust_limit_satoshis: u64,
426 pub(super) holder_dust_limit_satoshis: u64,
428 holder_dust_limit_satoshis: u64,
430 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
432 counterparty_max_htlc_value_in_flight_msat: u64,
433 //get_holder_max_htlc_value_in_flight_msat(): u64,
434 /// minimum channel reserve for self to maintain - set by them.
435 counterparty_selected_channel_reserve_satoshis: Option<u64>,
436 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
437 counterparty_htlc_minimum_msat: u64,
438 holder_htlc_minimum_msat: u64,
440 pub counterparty_max_accepted_htlcs: u16,
442 counterparty_max_accepted_htlcs: u16,
443 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
444 minimum_depth: Option<u32>,
446 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
448 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
449 funding_transaction: Option<Transaction>,
451 counterparty_cur_commitment_point: Option<PublicKey>,
452 counterparty_prev_commitment_point: Option<PublicKey>,
453 counterparty_node_id: PublicKey,
455 counterparty_shutdown_scriptpubkey: Option<Script>,
457 commitment_secrets: CounterpartyCommitmentSecrets,
459 channel_update_status: ChannelUpdateStatus,
461 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
462 /// This can be used to rebroadcast the channel_announcement message later.
463 announcement_sigs: Option<(Signature, Signature)>,
465 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
466 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
467 // be, by comparing the cached values to the fee of the tranaction generated by
468 // `build_commitment_transaction`.
469 #[cfg(any(test, feature = "fuzztarget"))]
470 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
471 #[cfg(any(test, feature = "fuzztarget"))]
472 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
474 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
475 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
476 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
477 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
478 /// message until we receive a channel_reestablish.
480 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
481 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
483 #[cfg(any(test, feature = "fuzztarget"))]
484 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
485 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
486 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
487 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
488 // is fine, but as a sanity check in our failure to generate the second claim, we check here
489 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
490 historical_inbound_htlc_fulfills: HashSet<u64>,
493 #[cfg(any(test, feature = "fuzztarget"))]
494 struct CommitmentTxInfoCached {
496 total_pending_htlcs: usize,
497 next_holder_htlc_id: u64,
498 next_counterparty_htlc_id: u64,
502 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
505 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
507 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
509 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
511 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
513 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
515 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
517 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
518 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
519 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
520 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
521 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
522 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
523 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
524 /// upper bound to avoid negotiation conflicts with other implementations.
525 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
527 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
528 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
529 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
530 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
531 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
533 /// Used to return a simple Error back to ChannelManager. Will get converted to a
534 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
535 /// channel_id in ChannelManager.
536 pub(super) enum ChannelError {
539 CloseDelayBroadcast(String),
542 impl fmt::Debug for ChannelError {
543 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
545 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
546 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
547 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
552 macro_rules! secp_check {
553 ($res: expr, $err: expr) => {
556 Err(_) => return Err(ChannelError::Close($err)),
561 impl<Signer: Sign> Channel<Signer> {
562 // Convert constants + channel value to limits:
563 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
564 channel_value_satoshis * 1000 / 10 //TODO
567 /// Returns a minimum channel reserve value the remote needs to maintain,
570 /// Guaranteed to return a value no larger than channel_value_satoshis
571 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
572 let (q, _) = channel_value_satoshis.overflowing_div(100);
573 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
577 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>
578 where K::Target: KeysInterface<Signer = Signer>,
579 F::Target: FeeEstimator,
581 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
582 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
583 let pubkeys = holder_signer.pubkeys().clone();
585 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
586 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
588 let channel_value_msat = channel_value_satoshis * 1000;
589 if push_msat > channel_value_msat {
590 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
592 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
593 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
595 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
596 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
597 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
600 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
602 let mut secp_ctx = Secp256k1::new();
603 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
607 config: config.channel_options.clone(),
609 channel_id: keys_provider.get_secure_random_bytes(),
610 channel_state: ChannelState::OurInitSent as u32,
612 channel_value_satoshis,
614 latest_monitor_update_id: 0,
617 shutdown_scriptpubkey: Some(keys_provider.get_shutdown_scriptpubkey()),
618 destination_script: keys_provider.get_destination_script(),
620 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
621 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
622 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
624 pending_inbound_htlcs: Vec::new(),
625 pending_outbound_htlcs: Vec::new(),
626 holding_cell_htlc_updates: Vec::new(),
627 pending_update_fee: None,
628 holding_cell_update_fee: None,
629 next_holder_htlc_id: 0,
630 next_counterparty_htlc_id: 0,
631 update_time_counter: 1,
633 resend_order: RAACommitmentOrder::CommitmentFirst,
635 monitor_pending_funding_locked: false,
636 monitor_pending_revoke_and_ack: false,
637 monitor_pending_commitment_signed: false,
638 monitor_pending_forwards: Vec::new(),
639 monitor_pending_failures: Vec::new(),
641 #[cfg(debug_assertions)]
642 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
643 #[cfg(debug_assertions)]
644 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
646 last_sent_closing_fee: None,
648 funding_tx_confirmed_in: None,
649 funding_tx_confirmation_height: 0,
650 short_channel_id: None,
652 feerate_per_kw: feerate,
653 counterparty_dust_limit_satoshis: 0,
654 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
655 counterparty_max_htlc_value_in_flight_msat: 0,
656 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
657 counterparty_htlc_minimum_msat: 0,
658 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
659 counterparty_max_accepted_htlcs: 0,
660 minimum_depth: None, // Filled in in accept_channel
662 counterparty_forwarding_info: None,
664 channel_transaction_parameters: ChannelTransactionParameters {
665 holder_pubkeys: pubkeys,
666 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
667 is_outbound_from_holder: true,
668 counterparty_parameters: None,
669 funding_outpoint: None
671 funding_transaction: None,
673 counterparty_cur_commitment_point: None,
674 counterparty_prev_commitment_point: None,
675 counterparty_node_id,
677 counterparty_shutdown_scriptpubkey: None,
679 commitment_secrets: CounterpartyCommitmentSecrets::new(),
681 channel_update_status: ChannelUpdateStatus::Enabled,
683 announcement_sigs: None,
685 #[cfg(any(test, feature = "fuzztarget"))]
686 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
687 #[cfg(any(test, feature = "fuzztarget"))]
688 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
690 workaround_lnd_bug_4006: None,
692 #[cfg(any(test, feature = "fuzztarget"))]
693 historical_inbound_htlc_fulfills: HashSet::new(),
697 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
698 where F::Target: FeeEstimator
700 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
701 if feerate_per_kw < lower_limit {
702 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
704 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 2;
705 if feerate_per_kw as u64 > upper_limit {
706 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
711 /// Creates a new channel from a remote sides' request for one.
712 /// Assumes chain_hash has already been checked and corresponds with what we expect!
713 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>
714 where K::Target: KeysInterface<Signer = Signer>,
715 F::Target: FeeEstimator
717 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
718 let pubkeys = holder_signer.pubkeys().clone();
719 let counterparty_pubkeys = ChannelPublicKeys {
720 funding_pubkey: msg.funding_pubkey,
721 revocation_basepoint: msg.revocation_basepoint,
722 payment_point: msg.payment_point,
723 delayed_payment_basepoint: msg.delayed_payment_basepoint,
724 htlc_basepoint: msg.htlc_basepoint
726 let mut local_config = (*config).channel_options.clone();
728 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
729 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)));
732 // Check sanity of message fields:
733 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
734 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
736 if msg.channel_reserve_satoshis > msg.funding_satoshis {
737 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
739 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
740 if msg.push_msat > funding_value {
741 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
743 if msg.dust_limit_satoshis > msg.funding_satoshis {
744 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)));
746 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
747 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
749 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
750 if msg.htlc_minimum_msat >= full_channel_value_msat {
751 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
753 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
755 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
756 if msg.to_self_delay > max_counterparty_selected_contest_delay {
757 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)));
759 if msg.max_accepted_htlcs < 1 {
760 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
762 if msg.max_accepted_htlcs > MAX_HTLCS {
763 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
766 // Now check against optional parameters as set by config...
767 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
768 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)));
770 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
771 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)));
773 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
774 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)));
776 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
777 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)));
779 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
780 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)));
782 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
783 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
785 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
786 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
789 // Convert things into internal flags and prep our state:
791 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
792 if config.peer_channel_config_limits.force_announced_channel_preference {
793 if local_config.announced_channel != announce {
794 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
797 // we either accept their preference or the preferences match
798 local_config.announced_channel = announce;
800 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
802 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
803 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
804 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)));
806 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
807 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
809 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
810 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)));
813 // check if the funder's amount for the initial commitment tx is sufficient
814 // for full fee payment
815 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
816 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
817 if funders_amount_msat < lower_limit {
818 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
821 let to_local_msat = msg.push_msat;
822 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
823 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
824 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
827 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
828 match &msg.shutdown_scriptpubkey {
829 &OptionalField::Present(ref script) => {
830 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
831 if script.len() == 0 {
834 match ShutdownScript::try_from((script.clone(), &their_features)) {
835 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
836 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format. script: ({})", script.to_bytes().to_hex()))),
840 // 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
841 &OptionalField::Absent => {
842 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()));
847 let mut secp_ctx = Secp256k1::new();
848 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
852 config: local_config,
854 channel_id: msg.temporary_channel_id,
855 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
858 latest_monitor_update_id: 0,
861 shutdown_scriptpubkey: Some(keys_provider.get_shutdown_scriptpubkey()),
862 destination_script: keys_provider.get_destination_script(),
864 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
865 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
866 value_to_self_msat: msg.push_msat,
868 pending_inbound_htlcs: Vec::new(),
869 pending_outbound_htlcs: Vec::new(),
870 holding_cell_htlc_updates: Vec::new(),
871 pending_update_fee: None,
872 holding_cell_update_fee: None,
873 next_holder_htlc_id: 0,
874 next_counterparty_htlc_id: 0,
875 update_time_counter: 1,
877 resend_order: RAACommitmentOrder::CommitmentFirst,
879 monitor_pending_funding_locked: false,
880 monitor_pending_revoke_and_ack: false,
881 monitor_pending_commitment_signed: false,
882 monitor_pending_forwards: Vec::new(),
883 monitor_pending_failures: Vec::new(),
885 #[cfg(debug_assertions)]
886 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
887 #[cfg(debug_assertions)]
888 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
890 last_sent_closing_fee: None,
892 funding_tx_confirmed_in: None,
893 funding_tx_confirmation_height: 0,
894 short_channel_id: None,
896 feerate_per_kw: msg.feerate_per_kw,
897 channel_value_satoshis: msg.funding_satoshis,
898 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
899 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
900 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
901 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
902 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
903 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
904 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
905 minimum_depth: Some(config.own_channel_config.minimum_depth),
907 counterparty_forwarding_info: None,
909 channel_transaction_parameters: ChannelTransactionParameters {
910 holder_pubkeys: pubkeys,
911 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
912 is_outbound_from_holder: false,
913 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
914 selected_contest_delay: msg.to_self_delay,
915 pubkeys: counterparty_pubkeys,
917 funding_outpoint: None
919 funding_transaction: None,
921 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
922 counterparty_prev_commitment_point: None,
923 counterparty_node_id,
925 counterparty_shutdown_scriptpubkey,
927 commitment_secrets: CounterpartyCommitmentSecrets::new(),
929 channel_update_status: ChannelUpdateStatus::Enabled,
931 announcement_sigs: None,
933 #[cfg(any(test, feature = "fuzztarget"))]
934 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
935 #[cfg(any(test, feature = "fuzztarget"))]
936 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
938 workaround_lnd_bug_4006: None,
940 #[cfg(any(test, feature = "fuzztarget"))]
941 historical_inbound_htlc_fulfills: HashSet::new(),
947 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
948 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
949 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
950 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
951 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
953 /// @local is used only to convert relevant internal structures which refer to remote vs local
954 /// to decide value of outputs and direction of HTLCs.
955 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
956 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
957 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
958 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
959 /// which peer generated this transaction and "to whom" this transaction flows.
960 /// Returns (the transaction info, the number of HTLC outputs which were present in the
961 /// transaction, the list of HTLCs which were not ignored when building the transaction).
962 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
963 /// sources are provided only for outbound HTLCs in the third return value.
965 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 {
966 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
967 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
968 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
970 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
971 let mut remote_htlc_total_msat = 0;
972 let mut local_htlc_total_msat = 0;
973 let mut value_to_self_msat_offset = 0;
975 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
976 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
977 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
978 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
980 macro_rules! get_htlc_in_commitment {
981 ($htlc: expr, $offered: expr) => {
982 HTLCOutputInCommitment {
984 amount_msat: $htlc.amount_msat,
985 cltv_expiry: $htlc.cltv_expiry,
986 payment_hash: $htlc.payment_hash,
987 transaction_output_index: None
992 macro_rules! add_htlc_output {
993 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
994 if $outbound == local { // "offered HTLC output"
995 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
996 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
997 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);
998 included_non_dust_htlcs.push((htlc_in_tx, $source));
1000 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);
1001 included_dust_htlcs.push((htlc_in_tx, $source));
1004 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1005 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1006 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);
1007 included_non_dust_htlcs.push((htlc_in_tx, $source));
1009 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);
1010 included_dust_htlcs.push((htlc_in_tx, $source));
1016 for ref htlc in self.pending_inbound_htlcs.iter() {
1017 let (include, state_name) = match htlc.state {
1018 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1019 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1020 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1021 InboundHTLCState::Committed => (true, "Committed"),
1022 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1026 add_htlc_output!(htlc, false, None, state_name);
1027 remote_htlc_total_msat += htlc.amount_msat;
1029 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);
1031 &InboundHTLCState::LocalRemoved(ref reason) => {
1032 if generated_by_local {
1033 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1034 value_to_self_msat_offset += htlc.amount_msat as i64;
1043 for ref htlc in self.pending_outbound_htlcs.iter() {
1044 let (include, state_name) = match htlc.state {
1045 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1046 OutboundHTLCState::Committed => (true, "Committed"),
1047 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1048 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1049 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1053 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1054 local_htlc_total_msat += htlc.amount_msat;
1056 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);
1058 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1059 value_to_self_msat_offset -= htlc.amount_msat as i64;
1061 OutboundHTLCState::RemoteRemoved(None) => {
1062 if !generated_by_local {
1063 value_to_self_msat_offset -= htlc.amount_msat as i64;
1071 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1072 assert!(value_to_self_msat >= 0);
1073 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1074 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1075 // "violate" their reserve value by couting those against it. Thus, we have to convert
1076 // everything to i64 before subtracting as otherwise we can overflow.
1077 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;
1078 assert!(value_to_remote_msat >= 0);
1080 #[cfg(debug_assertions)]
1082 // Make sure that the to_self/to_remote is always either past the appropriate
1083 // channel_reserve *or* it is making progress towards it.
1084 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1085 self.holder_max_commitment_tx_output.lock().unwrap()
1087 self.counterparty_max_commitment_tx_output.lock().unwrap()
1089 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.unwrap() as i64);
1090 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1091 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);
1092 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1095 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;
1096 let (value_to_self, value_to_remote) = if self.is_outbound() {
1097 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1099 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1102 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1103 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1105 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1106 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1111 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1112 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1117 let num_nondust_htlcs = included_non_dust_htlcs.len();
1119 let channel_parameters =
1120 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1121 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1122 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1127 &mut included_non_dust_htlcs,
1130 let mut htlcs_included = included_non_dust_htlcs;
1131 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1132 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1133 htlcs_included.append(&mut included_dust_htlcs);
1135 (tx, num_nondust_htlcs, htlcs_included)
1139 fn get_closing_scriptpubkey(&self) -> Script {
1140 // The shutdown scriptpubkey is set on channel opening when option_upfront_shutdown_script
1141 // is signaled. Otherwise, it is set when sending a shutdown message. Calling this method
1142 // outside of those situations will fail.
1143 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1147 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1152 1 + // script length (0)
1156 )*4 + // * 4 for non-witness parts
1157 2 + // witness marker and flag
1158 1 + // witness element count
1159 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1160 self.get_funding_redeemscript().len() as u64 + // funding witness script
1161 2*(1 + 71); // two signatures + sighash type flags
1162 if let Some(spk) = a_scriptpubkey {
1163 ret += ((8+1) + // output values and script length
1164 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1166 if let Some(spk) = b_scriptpubkey {
1167 ret += ((8+1) + // output values and script length
1168 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1174 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1176 let mut ins: Vec<TxIn> = Vec::new();
1178 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1179 script_sig: Script::new(),
1180 sequence: 0xffffffff,
1181 witness: Vec::new(),
1186 assert!(self.pending_inbound_htlcs.is_empty());
1187 assert!(self.pending_outbound_htlcs.is_empty());
1188 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1190 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1191 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1192 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 };
1194 if value_to_self < 0 {
1195 assert!(self.is_outbound());
1196 total_fee_satoshis += (-value_to_self) as u64;
1197 } else if value_to_remote < 0 {
1198 assert!(!self.is_outbound());
1199 total_fee_satoshis += (-value_to_remote) as u64;
1202 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1203 txouts.push((TxOut {
1204 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1205 value: value_to_remote as u64
1209 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1210 txouts.push((TxOut {
1211 script_pubkey: self.get_closing_scriptpubkey(),
1212 value: value_to_self as u64
1216 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1218 let mut outputs: Vec<TxOut> = Vec::new();
1219 for out in txouts.drain(..) {
1220 outputs.push(out.0);
1228 }, total_fee_satoshis)
1231 fn funding_outpoint(&self) -> OutPoint {
1232 self.channel_transaction_parameters.funding_outpoint.unwrap()
1236 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1237 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1238 /// our counterparty!)
1239 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1240 /// TODO Some magic rust shit to compile-time check this?
1241 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1242 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1243 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1244 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1245 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1247 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()))
1251 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1252 /// will sign and send to our counterparty.
1253 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1254 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1255 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1256 //may see payments to it!
1257 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1258 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1259 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1261 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()))
1264 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1265 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1266 /// Panics if called before accept_channel/new_from_req
1267 pub fn get_funding_redeemscript(&self) -> Script {
1268 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1271 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1272 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1273 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1274 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1276 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1277 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1279 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1281 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1283 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1284 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1285 // these, but for now we just have to treat them as normal.
1287 let mut pending_idx = core::usize::MAX;
1288 let mut htlc_value_msat = 0;
1289 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1290 if htlc.htlc_id == htlc_id_arg {
1291 assert_eq!(htlc.payment_hash, payment_hash_calc);
1293 InboundHTLCState::Committed => {},
1294 InboundHTLCState::LocalRemoved(ref reason) => {
1295 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1297 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()));
1298 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1300 return UpdateFulfillFetch::DuplicateClaim {};
1303 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1304 // Don't return in release mode here so that we can update channel_monitor
1308 htlc_value_msat = htlc.amount_msat;
1312 if pending_idx == core::usize::MAX {
1313 #[cfg(any(test, feature = "fuzztarget"))]
1314 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1315 // this is simply a duplicate claim, not previously failed and we lost funds.
1316 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1317 return UpdateFulfillFetch::DuplicateClaim {};
1320 // Now update local state:
1322 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1323 // can claim it even if the channel hits the chain before we see their next commitment.
1324 self.latest_monitor_update_id += 1;
1325 let monitor_update = ChannelMonitorUpdate {
1326 update_id: self.latest_monitor_update_id,
1327 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1328 payment_preimage: payment_preimage_arg.clone(),
1332 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1333 for pending_update in self.holding_cell_htlc_updates.iter() {
1334 match pending_update {
1335 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1336 if htlc_id_arg == htlc_id {
1337 // Make sure we don't leave latest_monitor_update_id incremented here:
1338 self.latest_monitor_update_id -= 1;
1339 #[cfg(any(test, feature = "fuzztarget"))]
1340 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1341 return UpdateFulfillFetch::DuplicateClaim {};
1344 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1345 if htlc_id_arg == htlc_id {
1346 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1347 // TODO: We may actually be able to switch to a fulfill here, though its
1348 // rare enough it may not be worth the complexity burden.
1349 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1350 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1356 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1357 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1358 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1360 #[cfg(any(test, feature = "fuzztarget"))]
1361 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1362 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1364 #[cfg(any(test, feature = "fuzztarget"))]
1365 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1368 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1369 if let InboundHTLCState::Committed = htlc.state {
1371 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1372 return UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None };
1374 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1375 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1378 UpdateFulfillFetch::NewClaim {
1381 msg: Some(msgs::UpdateFulfillHTLC {
1382 channel_id: self.channel_id(),
1383 htlc_id: htlc_id_arg,
1384 payment_preimage: payment_preimage_arg,
1389 pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<UpdateFulfillCommitFetch, (ChannelError, ChannelMonitorUpdate)> where L::Target: Logger {
1390 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1391 UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg: Some(update_fulfill_htlc) } => {
1392 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1393 Err(e) => return Err((e, monitor_update)),
1396 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1397 // strictly increasing by one, so decrement it here.
1398 self.latest_monitor_update_id = monitor_update.update_id;
1399 monitor_update.updates.append(&mut additional_update.updates);
1400 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: Some((update_fulfill_htlc, commitment)) })
1402 UpdateFulfillFetch::NewClaim { monitor_update, htlc_value_msat, msg: None } =>
1403 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, htlc_value_msat, msgs: None }),
1404 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1408 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1409 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1410 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1411 /// before we fail backwards.
1412 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1413 /// Ok(_) if debug assertions are turned on or preconditions are met.
1414 pub fn get_update_fail_htlc<L: Deref>(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket, logger: &L) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> where L::Target: Logger {
1415 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1416 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1418 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1420 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1421 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1422 // these, but for now we just have to treat them as normal.
1424 let mut pending_idx = core::usize::MAX;
1425 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1426 if htlc.htlc_id == htlc_id_arg {
1428 InboundHTLCState::Committed => {},
1429 InboundHTLCState::LocalRemoved(ref reason) => {
1430 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1432 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1437 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1438 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1444 if pending_idx == core::usize::MAX {
1445 #[cfg(any(test, feature = "fuzztarget"))]
1446 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1447 // is simply a duplicate fail, not previously failed and we failed-back too early.
1448 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1452 // Now update local state:
1453 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1454 for pending_update in self.holding_cell_htlc_updates.iter() {
1455 match pending_update {
1456 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1457 if htlc_id_arg == htlc_id {
1458 #[cfg(any(test, feature = "fuzztarget"))]
1459 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1463 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1464 if htlc_id_arg == htlc_id {
1465 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1466 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1472 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1473 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1474 htlc_id: htlc_id_arg,
1480 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1482 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1483 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1486 Ok(Some(msgs::UpdateFailHTLC {
1487 channel_id: self.channel_id(),
1488 htlc_id: htlc_id_arg,
1493 // Message handlers:
1495 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1496 // Check sanity of message fields:
1497 if !self.is_outbound() {
1498 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1500 if self.channel_state != ChannelState::OurInitSent as u32 {
1501 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1503 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1504 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1506 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1507 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1509 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1510 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)));
1512 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1513 if msg.dust_limit_satoshis > remote_reserve {
1514 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1516 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1517 if msg.htlc_minimum_msat >= full_channel_value_msat {
1518 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1520 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1521 if msg.to_self_delay > max_delay_acceptable {
1522 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)));
1524 if msg.max_accepted_htlcs < 1 {
1525 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1527 if msg.max_accepted_htlcs > MAX_HTLCS {
1528 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1531 // Now check against optional parameters as set by config...
1532 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1533 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)));
1535 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1536 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)));
1538 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1539 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)));
1541 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1542 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)));
1544 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1545 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1547 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1548 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1550 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1551 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)));
1553 if msg.minimum_depth == 0 {
1554 // Note that if this changes we should update the serialization minimum version to
1555 // indicate to older clients that they don't understand some features of the current
1557 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1560 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1561 match &msg.shutdown_scriptpubkey {
1562 &OptionalField::Present(ref script) => {
1563 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1564 if script.len() == 0 {
1567 match ShutdownScript::try_from((script.clone(), &their_features)) {
1568 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
1569 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided an unacceptable scriptpubkey format. script: ({})", script.to_bytes().to_hex()))),
1573 // 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
1574 &OptionalField::Absent => {
1575 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()));
1580 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1581 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1582 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1583 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1584 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1585 self.minimum_depth = Some(msg.minimum_depth);
1587 let counterparty_pubkeys = ChannelPublicKeys {
1588 funding_pubkey: msg.funding_pubkey,
1589 revocation_basepoint: msg.revocation_basepoint,
1590 payment_point: msg.payment_point,
1591 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1592 htlc_basepoint: msg.htlc_basepoint
1595 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1596 selected_contest_delay: msg.to_self_delay,
1597 pubkeys: counterparty_pubkeys,
1600 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1601 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1603 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1608 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1609 let funding_script = self.get_funding_redeemscript();
1611 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1612 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1614 let trusted_tx = initial_commitment_tx.trust();
1615 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1616 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1617 // They sign the holder commitment transaction...
1618 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1619 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1620 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1621 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1622 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1625 let counterparty_keys = self.build_remote_transaction_keys()?;
1626 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;
1628 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1629 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1630 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1631 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1633 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1634 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1636 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1637 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1640 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1641 &self.get_counterparty_pubkeys().funding_pubkey
1644 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 {
1645 if self.is_outbound() {
1646 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1648 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1649 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1650 // remember the channel, so it's safe to just send an error_message here and drop the
1652 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1654 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1655 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1656 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1657 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1660 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1661 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1662 // This is an externally observable change before we finish all our checks. In particular
1663 // funding_created_signature may fail.
1664 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1666 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1668 Err(ChannelError::Close(e)) => {
1669 self.channel_transaction_parameters.funding_outpoint = None;
1670 return Err(ChannelError::Close(e));
1673 // The only error we know how to handle is ChannelError::Close, so we fall over here
1674 // to make sure we don't continue with an inconsistent state.
1675 panic!("unexpected error type from funding_created_signature {:?}", e);
1679 let holder_commitment_tx = HolderCommitmentTransaction::new(
1680 initial_commitment_tx,
1683 &self.get_holder_pubkeys().funding_pubkey,
1684 self.counterparty_funding_pubkey()
1687 // Now that we're past error-generating stuff, update our local state:
1689 let funding_redeemscript = self.get_funding_redeemscript();
1690 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1691 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1692 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1693 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1694 shutdown_script, self.get_holder_selected_contest_delay(),
1695 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1696 &self.channel_transaction_parameters,
1697 funding_redeemscript.clone(), self.channel_value_satoshis,
1699 holder_commitment_tx, best_block);
1701 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);
1703 self.channel_state = ChannelState::FundingSent as u32;
1704 self.channel_id = funding_txo.to_channel_id();
1705 self.cur_counterparty_commitment_transaction_number -= 1;
1706 self.cur_holder_commitment_transaction_number -= 1;
1708 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1710 Ok((msgs::FundingSigned {
1711 channel_id: self.channel_id,
1713 }, channel_monitor))
1716 /// Handles a funding_signed message from the remote end.
1717 /// If this call is successful, broadcast the funding transaction (and not before!)
1718 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 {
1719 if !self.is_outbound() {
1720 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1722 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1723 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1725 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1726 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1727 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1728 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1731 let funding_script = self.get_funding_redeemscript();
1733 let counterparty_keys = self.build_remote_transaction_keys()?;
1734 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;
1735 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1736 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1738 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1739 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1741 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1742 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1744 let trusted_tx = initial_commitment_tx.trust();
1745 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1746 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1747 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1748 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1749 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1753 let holder_commitment_tx = HolderCommitmentTransaction::new(
1754 initial_commitment_tx,
1757 &self.get_holder_pubkeys().funding_pubkey,
1758 self.counterparty_funding_pubkey()
1762 let funding_redeemscript = self.get_funding_redeemscript();
1763 let funding_txo = self.get_funding_txo().unwrap();
1764 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1765 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1766 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1767 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1768 shutdown_script, self.get_holder_selected_contest_delay(),
1769 &self.destination_script, (funding_txo, funding_txo_script),
1770 &self.channel_transaction_parameters,
1771 funding_redeemscript.clone(), self.channel_value_satoshis,
1773 holder_commitment_tx, best_block);
1775 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);
1777 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1778 self.channel_state = ChannelState::FundingSent as u32;
1779 self.cur_holder_commitment_transaction_number -= 1;
1780 self.cur_counterparty_commitment_transaction_number -= 1;
1782 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1784 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1787 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1788 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1789 self.workaround_lnd_bug_4006 = Some(msg.clone());
1790 return Err(ChannelError::Ignore("Peer sent funding_locked when we needed a channel_reestablish. The peer is likely lnd, see https://github.com/lightningnetwork/lnd/issues/4006".to_owned()));
1793 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1795 if non_shutdown_state == ChannelState::FundingSent as u32 {
1796 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1797 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1798 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1799 self.update_time_counter += 1;
1800 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1801 // Note that funding_signed/funding_created will have decremented both by 1!
1802 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1803 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1804 // If we reconnected before sending our funding locked they may still resend theirs:
1805 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1806 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1807 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1808 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1810 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1813 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1816 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1817 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1819 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1824 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1825 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1826 let mut htlc_inbound_value_msat = 0;
1827 for ref htlc in self.pending_inbound_htlcs.iter() {
1828 htlc_inbound_value_msat += htlc.amount_msat;
1830 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1833 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1835 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1836 let mut htlc_outbound_value_msat = 0;
1837 for ref htlc in self.pending_outbound_htlcs.iter() {
1838 htlc_outbound_value_msat += htlc.amount_msat;
1841 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1842 for update in self.holding_cell_htlc_updates.iter() {
1843 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1844 htlc_outbound_count += 1;
1845 htlc_outbound_value_msat += amount_msat;
1849 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1852 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1853 /// Doesn't bother handling the
1854 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1855 /// corner case properly.
1856 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1857 // Note that we have to handle overflow due to the above case.
1859 cmp::max(self.channel_value_satoshis as i64 * 1000
1860 - self.value_to_self_msat as i64
1861 - self.get_inbound_pending_htlc_stats().1 as i64
1862 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1864 cmp::max(self.value_to_self_msat as i64
1865 - self.get_outbound_pending_htlc_stats().1 as i64
1866 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1871 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1872 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1873 self.counterparty_selected_channel_reserve_satoshis)
1876 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1877 // Note that num_htlcs should not include dust HTLCs.
1878 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1879 // Note that we need to divide before multiplying to round properly,
1880 // since the lowest denomination of bitcoin on-chain is the satoshi.
1881 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1884 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1885 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1886 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1888 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1889 assert!(self.is_outbound());
1891 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1892 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1894 let mut addl_htlcs = 0;
1895 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1897 HTLCInitiator::LocalOffered => {
1898 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1902 HTLCInitiator::RemoteOffered => {
1903 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1909 let mut included_htlcs = 0;
1910 for ref htlc in self.pending_inbound_htlcs.iter() {
1911 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1914 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1915 // transaction including this HTLC if it times out before they RAA.
1916 included_htlcs += 1;
1919 for ref htlc in self.pending_outbound_htlcs.iter() {
1920 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1924 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1925 OutboundHTLCState::Committed => included_htlcs += 1,
1926 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1927 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1928 // transaction won't be generated until they send us their next RAA, which will mean
1929 // dropping any HTLCs in this state.
1934 for htlc in self.holding_cell_htlc_updates.iter() {
1936 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1937 if amount_msat / 1000 < real_dust_limit_timeout_sat {
1942 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1943 // ack we're guaranteed to never include them in commitment txs anymore.
1947 let num_htlcs = included_htlcs + addl_htlcs;
1948 let res = self.commit_tx_fee_msat(num_htlcs);
1949 #[cfg(any(test, feature = "fuzztarget"))]
1952 if fee_spike_buffer_htlc.is_some() {
1953 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1955 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1956 + self.holding_cell_htlc_updates.len();
1957 let commitment_tx_info = CommitmentTxInfoCached {
1959 total_pending_htlcs,
1960 next_holder_htlc_id: match htlc.origin {
1961 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1962 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1964 next_counterparty_htlc_id: match htlc.origin {
1965 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1966 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1968 feerate: self.feerate_per_kw,
1970 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1975 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1976 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1977 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1979 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1980 assert!(!self.is_outbound());
1982 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1983 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1985 let mut addl_htlcs = 0;
1986 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1988 HTLCInitiator::LocalOffered => {
1989 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1993 HTLCInitiator::RemoteOffered => {
1994 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2000 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2001 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2002 // committed outbound HTLCs, see below.
2003 let mut included_htlcs = 0;
2004 for ref htlc in self.pending_inbound_htlcs.iter() {
2005 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2008 included_htlcs += 1;
2011 for ref htlc in self.pending_outbound_htlcs.iter() {
2012 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2015 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2016 // i.e. if they've responded to us with an RAA after announcement.
2018 OutboundHTLCState::Committed => included_htlcs += 1,
2019 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2020 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2025 let num_htlcs = included_htlcs + addl_htlcs;
2026 let res = self.commit_tx_fee_msat(num_htlcs);
2027 #[cfg(any(test, feature = "fuzztarget"))]
2030 if fee_spike_buffer_htlc.is_some() {
2031 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2033 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2034 let commitment_tx_info = CommitmentTxInfoCached {
2036 total_pending_htlcs,
2037 next_holder_htlc_id: match htlc.origin {
2038 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2039 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2041 next_counterparty_htlc_id: match htlc.origin {
2042 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2043 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2045 feerate: self.feerate_per_kw,
2047 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2052 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>
2053 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2054 // We can't accept HTLCs sent after we've sent a shutdown.
2055 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2056 if local_sent_shutdown {
2057 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
2059 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2060 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2061 if remote_sent_shutdown {
2062 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2064 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2065 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2067 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2068 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2070 if msg.amount_msat == 0 {
2071 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2073 if msg.amount_msat < self.holder_htlc_minimum_msat {
2074 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)));
2077 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
2078 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
2079 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2081 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2082 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2083 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2085 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2086 // the reserve_satoshis we told them to always have as direct payment so that they lose
2087 // something if we punish them for broadcasting an old state).
2088 // Note that we don't really care about having a small/no to_remote output in our local
2089 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2090 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2091 // present in the next commitment transaction we send them (at least for fulfilled ones,
2092 // failed ones won't modify value_to_self).
2093 // Note that we will send HTLCs which another instance of rust-lightning would think
2094 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2095 // Channel state once they will not be present in the next received commitment
2097 let mut removed_outbound_total_msat = 0;
2098 for ref htlc in self.pending_outbound_htlcs.iter() {
2099 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2100 removed_outbound_total_msat += htlc.amount_msat;
2101 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2102 removed_outbound_total_msat += htlc.amount_msat;
2106 let pending_value_to_self_msat =
2107 self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
2108 let pending_remote_value_msat =
2109 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2110 if pending_remote_value_msat < msg.amount_msat {
2111 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2114 // Check that the remote can afford to pay for this HTLC on-chain at the current
2115 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2116 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2117 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2118 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2120 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2121 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2124 let chan_reserve_msat =
2125 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2126 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2127 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2130 if !self.is_outbound() {
2131 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2132 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2133 // receiver's side, only on the sender's.
2134 // Note that when we eventually remove support for fee updates and switch to anchor output
2135 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2136 // the extra htlc when calculating the next remote commitment transaction fee as we should
2137 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2138 // sensitive to fee spikes.
2139 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2140 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2141 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2142 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2143 // the HTLC, i.e. its status is already set to failing.
2144 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2145 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2148 // Check that they won't violate our local required channel reserve by adding this HTLC.
2149 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2150 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2151 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2152 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2155 if self.next_counterparty_htlc_id != msg.htlc_id {
2156 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2158 if msg.cltv_expiry >= 500000000 {
2159 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2162 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2163 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2164 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2168 // Now update local state:
2169 self.next_counterparty_htlc_id += 1;
2170 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2171 htlc_id: msg.htlc_id,
2172 amount_msat: msg.amount_msat,
2173 payment_hash: msg.payment_hash,
2174 cltv_expiry: msg.cltv_expiry,
2175 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2180 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2182 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&OutboundHTLCOutput, ChannelError> {
2183 for htlc in self.pending_outbound_htlcs.iter_mut() {
2184 if htlc.htlc_id == htlc_id {
2185 match check_preimage {
2187 Some(payment_hash) =>
2188 if payment_hash != htlc.payment_hash {
2189 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2193 OutboundHTLCState::LocalAnnounced(_) =>
2194 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2195 OutboundHTLCState::Committed => {
2196 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2198 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2199 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2204 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2207 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<(HTLCSource, u64), ChannelError> {
2208 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2209 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2211 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2212 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2215 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2216 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|htlc| (htlc.source.clone(), htlc.amount_msat))
2219 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2220 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2221 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2223 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2224 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2227 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2231 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2232 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2233 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2235 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2236 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2239 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2243 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)>
2244 where F::Target: FeeEstimator,
2247 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2248 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2250 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2251 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2253 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2254 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2257 let funding_script = self.get_funding_redeemscript();
2259 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2261 let mut update_fee = false;
2262 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2264 self.pending_update_fee.unwrap()
2269 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2270 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2271 let commitment_txid = {
2272 let trusted_tx = commitment_tx.0.trust();
2273 let bitcoin_tx = trusted_tx.built_transaction();
2274 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2276 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2277 log_bytes!(msg.signature.serialize_compact()[..]),
2278 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2279 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2280 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2281 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2285 let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2286 (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2289 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2290 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2292 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2293 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2294 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2297 #[cfg(any(test, feature = "fuzztarget"))]
2299 if self.is_outbound() {
2300 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2301 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2302 if let Some(info) = projected_commit_tx_info {
2303 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2304 + self.holding_cell_htlc_updates.len();
2305 if info.total_pending_htlcs == total_pending_htlcs
2306 && info.next_holder_htlc_id == self.next_holder_htlc_id
2307 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2308 && info.feerate == self.feerate_per_kw {
2309 assert_eq!(total_fee, info.fee / 1000);
2315 if msg.htlc_signatures.len() != num_htlcs {
2316 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2319 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2320 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2321 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2322 if let Some(_) = htlc.transaction_output_index {
2323 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2324 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2325 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2327 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2328 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2329 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2330 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2331 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2332 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2333 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2335 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2337 htlcs_and_sigs.push((htlc, None, source));
2341 let holder_commitment_tx = HolderCommitmentTransaction::new(
2344 msg.htlc_signatures.clone(),
2345 &self.get_holder_pubkeys().funding_pubkey,
2346 self.counterparty_funding_pubkey()
2349 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2350 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2352 // Update state now that we've passed all the can-fail calls...
2353 let mut need_commitment = false;
2354 if !self.is_outbound() {
2355 if let Some(fee_update) = self.pending_update_fee {
2356 self.feerate_per_kw = fee_update;
2357 // We later use the presence of pending_update_fee to indicate we should generate a
2358 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2359 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2360 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2361 need_commitment = true;
2362 self.pending_update_fee = None;
2367 self.latest_monitor_update_id += 1;
2368 let mut monitor_update = ChannelMonitorUpdate {
2369 update_id: self.latest_monitor_update_id,
2370 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2371 commitment_tx: holder_commitment_tx,
2372 htlc_outputs: htlcs_and_sigs
2376 for htlc in self.pending_inbound_htlcs.iter_mut() {
2377 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2378 Some(forward_info.clone())
2380 if let Some(forward_info) = new_forward {
2381 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2382 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2383 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2384 need_commitment = true;
2387 for htlc in self.pending_outbound_htlcs.iter_mut() {
2388 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2389 Some(fail_reason.take())
2391 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2392 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2393 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2394 need_commitment = true;
2398 self.cur_holder_commitment_transaction_number -= 1;
2399 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2400 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2401 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2403 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2404 // In case we initially failed monitor updating without requiring a response, we need
2405 // to make sure the RAA gets sent first.
2406 self.monitor_pending_revoke_and_ack = true;
2407 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2408 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2409 // the corresponding HTLC status updates so that get_last_commitment_update
2410 // includes the right HTLCs.
2411 self.monitor_pending_commitment_signed = true;
2412 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2413 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2414 // strictly increasing by one, so decrement it here.
2415 self.latest_monitor_update_id = monitor_update.update_id;
2416 monitor_update.updates.append(&mut additional_update.updates);
2418 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2419 log_bytes!(self.channel_id));
2420 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2421 // re-send the message on restoration)
2422 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2425 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2426 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2427 // we'll send one right away when we get the revoke_and_ack when we
2428 // free_holding_cell_htlcs().
2429 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2430 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2431 // strictly increasing by one, so decrement it here.
2432 self.latest_monitor_update_id = monitor_update.update_id;
2433 monitor_update.updates.append(&mut additional_update.updates);
2435 } else if !need_commitment {
2436 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2437 } else { (None, None) };
2439 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2440 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2442 Ok((msgs::RevokeAndACK {
2443 channel_id: self.channel_id,
2444 per_commitment_secret,
2445 next_per_commitment_point,
2446 }, commitment_signed, closing_signed, monitor_update))
2449 /// Public version of the below, checking relevant preconditions first.
2450 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2451 /// returns `(None, Vec::new())`.
2452 pub fn maybe_free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2453 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2454 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2455 self.free_holding_cell_htlcs(logger)
2456 } else { Ok((None, Vec::new())) }
2459 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2460 /// fulfilling or failing the last pending HTLC)
2461 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2462 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2463 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2464 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2465 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2467 let mut monitor_update = ChannelMonitorUpdate {
2468 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2469 updates: Vec::new(),
2472 let mut htlc_updates = Vec::new();
2473 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2474 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2475 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2476 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2477 let mut htlcs_to_fail = Vec::new();
2478 for htlc_update in htlc_updates.drain(..) {
2479 // Note that this *can* fail, though it should be due to rather-rare conditions on
2480 // fee races with adding too many outputs which push our total payments just over
2481 // the limit. In case it's less rare than I anticipate, we may want to revisit
2482 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2483 // to rebalance channels.
2484 match &htlc_update {
2485 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2486 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2487 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2490 ChannelError::Ignore(ref msg) => {
2491 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2492 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2493 // If we fail to send here, then this HTLC should
2494 // be failed backwards. Failing to send here
2495 // indicates that this HTLC may keep being put back
2496 // into the holding cell without ever being
2497 // successfully forwarded/failed/fulfilled, causing
2498 // our counterparty to eventually close on us.
2499 htlcs_to_fail.push((source.clone(), *payment_hash));
2502 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2508 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2509 // If an HTLC claim was previously added to the holding cell (via
2510 // `get_update_fulfill_htlc`, then generating the claim message itself must
2511 // not fail - any in between attempts to claim the HTLC will have resulted
2512 // in it hitting the holding cell again and we cannot change the state of a
2513 // holding cell HTLC from fulfill to anything else.
2514 let (update_fulfill_msg_option, mut additional_monitor_update) =
2515 if let UpdateFulfillFetch::NewClaim { msg, monitor_update, .. } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2516 (msg, monitor_update)
2517 } else { unreachable!() };
2518 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2519 monitor_update.updates.append(&mut additional_monitor_update.updates);
2521 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2522 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2523 Ok(update_fail_msg_option) => {
2524 // If an HTLC failure was previously added to the holding cell (via
2525 // `get_update_fail_htlc`) then generating the fail message itself
2526 // must not fail - we should never end up in a state where we
2527 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2528 // we didn't wait for a full revocation before failing.
2529 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2532 if let ChannelError::Ignore(_) = e {}
2534 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2541 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2542 return Ok((None, htlcs_to_fail));
2544 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2545 self.pending_update_fee = self.holding_cell_update_fee.take();
2546 Some(msgs::UpdateFee {
2547 channel_id: self.channel_id,
2548 feerate_per_kw: feerate as u32,
2554 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2555 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2556 // but we want them to be strictly increasing by one, so reset it here.
2557 self.latest_monitor_update_id = monitor_update.update_id;
2558 monitor_update.updates.append(&mut additional_update.updates);
2560 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2561 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2562 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2564 Ok((Some((msgs::CommitmentUpdate {
2566 update_fulfill_htlcs,
2568 update_fail_malformed_htlcs: Vec::new(),
2571 }, monitor_update)), htlcs_to_fail))
2573 Ok((None, Vec::new()))
2577 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2578 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2579 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2580 /// generating an appropriate error *after* the channel state has been updated based on the
2581 /// revoke_and_ack message.
2582 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>
2583 where F::Target: FeeEstimator,
2586 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2587 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2589 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2590 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2592 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2593 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2596 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2597 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 {
2598 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2602 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2603 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2604 // haven't given them a new commitment transaction to broadcast). We should probably
2605 // take advantage of this by updating our channel monitor, sending them an error, and
2606 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2607 // lot of work, and there's some chance this is all a misunderstanding anyway.
2608 // We have to do *something*, though, since our signer may get mad at us for otherwise
2609 // jumping a remote commitment number, so best to just force-close and move on.
2610 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2613 #[cfg(any(test, feature = "fuzztarget"))]
2615 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2616 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2619 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2620 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2621 self.latest_monitor_update_id += 1;
2622 let mut monitor_update = ChannelMonitorUpdate {
2623 update_id: self.latest_monitor_update_id,
2624 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2625 idx: self.cur_counterparty_commitment_transaction_number + 1,
2626 secret: msg.per_commitment_secret,
2630 // Update state now that we've passed all the can-fail calls...
2631 // (note that we may still fail to generate the new commitment_signed message, but that's
2632 // OK, we step the channel here and *then* if the new generation fails we can fail the
2633 // channel based on that, but stepping stuff here should be safe either way.
2634 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2635 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2636 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2637 self.cur_counterparty_commitment_transaction_number -= 1;
2639 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2640 let mut to_forward_infos = Vec::new();
2641 let mut revoked_htlcs = Vec::new();
2642 let mut update_fail_htlcs = Vec::new();
2643 let mut update_fail_malformed_htlcs = Vec::new();
2644 let mut require_commitment = false;
2645 let mut value_to_self_msat_diff: i64 = 0;
2648 // Take references explicitly so that we can hold multiple references to self.
2649 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2650 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2652 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2653 pending_inbound_htlcs.retain(|htlc| {
2654 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2655 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2656 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2657 value_to_self_msat_diff += htlc.amount_msat as i64;
2662 pending_outbound_htlcs.retain(|htlc| {
2663 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2664 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2665 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2666 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2668 // They fulfilled, so we sent them money
2669 value_to_self_msat_diff -= htlc.amount_msat as i64;
2674 for htlc in pending_inbound_htlcs.iter_mut() {
2675 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2677 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2681 let mut state = InboundHTLCState::Committed;
2682 mem::swap(&mut state, &mut htlc.state);
2684 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2685 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2686 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2687 require_commitment = true;
2688 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2689 match forward_info {
2690 PendingHTLCStatus::Fail(fail_msg) => {
2691 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2692 require_commitment = true;
2694 HTLCFailureMsg::Relay(msg) => {
2695 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2696 update_fail_htlcs.push(msg)
2698 HTLCFailureMsg::Malformed(msg) => {
2699 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2700 update_fail_malformed_htlcs.push(msg)
2704 PendingHTLCStatus::Forward(forward_info) => {
2705 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2706 to_forward_infos.push((forward_info, htlc.htlc_id));
2707 htlc.state = InboundHTLCState::Committed;
2713 for htlc in pending_outbound_htlcs.iter_mut() {
2714 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2715 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2716 htlc.state = OutboundHTLCState::Committed;
2718 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2719 Some(fail_reason.take())
2721 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2722 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2723 require_commitment = true;
2727 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2729 if self.is_outbound() {
2730 if let Some(feerate) = self.pending_update_fee.take() {
2731 self.feerate_per_kw = feerate;
2734 if let Some(feerate) = self.pending_update_fee {
2735 // Because a node cannot send two commitment_signeds in a row without getting a
2736 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2737 // it should use to create keys with) and because a node can't send a
2738 // commitment_signed without changes, checking if the feerate is equal to the
2739 // pending feerate update is sufficient to detect require_commitment.
2740 if feerate == self.feerate_per_kw {
2741 require_commitment = true;
2742 self.pending_update_fee = None;
2747 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2748 // We can't actually generate a new commitment transaction (incl by freeing holding
2749 // cells) while we can't update the monitor, so we just return what we have.
2750 if require_commitment {
2751 self.monitor_pending_commitment_signed = true;
2752 // When the monitor updating is restored we'll call get_last_commitment_update(),
2753 // which does not update state, but we're definitely now awaiting a remote revoke
2754 // before we can step forward any more, so set it here.
2755 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2756 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2757 // strictly increasing by one, so decrement it here.
2758 self.latest_monitor_update_id = monitor_update.update_id;
2759 monitor_update.updates.append(&mut additional_update.updates);
2761 self.monitor_pending_forwards.append(&mut to_forward_infos);
2762 self.monitor_pending_failures.append(&mut revoked_htlcs);
2763 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2764 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2767 match self.free_holding_cell_htlcs(logger)? {
2768 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2769 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2770 for fail_msg in update_fail_htlcs.drain(..) {
2771 commitment_update.update_fail_htlcs.push(fail_msg);
2773 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2774 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2775 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2778 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2779 // strictly increasing by one, so decrement it here.
2780 self.latest_monitor_update_id = monitor_update.update_id;
2781 monitor_update.updates.append(&mut additional_update.updates);
2783 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2785 (None, htlcs_to_fail) => {
2786 if require_commitment {
2787 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2789 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2790 // strictly increasing by one, so decrement it here.
2791 self.latest_monitor_update_id = monitor_update.update_id;
2792 monitor_update.updates.append(&mut additional_update.updates);
2794 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2795 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2796 Ok((Some(msgs::CommitmentUpdate {
2797 update_add_htlcs: Vec::new(),
2798 update_fulfill_htlcs: Vec::new(),
2800 update_fail_malformed_htlcs,
2803 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2805 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2806 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2813 /// Adds a pending update to this channel. See the doc for send_htlc for
2814 /// further details on the optionness of the return value.
2815 /// You MUST call send_commitment prior to any other calls on this Channel
2816 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2817 if !self.is_outbound() {
2818 panic!("Cannot send fee from inbound channel");
2820 if !self.is_usable() {
2821 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2823 if !self.is_live() {
2824 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2827 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2828 self.holding_cell_update_fee = Some(feerate_per_kw);
2832 debug_assert!(self.pending_update_fee.is_none());
2833 self.pending_update_fee = Some(feerate_per_kw);
2835 Some(msgs::UpdateFee {
2836 channel_id: self.channel_id,
2841 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 {
2842 match self.send_update_fee(feerate_per_kw) {
2843 Some(update_fee) => {
2844 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2845 Ok(Some((update_fee, commitment_signed, monitor_update)))
2851 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2852 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2854 /// No further message handling calls may be made until a channel_reestablish dance has
2856 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
2857 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2858 if self.channel_state < ChannelState::FundingSent as u32 {
2859 self.channel_state = ChannelState::ShutdownComplete as u32;
2862 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2863 // will be retransmitted.
2864 self.last_sent_closing_fee = None;
2866 let mut inbound_drop_count = 0;
2867 self.pending_inbound_htlcs.retain(|htlc| {
2869 InboundHTLCState::RemoteAnnounced(_) => {
2870 // They sent us an update_add_htlc but we never got the commitment_signed.
2871 // We'll tell them what commitment_signed we're expecting next and they'll drop
2872 // this HTLC accordingly
2873 inbound_drop_count += 1;
2876 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2877 // We received a commitment_signed updating this HTLC and (at least hopefully)
2878 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2879 // in response to it yet, so don't touch it.
2882 InboundHTLCState::Committed => true,
2883 InboundHTLCState::LocalRemoved(_) => {
2884 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2885 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2886 // (that we missed). Keep this around for now and if they tell us they missed
2887 // the commitment_signed we can re-transmit the update then.
2892 self.next_counterparty_htlc_id -= inbound_drop_count;
2894 for htlc in self.pending_outbound_htlcs.iter_mut() {
2895 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2896 // They sent us an update to remove this but haven't yet sent the corresponding
2897 // commitment_signed, we need to move it back to Committed and they can re-send
2898 // the update upon reconnection.
2899 htlc.state = OutboundHTLCState::Committed;
2903 self.channel_state |= ChannelState::PeerDisconnected as u32;
2904 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
2907 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2908 /// updates are partially paused.
2909 /// This must be called immediately after the call which generated the ChannelMonitor update
2910 /// which failed. The messages which were generated from that call which generated the
2911 /// monitor update failure must *not* have been sent to the remote end, and must instead
2912 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2913 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)>) {
2914 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2915 self.monitor_pending_revoke_and_ack = resend_raa;
2916 self.monitor_pending_commitment_signed = resend_commitment;
2917 assert!(self.monitor_pending_forwards.is_empty());
2918 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2919 assert!(self.monitor_pending_failures.is_empty());
2920 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2921 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2924 /// Indicates that the latest ChannelMonitor update has been committed by the client
2925 /// successfully and we should restore normal operation. Returns messages which should be sent
2926 /// to the remote side.
2927 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 {
2928 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2929 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2931 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
2932 self.funding_transaction.take()
2935 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
2936 // we assume the user never directly broadcasts the funding transaction and waits for us to
2937 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
2938 // channel which failed to persist the monitor on funding_created, and we got the funding
2939 // transaction confirmed before the monitor was persisted.
2940 let funding_locked = if self.monitor_pending_funding_locked {
2941 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
2942 self.monitor_pending_funding_locked = false;
2943 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2944 Some(msgs::FundingLocked {
2945 channel_id: self.channel_id(),
2946 next_per_commitment_point,
2950 let mut forwards = Vec::new();
2951 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2952 let mut failures = Vec::new();
2953 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2955 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2956 self.monitor_pending_revoke_and_ack = false;
2957 self.monitor_pending_commitment_signed = false;
2958 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
2961 let raa = if self.monitor_pending_revoke_and_ack {
2962 Some(self.get_last_revoke_and_ack())
2964 let commitment_update = if self.monitor_pending_commitment_signed {
2965 Some(self.get_last_commitment_update(logger))
2968 self.monitor_pending_revoke_and_ack = false;
2969 self.monitor_pending_commitment_signed = false;
2970 let order = self.resend_order.clone();
2971 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
2972 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
2973 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
2974 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2975 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
2978 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2979 where F::Target: FeeEstimator
2981 if self.is_outbound() {
2982 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2984 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2985 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2987 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2988 self.pending_update_fee = Some(msg.feerate_per_kw);
2989 self.update_time_counter += 1;
2993 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2994 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2995 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
2996 msgs::RevokeAndACK {
2997 channel_id: self.channel_id,
2998 per_commitment_secret,
2999 next_per_commitment_point,
3003 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3004 let mut update_add_htlcs = Vec::new();
3005 let mut update_fulfill_htlcs = Vec::new();
3006 let mut update_fail_htlcs = Vec::new();
3007 let mut update_fail_malformed_htlcs = Vec::new();
3009 for htlc in self.pending_outbound_htlcs.iter() {
3010 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3011 update_add_htlcs.push(msgs::UpdateAddHTLC {
3012 channel_id: self.channel_id(),
3013 htlc_id: htlc.htlc_id,
3014 amount_msat: htlc.amount_msat,
3015 payment_hash: htlc.payment_hash,
3016 cltv_expiry: htlc.cltv_expiry,
3017 onion_routing_packet: (**onion_packet).clone(),
3022 for htlc in self.pending_inbound_htlcs.iter() {
3023 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3025 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3026 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3027 channel_id: self.channel_id(),
3028 htlc_id: htlc.htlc_id,
3029 reason: err_packet.clone()
3032 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3033 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3034 channel_id: self.channel_id(),
3035 htlc_id: htlc.htlc_id,
3036 sha256_of_onion: sha256_of_onion.clone(),
3037 failure_code: failure_code.clone(),
3040 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3041 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3042 channel_id: self.channel_id(),
3043 htlc_id: htlc.htlc_id,
3044 payment_preimage: payment_preimage.clone(),
3051 log_trace!(logger, "Regenerated latest commitment update in channel {} with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3052 log_bytes!(self.channel_id()), update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3053 msgs::CommitmentUpdate {
3054 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
3056 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,
3060 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3061 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3062 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, Vec<(HTLCSource, PaymentHash)>, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
3063 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3064 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3065 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3066 // just close here instead of trying to recover.
3067 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3070 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3071 msg.next_local_commitment_number == 0 {
3072 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3075 if msg.next_remote_commitment_number > 0 {
3076 match msg.data_loss_protect {
3077 OptionalField::Present(ref data_loss) => {
3078 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3079 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3080 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3081 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3082 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3084 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3085 return Err(ChannelError::CloseDelayBroadcast(
3086 "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()
3090 OptionalField::Absent => {}
3094 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3095 // remaining cases either succeed or ErrorMessage-fail).
3096 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3098 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3099 Some(msgs::Shutdown {
3100 channel_id: self.channel_id,
3101 scriptpubkey: self.get_closing_scriptpubkey(),
3105 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3106 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3107 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3108 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3109 if msg.next_remote_commitment_number != 0 {
3110 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3112 // Short circuit the whole handler as there is nothing we can resend them
3113 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3116 // We have OurFundingLocked set!
3117 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3118 return Ok((Some(msgs::FundingLocked {
3119 channel_id: self.channel_id(),
3120 next_per_commitment_point,
3121 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3124 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3125 // Remote isn't waiting on any RevokeAndACK from us!
3126 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3128 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3129 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3130 self.monitor_pending_revoke_and_ack = true;
3133 Some(self.get_last_revoke_and_ack())
3136 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3139 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3140 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3141 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3142 // the corresponding revoke_and_ack back yet.
3143 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 };
3145 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3146 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3147 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3148 Some(msgs::FundingLocked {
3149 channel_id: self.channel_id(),
3150 next_per_commitment_point,
3154 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3155 if required_revoke.is_some() {
3156 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3158 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3161 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3162 // We're up-to-date and not waiting on a remote revoke (if we are our
3163 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3164 // have received some updates while we were disconnected. Free the holding cell
3166 match self.free_holding_cell_htlcs(logger) {
3167 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3168 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3169 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3170 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3172 Ok((None, htlcs_to_fail)) => {
3173 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3177 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3179 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3180 if required_revoke.is_some() {
3181 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3183 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3186 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3187 self.monitor_pending_commitment_signed = true;
3188 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3191 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3193 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3197 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3198 where F::Target: FeeEstimator
3200 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3201 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3202 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3206 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3207 if self.feerate_per_kw > proposed_feerate {
3208 proposed_feerate = self.feerate_per_kw;
3210 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3211 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3213 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3214 let sig = self.holder_signer
3215 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3217 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3218 if sig.is_none() { return None; }
3220 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3221 Some(msgs::ClosingSigned {
3222 channel_id: self.channel_id,
3223 fee_satoshis: total_fee_satoshis,
3224 signature: sig.unwrap(),
3228 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>
3229 where F::Target: FeeEstimator
3231 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3232 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3234 if self.channel_state < ChannelState::FundingSent as u32 {
3235 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3236 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3237 // can do that via error message without getting a connection fail anyway...
3238 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3240 for htlc in self.pending_inbound_htlcs.iter() {
3241 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3242 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3245 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3247 let shutdown_scriptpubkey = match ShutdownScript::try_from((msg.scriptpubkey.clone(), their_features)) {
3248 Ok(script) => script.into_inner(),
3249 Err(_) => return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex()))),
3252 if self.counterparty_shutdown_scriptpubkey.is_some() {
3253 if Some(&shutdown_scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3254 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", shutdown_scriptpubkey.to_bytes().to_hex())));
3257 self.counterparty_shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3260 // From here on out, we may not fail!
3262 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3263 self.update_time_counter += 1;
3265 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3266 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3267 // cell HTLCs and return them to fail the payment.
3268 self.holding_cell_update_fee = None;
3269 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3270 self.holding_cell_htlc_updates.retain(|htlc_update| {
3272 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3273 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3279 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3280 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3281 // any further commitment updates after we set LocalShutdownSent.
3283 let shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3286 Some(msgs::Shutdown {
3287 channel_id: self.channel_id,
3288 scriptpubkey: self.get_closing_scriptpubkey(),
3292 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3293 self.update_time_counter += 1;
3295 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
3298 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3299 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3300 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3301 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3303 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3305 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3306 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3307 if funding_key[..] < counterparty_funding_key[..] {
3308 tx.input[0].witness.push(sig.serialize_der().to_vec());
3309 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3311 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3312 tx.input[0].witness.push(sig.serialize_der().to_vec());
3314 tx.input[0].witness[1].push(SigHashType::All as u8);
3315 tx.input[0].witness[2].push(SigHashType::All as u8);
3317 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3320 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3321 where F::Target: FeeEstimator
3323 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3324 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3326 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3327 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3329 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3330 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3332 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3333 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3336 let funding_redeemscript = self.get_funding_redeemscript();
3337 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3338 if used_total_fee != msg.fee_satoshis {
3339 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)));
3341 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3343 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3346 // The remote end may have decided to revoke their output due to inconsistent dust
3347 // limits, so check for that case by re-checking the signature here.
3348 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3349 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3350 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3354 let closing_tx_max_weight = self.get_closing_transaction_weight(
3355 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3356 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3357 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3358 if last_fee == msg.fee_satoshis {
3359 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3360 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3361 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3362 self.channel_state = ChannelState::ShutdownComplete as u32;
3363 self.update_time_counter += 1;
3364 return Ok((None, Some(closing_tx)));
3368 macro_rules! propose_new_feerate {
3369 ($new_feerate: expr) => {
3370 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3371 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3372 let sig = self.holder_signer
3373 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3374 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3375 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3376 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3377 return Ok((Some(msgs::ClosingSigned {
3378 channel_id: self.channel_id,
3379 fee_satoshis: used_total_fee,
3385 let mut min_feerate = 253;
3386 if self.is_outbound() {
3387 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3388 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3389 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3390 if max_feerate <= last_feerate {
3391 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)));
3394 propose_new_feerate!(max_feerate);
3397 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3399 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3400 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3401 if min_feerate >= last_feerate {
3402 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)));
3405 propose_new_feerate!(min_feerate);
3408 let sig = self.holder_signer
3409 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3410 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3411 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3412 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3413 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3415 self.channel_state = ChannelState::ShutdownComplete as u32;
3416 self.update_time_counter += 1;
3418 Ok((Some(msgs::ClosingSigned {
3419 channel_id: self.channel_id,
3420 fee_satoshis: msg.fee_satoshis,
3422 }), Some(closing_tx)))
3425 // Public utilities:
3427 pub fn channel_id(&self) -> [u8; 32] {
3431 pub fn minimum_depth(&self) -> Option<u32> {
3435 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3436 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3437 pub fn get_user_id(&self) -> u64 {
3441 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3442 /// is_usable() returns true).
3443 /// Allowed in any state (including after shutdown)
3444 pub fn get_short_channel_id(&self) -> Option<u64> {
3445 self.short_channel_id
3448 /// Returns the funding_txo we either got from our peer, or were given by
3449 /// get_outbound_funding_created.
3450 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3451 self.channel_transaction_parameters.funding_outpoint
3454 fn get_holder_selected_contest_delay(&self) -> u16 {
3455 self.channel_transaction_parameters.holder_selected_contest_delay
3458 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3459 &self.channel_transaction_parameters.holder_pubkeys
3462 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3463 self.channel_transaction_parameters.counterparty_parameters
3464 .as_ref().map(|params| params.selected_contest_delay)
3467 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3468 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3471 /// Allowed in any state (including after shutdown)
3472 pub fn get_counterparty_node_id(&self) -> PublicKey {
3473 self.counterparty_node_id
3476 /// Allowed in any state (including after shutdown)
3478 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3479 self.holder_htlc_minimum_msat
3482 /// Allowed in any state (including after shutdown)
3483 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3485 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3486 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3487 // channel might have been used to route very small values (either by honest users or as DoS).
3488 self.channel_value_satoshis * 1000 * 9 / 10,
3490 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3494 /// Allowed in any state (including after shutdown)
3495 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3496 self.counterparty_htlc_minimum_msat
3499 pub fn get_value_satoshis(&self) -> u64 {
3500 self.channel_value_satoshis
3503 pub fn get_fee_proportional_millionths(&self) -> u32 {
3504 self.config.forwarding_fee_proportional_millionths
3507 pub fn get_cltv_expiry_delta(&self) -> u16 {
3508 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3512 pub fn get_feerate(&self) -> u32 {
3516 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3517 self.cur_holder_commitment_transaction_number + 1
3520 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3521 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3524 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3525 self.cur_counterparty_commitment_transaction_number + 2
3529 pub fn get_signer(&self) -> &Signer {
3534 pub fn get_value_stat(&self) -> ChannelValueStat {
3536 value_to_self_msat: self.value_to_self_msat,
3537 channel_value_msat: self.channel_value_satoshis * 1000,
3538 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3539 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3540 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3541 holding_cell_outbound_amount_msat: {
3543 for h in self.holding_cell_htlc_updates.iter() {
3545 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3553 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3554 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3558 /// Allowed in any state (including after shutdown)
3559 pub fn get_update_time_counter(&self) -> u32 {
3560 self.update_time_counter
3563 pub fn get_latest_monitor_update_id(&self) -> u64 {
3564 self.latest_monitor_update_id
3567 pub fn should_announce(&self) -> bool {
3568 self.config.announced_channel
3571 pub fn is_outbound(&self) -> bool {
3572 self.channel_transaction_parameters.is_outbound_from_holder
3575 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3576 /// Allowed in any state (including after shutdown)
3577 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3578 self.config.forwarding_fee_base_msat
3581 /// Returns true if we've ever received a message from the remote end for this Channel
3582 pub fn have_received_message(&self) -> bool {
3583 self.channel_state > (ChannelState::OurInitSent as u32)
3586 /// Returns true if this channel is fully established and not known to be closing.
3587 /// Allowed in any state (including after shutdown)
3588 pub fn is_usable(&self) -> bool {
3589 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3590 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3593 /// Returns true if this channel is currently available for use. This is a superset of
3594 /// is_usable() and considers things like the channel being temporarily disabled.
3595 /// Allowed in any state (including after shutdown)
3596 pub fn is_live(&self) -> bool {
3597 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3600 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3601 /// Allowed in any state (including after shutdown)
3602 pub fn is_awaiting_monitor_update(&self) -> bool {
3603 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3606 /// Returns true if funding_created was sent/received.
3607 pub fn is_funding_initiated(&self) -> bool {
3608 self.channel_state >= ChannelState::FundingSent as u32
3611 /// Returns true if this channel is fully shut down. True here implies that no further actions
3612 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3613 /// will be handled appropriately by the chain monitor.
3614 pub fn is_shutdown(&self) -> bool {
3615 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3616 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3621 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3622 self.channel_update_status
3625 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3626 self.channel_update_status = status;
3629 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3630 if self.funding_tx_confirmation_height == 0 {
3634 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3635 if funding_tx_confirmations <= 0 {
3636 self.funding_tx_confirmation_height = 0;
3639 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3643 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3644 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3645 self.channel_state |= ChannelState::OurFundingLocked as u32;
3647 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3648 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3649 self.update_time_counter += 1;
3651 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3652 // We got a reorg but not enough to trigger a force close, just ignore.
3654 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3655 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3657 // We got a reorg but not enough to trigger a force close, just ignore.
3661 if need_commitment_update {
3662 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3663 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3664 return Some(msgs::FundingLocked {
3665 channel_id: self.channel_id,
3666 next_per_commitment_point,
3669 self.monitor_pending_funding_locked = true;
3675 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3676 /// In the first case, we store the confirmation height and calculating the short channel id.
3677 /// In the second, we simply return an Err indicating we need to be force-closed now.
3678 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3679 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3680 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3681 for &(index_in_block, tx) in txdata.iter() {
3682 if let Some(funding_txo) = self.get_funding_txo() {
3683 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3684 // whether they've sent a funding_locked or not), check if we should send one.
3685 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3686 if tx.txid() == funding_txo.txid {
3687 let txo_idx = funding_txo.index as usize;
3688 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3689 tx.output[txo_idx].value != self.channel_value_satoshis {
3690 if self.is_outbound() {
3691 // If we generated the funding transaction and it doesn't match what it
3692 // should, the client is really broken and we should just panic and
3693 // tell them off. That said, because hash collisions happen with high
3694 // probability in fuzztarget mode, if we're fuzzing we just close the
3695 // channel and move on.
3696 #[cfg(not(feature = "fuzztarget"))]
3697 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3699 self.update_time_counter += 1;
3700 return Err(msgs::ErrorMessage {
3701 channel_id: self.channel_id(),
3702 data: "funding tx had wrong script/value or output index".to_owned()
3705 if self.is_outbound() {
3706 for input in tx.input.iter() {
3707 if input.witness.is_empty() {
3708 // We generated a malleable funding transaction, implying we've
3709 // just exposed ourselves to funds loss to our counterparty.
3710 #[cfg(not(feature = "fuzztarget"))]
3711 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3715 self.funding_tx_confirmation_height = height;
3716 self.funding_tx_confirmed_in = Some(*block_hash);
3717 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3718 Ok(scid) => Some(scid),
3719 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3723 // If we allow 1-conf funding, we may need to check for funding_locked here and
3724 // send it immediately instead of waiting for a best_block_updated call (which
3725 // may have already happened for this block).
3726 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3727 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3728 return Ok(Some(funding_locked));
3731 for inp in tx.input.iter() {
3732 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3733 log_info!(logger, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(self.channel_id()));
3734 return Err(msgs::ErrorMessage {
3735 channel_id: self.channel_id(),
3736 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3745 /// When a new block is connected, we check the height of the block against outbound holding
3746 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3747 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3748 /// handled by the ChannelMonitor.
3750 /// If we return Err, the channel may have been closed, at which point the standard
3751 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3754 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3756 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
3757 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
3758 let mut timed_out_htlcs = Vec::new();
3759 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3760 self.holding_cell_htlc_updates.retain(|htlc_update| {
3762 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3763 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3764 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3772 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3774 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3775 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3776 return Ok((Some(funding_locked), timed_out_htlcs));
3779 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3780 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3781 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3782 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3783 if self.funding_tx_confirmation_height == 0 {
3784 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3785 // zero if it has been reorged out, however in either case, our state flags
3786 // indicate we've already sent a funding_locked
3787 funding_tx_confirmations = 0;
3790 // If we've sent funding_locked (or have both sent and received funding_locked), and
3791 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3792 // close the channel and hope we can get the latest state on chain (because presumably
3793 // the funding transaction is at least still in the mempool of most nodes).
3794 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
3795 return Err(msgs::ErrorMessage {
3796 channel_id: self.channel_id(),
3797 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
3802 Ok((None, timed_out_htlcs))
3805 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
3806 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
3807 /// before the channel has reached funding_locked and we can just wait for more blocks.
3808 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
3809 if self.funding_tx_confirmation_height != 0 {
3810 // We handle the funding disconnection by calling best_block_updated with a height one
3811 // below where our funding was connected, implying a reorg back to conf_height - 1.
3812 let reorg_height = self.funding_tx_confirmation_height - 1;
3813 // We use the time field to bump the current time we set on channel updates if its
3814 // larger. If we don't know that time has moved forward, we can just set it to the last
3815 // time we saw and it will be ignored.
3816 let best_time = self.update_time_counter;
3817 match self.best_block_updated(reorg_height, best_time, logger) {
3818 Ok((funding_locked, timed_out_htlcs)) => {
3819 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
3820 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
3826 // We never learned about the funding confirmation anyway, just ignore
3831 // Methods to get unprompted messages to send to the remote end (or where we already returned
3832 // something in the handler for the message that prompted this message):
3834 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3835 if !self.is_outbound() {
3836 panic!("Tried to open a channel for an inbound channel?");
3838 if self.channel_state != ChannelState::OurInitSent as u32 {
3839 panic!("Cannot generate an open_channel after we've moved forward");
3842 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3843 panic!("Tried to send an open_channel for a channel that has already advanced");
3846 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3847 let keys = self.get_holder_pubkeys();
3851 temporary_channel_id: self.channel_id,
3852 funding_satoshis: self.channel_value_satoshis,
3853 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3854 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3855 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3856 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3857 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3858 feerate_per_kw: self.feerate_per_kw as u32,
3859 to_self_delay: self.get_holder_selected_contest_delay(),
3860 max_accepted_htlcs: OUR_MAX_HTLCS,
3861 funding_pubkey: keys.funding_pubkey,
3862 revocation_basepoint: keys.revocation_basepoint,
3863 payment_point: keys.payment_point,
3864 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3865 htlc_basepoint: keys.htlc_basepoint,
3866 first_per_commitment_point,
3867 channel_flags: if self.config.announced_channel {1} else {0},
3868 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3872 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3873 if self.is_outbound() {
3874 panic!("Tried to send accept_channel for an outbound channel?");
3876 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3877 panic!("Tried to send accept_channel after channel had moved forward");
3879 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3880 panic!("Tried to send an accept_channel for a channel that has already advanced");
3883 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3884 let keys = self.get_holder_pubkeys();
3886 msgs::AcceptChannel {
3887 temporary_channel_id: self.channel_id,
3888 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3889 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3890 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3891 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3892 minimum_depth: self.minimum_depth.unwrap(),
3893 to_self_delay: self.get_holder_selected_contest_delay(),
3894 max_accepted_htlcs: OUR_MAX_HTLCS,
3895 funding_pubkey: keys.funding_pubkey,
3896 revocation_basepoint: keys.revocation_basepoint,
3897 payment_point: keys.payment_point,
3898 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3899 htlc_basepoint: keys.htlc_basepoint,
3900 first_per_commitment_point,
3901 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3905 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3906 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3907 let counterparty_keys = self.build_remote_transaction_keys()?;
3908 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;
3909 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3910 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3913 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3914 /// a funding_created message for the remote peer.
3915 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3916 /// or if called on an inbound channel.
3917 /// Note that channel_id changes during this call!
3918 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3919 /// If an Err is returned, it is a ChannelError::Close.
3920 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 {
3921 if !self.is_outbound() {
3922 panic!("Tried to create outbound funding_created message on an inbound channel!");
3924 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3925 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)");
3927 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3928 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3929 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3930 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3933 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3934 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3936 let signature = match self.get_outbound_funding_created_signature(logger) {
3939 log_error!(logger, "Got bad signatures: {:?}!", e);
3940 self.channel_transaction_parameters.funding_outpoint = None;
3945 let temporary_channel_id = self.channel_id;
3947 // Now that we're past error-generating stuff, update our local state:
3949 self.channel_state = ChannelState::FundingCreated as u32;
3950 self.channel_id = funding_txo.to_channel_id();
3951 self.funding_transaction = Some(funding_transaction);
3953 Ok(msgs::FundingCreated {
3954 temporary_channel_id,
3955 funding_txid: funding_txo.txid,
3956 funding_output_index: funding_txo.index,
3961 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3962 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3963 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3964 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3965 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3967 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3968 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3970 /// This will only return ChannelError::Ignore upon failure.
3971 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3972 if !self.config.announced_channel {
3973 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3975 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3976 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3978 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3979 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3982 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
3984 let msg = msgs::UnsignedChannelAnnouncement {
3985 features: ChannelFeatures::known(),
3987 short_channel_id: self.get_short_channel_id().unwrap(),
3988 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
3989 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
3990 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
3991 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
3992 excess_data: Vec::new(),
3995 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
3996 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4001 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4003 fn sign_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, msghash: secp256k1::Message, announcement: msgs::UnsignedChannelAnnouncement, our_bitcoin_sig: Signature) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4004 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4005 let were_node_one = announcement.node_id_1 == our_node_id;
4007 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4008 Ok(msgs::ChannelAnnouncement {
4009 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4010 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4011 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4012 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4013 contents: announcement,
4016 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4020 /// Processes an incoming announcement_signatures message, providing a fully-signed
4021 /// channel_announcement message which we can broadcast and storing our counterparty's
4022 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4023 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4024 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4026 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4028 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4029 return Err(ChannelError::Close(format!(
4030 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4031 &announcement, self.get_counterparty_node_id())));
4033 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4034 return Err(ChannelError::Close(format!(
4035 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4036 &announcement, self.counterparty_funding_pubkey())));
4039 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4041 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4044 /// Gets a signed channel_announcement for this channel, if we previously received an
4045 /// announcement_signatures from our counterparty.
4046 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4047 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4049 Err(_) => return None,
4051 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4052 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4053 Ok(res) => Some(res),
4058 /// May panic if called on a channel that wasn't immediately-previously
4059 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4060 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4061 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4062 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4063 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4064 // current to_remote balances. However, it no longer has any use, and thus is now simply
4065 // set to a dummy (but valid, as required by the spec) public key.
4066 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4067 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4068 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4069 let mut pk = [2; 33]; pk[1] = 0xff;
4070 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4071 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4072 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4073 log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {} for channel {}", log_bytes!(remote_last_secret), log_bytes!(self.channel_id()));
4074 OptionalField::Present(DataLossProtect {
4075 your_last_per_commitment_secret: remote_last_secret,
4076 my_current_per_commitment_point: dummy_pubkey
4079 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4080 OptionalField::Present(DataLossProtect {
4081 your_last_per_commitment_secret: [0;32],
4082 my_current_per_commitment_point: dummy_pubkey,
4085 msgs::ChannelReestablish {
4086 channel_id: self.channel_id(),
4087 // The protocol has two different commitment number concepts - the "commitment
4088 // transaction number", which starts from 0 and counts up, and the "revocation key
4089 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4090 // commitment transaction numbers by the index which will be used to reveal the
4091 // revocation key for that commitment transaction, which means we have to convert them
4092 // to protocol-level commitment numbers here...
4094 // next_local_commitment_number is the next commitment_signed number we expect to
4095 // receive (indicating if they need to resend one that we missed).
4096 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4097 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4098 // receive, however we track it by the next commitment number for a remote transaction
4099 // (which is one further, as they always revoke previous commitment transaction, not
4100 // the one we send) so we have to decrement by 1. Note that if
4101 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4102 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4104 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4110 // Send stuff to our remote peers:
4112 /// Adds a pending outbound HTLC to this channel, note that you probably want
4113 /// send_htlc_and_commit instead cause you'll want both messages at once.
4115 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4117 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4118 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4120 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4121 /// may not yet have sent the previous commitment update messages and will need to regenerate
4124 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4126 /// If an Err is returned, it's a ChannelError::Ignore!
4127 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> {
4128 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4129 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4131 let channel_total_msat = self.channel_value_satoshis * 1000;
4132 if amount_msat > channel_total_msat {
4133 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4136 if amount_msat == 0 {
4137 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4140 if amount_msat < self.counterparty_htlc_minimum_msat {
4141 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4144 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4145 // Note that this should never really happen, if we're !is_live() on receipt of an
4146 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4147 // the user to send directly into a !is_live() channel. However, if we
4148 // disconnected during the time the previous hop was doing the commitment dance we may
4149 // end up getting here after the forwarding delay. In any case, returning an
4150 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4151 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4154 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
4155 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
4156 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4158 // Check their_max_htlc_value_in_flight_msat
4159 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4160 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)));
4163 if !self.is_outbound() {
4164 // Check that we won't violate the remote channel reserve by adding this HTLC.
4165 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4166 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4167 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4168 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4169 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4170 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4174 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
4175 if pending_value_to_self_msat < amount_msat {
4176 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)));
4179 // `2 *` and extra HTLC are for the fee spike buffer.
4180 let commit_tx_fee_msat = if self.is_outbound() {
4181 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4182 2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4184 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4185 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)));
4188 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4189 // reserve for the remote to have something to claim if we misbehave)
4190 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4191 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4192 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4195 // Now update local state:
4196 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4197 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4202 onion_routing_packet,
4207 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4208 htlc_id: self.next_holder_htlc_id,
4210 payment_hash: payment_hash.clone(),
4212 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4216 let res = msgs::UpdateAddHTLC {
4217 channel_id: self.channel_id,
4218 htlc_id: self.next_holder_htlc_id,
4222 onion_routing_packet,
4224 self.next_holder_htlc_id += 1;
4229 /// Creates a signed commitment transaction to send to the remote peer.
4230 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4231 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4232 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4233 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4234 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4235 panic!("Cannot create commitment tx until channel is fully established");
4237 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4238 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4240 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4241 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4243 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4244 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");
4246 let mut have_updates = self.pending_update_fee.is_some();
4247 for htlc in self.pending_outbound_htlcs.iter() {
4248 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4249 have_updates = true;
4251 if have_updates { break; }
4253 for htlc in self.pending_inbound_htlcs.iter() {
4254 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4255 have_updates = true;
4257 if have_updates { break; }
4260 panic!("Cannot create commitment tx until we have some updates to send");
4262 self.send_commitment_no_status_check(logger)
4264 /// Only fails in case of bad keys
4265 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4266 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4267 // fail to generate this, we still are at least at a position where upgrading their status
4269 for htlc in self.pending_inbound_htlcs.iter_mut() {
4270 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4271 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4273 if let Some(state) = new_state {
4277 for htlc in self.pending_outbound_htlcs.iter_mut() {
4278 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4279 Some(fail_reason.take())
4281 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4284 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4286 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4287 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4288 // Update state now that we've passed all the can-fail calls...
4289 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4290 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4291 (res, counterparty_commitment_tx, htlcs_no_ref)
4293 Err(e) => return Err(e),
4296 self.latest_monitor_update_id += 1;
4297 let monitor_update = ChannelMonitorUpdate {
4298 update_id: self.latest_monitor_update_id,
4299 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4300 commitment_txid: counterparty_commitment_txid,
4301 htlc_outputs: htlcs.clone(),
4302 commitment_number: self.cur_counterparty_commitment_transaction_number,
4303 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4306 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4307 Ok((res, monitor_update))
4310 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4311 /// when we shouldn't change HTLC/channel state.
4312 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4313 let mut feerate_per_kw = self.feerate_per_kw;
4314 if let Some(feerate) = self.pending_update_fee {
4315 if self.is_outbound() {
4316 feerate_per_kw = feerate;
4320 let counterparty_keys = self.build_remote_transaction_keys()?;
4321 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4322 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4323 let (signature, htlc_signatures);
4325 #[cfg(any(test, feature = "fuzztarget"))]
4327 if !self.is_outbound() {
4328 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4329 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4330 if let Some(info) = projected_commit_tx_info {
4331 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4332 if info.total_pending_htlcs == total_pending_htlcs
4333 && info.next_holder_htlc_id == self.next_holder_htlc_id
4334 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4335 && info.feerate == self.feerate_per_kw {
4336 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4337 assert_eq!(actual_fee, info.fee);
4344 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4345 for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4349 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4350 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4352 htlc_signatures = res.1;
4354 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4355 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4356 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4357 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4359 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4360 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4361 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)),
4362 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4363 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4364 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4368 Ok((msgs::CommitmentSigned {
4369 channel_id: self.channel_id,
4372 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4375 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4376 /// to send to the remote peer in one go.
4377 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4379 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 {
4380 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4381 Some(update_add_htlc) => {
4382 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4383 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4389 /// Get forwarding information for the counterparty.
4390 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4391 self.counterparty_forwarding_info.clone()
4394 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4395 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4396 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4398 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4399 fee_base_msat: msg.contents.fee_base_msat,
4400 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4401 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4407 /// Begins the shutdown process, getting a message for the remote peer and returning all
4408 /// holding cell HTLCs for payment failure.
4409 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
4410 for htlc in self.pending_outbound_htlcs.iter() {
4411 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4412 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4415 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4416 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4417 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4419 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4420 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4423 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4424 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4425 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()});
4428 let closing_script = self.get_closing_scriptpubkey();
4430 // From here on out, we may not fail!
4431 if self.channel_state < ChannelState::FundingSent as u32 {
4432 self.channel_state = ChannelState::ShutdownComplete as u32;
4434 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4436 self.update_time_counter += 1;
4438 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4439 // our shutdown until we've committed all of the pending changes.
4440 self.holding_cell_update_fee = None;
4441 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4442 self.holding_cell_htlc_updates.retain(|htlc_update| {
4444 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4445 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4452 Ok((msgs::Shutdown {
4453 channel_id: self.channel_id,
4454 scriptpubkey: closing_script,
4455 }, dropped_outbound_htlcs))
4458 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4459 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4460 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4461 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4462 /// immediately (others we will have to allow to time out).
4463 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4464 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4465 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4466 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4467 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4468 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4470 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4471 // return them to fail the payment.
4472 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4473 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4475 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4476 dropped_outbound_htlcs.push((source, payment_hash));
4481 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4482 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4483 // returning a channel monitor update here would imply a channel monitor update before
4484 // we even registered the channel monitor to begin with, which is invalid.
4485 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4486 // funding transaction, don't return a funding txo (which prevents providing the
4487 // monitor update to the user, even if we return one).
4488 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4489 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4490 self.latest_monitor_update_id += 1;
4491 Some((funding_txo, ChannelMonitorUpdate {
4492 update_id: self.latest_monitor_update_id,
4493 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4498 self.channel_state = ChannelState::ShutdownComplete as u32;
4499 self.update_time_counter += 1;
4500 (monitor_update, dropped_outbound_htlcs)
4504 const SERIALIZATION_VERSION: u8 = 2;
4505 const MIN_SERIALIZATION_VERSION: u8 = 1;
4507 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4513 impl Writeable for ChannelUpdateStatus {
4514 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4515 // We only care about writing out the current state as it was announced, ie only either
4516 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4517 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4519 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4520 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4521 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4522 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4528 impl Readable for ChannelUpdateStatus {
4529 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4530 Ok(match <u8 as Readable>::read(reader)? {
4531 0 => ChannelUpdateStatus::Enabled,
4532 1 => ChannelUpdateStatus::Disabled,
4533 _ => return Err(DecodeError::InvalidValue),
4538 impl<Signer: Sign> Writeable for Channel<Signer> {
4539 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4540 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4543 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4545 self.user_id.write(writer)?;
4547 // Write out the old serialization for the config object. This is read by version-1
4548 // deserializers, but we will read the version in the TLV at the end instead.
4549 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4550 self.config.cltv_expiry_delta.write(writer)?;
4551 self.config.announced_channel.write(writer)?;
4552 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4554 self.channel_id.write(writer)?;
4555 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4556 self.channel_value_satoshis.write(writer)?;
4558 self.latest_monitor_update_id.write(writer)?;
4560 let mut key_data = VecWriter(Vec::new());
4561 self.holder_signer.write(&mut key_data)?;
4562 assert!(key_data.0.len() < core::usize::MAX);
4563 assert!(key_data.0.len() < core::u32::MAX as usize);
4564 (key_data.0.len() as u32).write(writer)?;
4565 writer.write_all(&key_data.0[..])?;
4567 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4568 // deserialized from that format.
4569 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4570 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4571 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4573 self.destination_script.write(writer)?;
4575 self.cur_holder_commitment_transaction_number.write(writer)?;
4576 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4577 self.value_to_self_msat.write(writer)?;
4579 let mut dropped_inbound_htlcs = 0;
4580 for htlc in self.pending_inbound_htlcs.iter() {
4581 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4582 dropped_inbound_htlcs += 1;
4585 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4586 for htlc in self.pending_inbound_htlcs.iter() {
4587 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4590 htlc.htlc_id.write(writer)?;
4591 htlc.amount_msat.write(writer)?;
4592 htlc.cltv_expiry.write(writer)?;
4593 htlc.payment_hash.write(writer)?;
4595 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4596 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4598 htlc_state.write(writer)?;
4600 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4602 htlc_state.write(writer)?;
4604 &InboundHTLCState::Committed => {
4607 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4609 removal_reason.write(writer)?;
4614 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4615 for htlc in self.pending_outbound_htlcs.iter() {
4616 htlc.htlc_id.write(writer)?;
4617 htlc.amount_msat.write(writer)?;
4618 htlc.cltv_expiry.write(writer)?;
4619 htlc.payment_hash.write(writer)?;
4620 htlc.source.write(writer)?;
4622 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4624 onion_packet.write(writer)?;
4626 &OutboundHTLCState::Committed => {
4629 &OutboundHTLCState::RemoteRemoved(_) => {
4630 // Treat this as a Committed because we haven't received the CS - they'll
4631 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
4634 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4636 fail_reason.write(writer)?;
4638 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4640 fail_reason.write(writer)?;
4645 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4646 for update in self.holding_cell_htlc_updates.iter() {
4648 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4650 amount_msat.write(writer)?;
4651 cltv_expiry.write(writer)?;
4652 payment_hash.write(writer)?;
4653 source.write(writer)?;
4654 onion_routing_packet.write(writer)?;
4656 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4658 payment_preimage.write(writer)?;
4659 htlc_id.write(writer)?;
4661 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4663 htlc_id.write(writer)?;
4664 err_packet.write(writer)?;
4669 match self.resend_order {
4670 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4671 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4674 self.monitor_pending_funding_locked.write(writer)?;
4675 self.monitor_pending_revoke_and_ack.write(writer)?;
4676 self.monitor_pending_commitment_signed.write(writer)?;
4678 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4679 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4680 pending_forward.write(writer)?;
4681 htlc_id.write(writer)?;
4684 (self.monitor_pending_failures.len() as u64).write(writer)?;
4685 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4686 htlc_source.write(writer)?;
4687 payment_hash.write(writer)?;
4688 fail_reason.write(writer)?;
4691 self.pending_update_fee.write(writer)?;
4692 self.holding_cell_update_fee.write(writer)?;
4694 self.next_holder_htlc_id.write(writer)?;
4695 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4696 self.update_time_counter.write(writer)?;
4697 self.feerate_per_kw.write(writer)?;
4699 match self.last_sent_closing_fee {
4700 Some((feerate, fee, sig)) => {
4702 feerate.write(writer)?;
4706 None => 0u8.write(writer)?,
4709 self.funding_tx_confirmed_in.write(writer)?;
4710 self.funding_tx_confirmation_height.write(writer)?;
4711 self.short_channel_id.write(writer)?;
4713 self.counterparty_dust_limit_satoshis.write(writer)?;
4714 self.holder_dust_limit_satoshis.write(writer)?;
4715 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4717 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4718 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
4720 self.counterparty_htlc_minimum_msat.write(writer)?;
4721 self.holder_htlc_minimum_msat.write(writer)?;
4722 self.counterparty_max_accepted_htlcs.write(writer)?;
4724 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4725 self.minimum_depth.unwrap_or(0).write(writer)?;
4727 match &self.counterparty_forwarding_info {
4730 info.fee_base_msat.write(writer)?;
4731 info.fee_proportional_millionths.write(writer)?;
4732 info.cltv_expiry_delta.write(writer)?;
4734 None => 0u8.write(writer)?
4737 self.channel_transaction_parameters.write(writer)?;
4738 self.funding_transaction.write(writer)?;
4740 self.counterparty_cur_commitment_point.write(writer)?;
4741 self.counterparty_prev_commitment_point.write(writer)?;
4742 self.counterparty_node_id.write(writer)?;
4744 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4746 self.commitment_secrets.write(writer)?;
4748 self.channel_update_status.write(writer)?;
4750 #[cfg(any(test, feature = "fuzztarget"))]
4751 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
4752 #[cfg(any(test, feature = "fuzztarget"))]
4753 for htlc in self.historical_inbound_htlc_fulfills.iter() {
4754 htlc.write(writer)?;
4757 write_tlv_fields!(writer, {
4758 (0, self.announcement_sigs, option),
4759 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
4760 // default value instead of being Option<>al. Thus, to maintain compatibility we write
4761 // them twice, once with their original default values above, and once as an option
4762 // here. On the read side, old versions will simply ignore the odd-type entries here,
4763 // and new versions map the default values to None and allow the TLV entries here to
4765 (1, self.minimum_depth, option),
4766 (3, self.counterparty_selected_channel_reserve_satoshis, option),
4767 (5, self.config, required),
4768 (7, self.shutdown_scriptpubkey, option),
4775 const MAX_ALLOC_SIZE: usize = 64*1024;
4776 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4777 where K::Target: KeysInterface<Signer = Signer> {
4778 fn read<R : io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4779 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4781 let user_id = Readable::read(reader)?;
4783 let mut config = Some(ChannelConfig::default());
4785 // Read the old serialization of the ChannelConfig from version 0.0.98.
4786 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
4787 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
4788 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
4789 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
4791 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
4792 let mut _val: u64 = Readable::read(reader)?;
4795 let channel_id = Readable::read(reader)?;
4796 let channel_state = Readable::read(reader)?;
4797 let channel_value_satoshis = Readable::read(reader)?;
4799 let latest_monitor_update_id = Readable::read(reader)?;
4801 let keys_len: u32 = Readable::read(reader)?;
4802 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4803 while keys_data.len() != keys_len as usize {
4804 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4805 let mut data = [0; 1024];
4806 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4807 reader.read_exact(read_slice)?;
4808 keys_data.extend_from_slice(read_slice);
4810 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4812 // Read the old serialization for shutdown_pubkey, preferring the TLV field later if set.
4813 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
4814 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
4817 let destination_script = Readable::read(reader)?;
4819 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4820 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4821 let value_to_self_msat = Readable::read(reader)?;
4823 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4824 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4825 for _ in 0..pending_inbound_htlc_count {
4826 pending_inbound_htlcs.push(InboundHTLCOutput {
4827 htlc_id: Readable::read(reader)?,
4828 amount_msat: Readable::read(reader)?,
4829 cltv_expiry: Readable::read(reader)?,
4830 payment_hash: Readable::read(reader)?,
4831 state: match <u8 as Readable>::read(reader)? {
4832 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4833 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4834 3 => InboundHTLCState::Committed,
4835 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4836 _ => return Err(DecodeError::InvalidValue),
4841 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4842 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4843 for _ in 0..pending_outbound_htlc_count {
4844 pending_outbound_htlcs.push(OutboundHTLCOutput {
4845 htlc_id: Readable::read(reader)?,
4846 amount_msat: Readable::read(reader)?,
4847 cltv_expiry: Readable::read(reader)?,
4848 payment_hash: Readable::read(reader)?,
4849 source: Readable::read(reader)?,
4850 state: match <u8 as Readable>::read(reader)? {
4851 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4852 1 => OutboundHTLCState::Committed,
4853 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4854 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4855 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4856 _ => return Err(DecodeError::InvalidValue),
4861 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4862 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4863 for _ in 0..holding_cell_htlc_update_count {
4864 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4865 0 => HTLCUpdateAwaitingACK::AddHTLC {
4866 amount_msat: Readable::read(reader)?,
4867 cltv_expiry: Readable::read(reader)?,
4868 payment_hash: Readable::read(reader)?,
4869 source: Readable::read(reader)?,
4870 onion_routing_packet: Readable::read(reader)?,
4872 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4873 payment_preimage: Readable::read(reader)?,
4874 htlc_id: Readable::read(reader)?,
4876 2 => HTLCUpdateAwaitingACK::FailHTLC {
4877 htlc_id: Readable::read(reader)?,
4878 err_packet: Readable::read(reader)?,
4880 _ => return Err(DecodeError::InvalidValue),
4884 let resend_order = match <u8 as Readable>::read(reader)? {
4885 0 => RAACommitmentOrder::CommitmentFirst,
4886 1 => RAACommitmentOrder::RevokeAndACKFirst,
4887 _ => return Err(DecodeError::InvalidValue),
4890 let monitor_pending_funding_locked = Readable::read(reader)?;
4891 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4892 let monitor_pending_commitment_signed = Readable::read(reader)?;
4894 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4895 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4896 for _ in 0..monitor_pending_forwards_count {
4897 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4900 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4901 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4902 for _ in 0..monitor_pending_failures_count {
4903 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4906 let pending_update_fee = Readable::read(reader)?;
4907 let holding_cell_update_fee = Readable::read(reader)?;
4909 let next_holder_htlc_id = Readable::read(reader)?;
4910 let next_counterparty_htlc_id = Readable::read(reader)?;
4911 let update_time_counter = Readable::read(reader)?;
4912 let feerate_per_kw = Readable::read(reader)?;
4914 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4916 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4917 _ => return Err(DecodeError::InvalidValue),
4920 let funding_tx_confirmed_in = Readable::read(reader)?;
4921 let funding_tx_confirmation_height = Readable::read(reader)?;
4922 let short_channel_id = Readable::read(reader)?;
4924 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4925 let holder_dust_limit_satoshis = Readable::read(reader)?;
4926 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4927 let mut counterparty_selected_channel_reserve_satoshis = None;
4929 // Read the old serialization from version 0.0.98.
4930 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
4932 // Read the 8 bytes of backwards-compatibility data.
4933 let _dummy: u64 = Readable::read(reader)?;
4935 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4936 let holder_htlc_minimum_msat = Readable::read(reader)?;
4937 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4939 let mut minimum_depth = None;
4941 // Read the old serialization from version 0.0.98.
4942 minimum_depth = Some(Readable::read(reader)?);
4944 // Read the 4 bytes of backwards-compatibility data.
4945 let _dummy: u32 = Readable::read(reader)?;
4948 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
4950 1 => Some(CounterpartyForwardingInfo {
4951 fee_base_msat: Readable::read(reader)?,
4952 fee_proportional_millionths: Readable::read(reader)?,
4953 cltv_expiry_delta: Readable::read(reader)?,
4955 _ => return Err(DecodeError::InvalidValue),
4958 let channel_parameters = Readable::read(reader)?;
4959 let funding_transaction = Readable::read(reader)?;
4961 let counterparty_cur_commitment_point = Readable::read(reader)?;
4963 let counterparty_prev_commitment_point = Readable::read(reader)?;
4964 let counterparty_node_id = Readable::read(reader)?;
4966 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
4967 let commitment_secrets = Readable::read(reader)?;
4969 let channel_update_status = Readable::read(reader)?;
4971 #[cfg(any(test, feature = "fuzztarget"))]
4972 let mut historical_inbound_htlc_fulfills = HashSet::new();
4973 #[cfg(any(test, feature = "fuzztarget"))]
4975 let htlc_fulfills_len: u64 = Readable::read(reader)?;
4976 for _ in 0..htlc_fulfills_len {
4977 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
4981 let mut announcement_sigs = None;
4982 read_tlv_fields!(reader, {
4983 (0, announcement_sigs, option),
4984 (1, minimum_depth, option),
4985 (3, counterparty_selected_channel_reserve_satoshis, option),
4986 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
4987 (7, shutdown_scriptpubkey, option),
4990 let mut secp_ctx = Secp256k1::new();
4991 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
4996 config: config.unwrap(),
5000 channel_value_satoshis,
5002 latest_monitor_update_id,
5005 shutdown_scriptpubkey,
5008 cur_holder_commitment_transaction_number,
5009 cur_counterparty_commitment_transaction_number,
5012 pending_inbound_htlcs,
5013 pending_outbound_htlcs,
5014 holding_cell_htlc_updates,
5018 monitor_pending_funding_locked,
5019 monitor_pending_revoke_and_ack,
5020 monitor_pending_commitment_signed,
5021 monitor_pending_forwards,
5022 monitor_pending_failures,
5025 holding_cell_update_fee,
5026 next_holder_htlc_id,
5027 next_counterparty_htlc_id,
5028 update_time_counter,
5031 #[cfg(debug_assertions)]
5032 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5033 #[cfg(debug_assertions)]
5034 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5036 last_sent_closing_fee,
5038 funding_tx_confirmed_in,
5039 funding_tx_confirmation_height,
5042 counterparty_dust_limit_satoshis,
5043 holder_dust_limit_satoshis,
5044 counterparty_max_htlc_value_in_flight_msat,
5045 counterparty_selected_channel_reserve_satoshis,
5046 counterparty_htlc_minimum_msat,
5047 holder_htlc_minimum_msat,
5048 counterparty_max_accepted_htlcs,
5051 counterparty_forwarding_info,
5053 channel_transaction_parameters: channel_parameters,
5054 funding_transaction,
5056 counterparty_cur_commitment_point,
5057 counterparty_prev_commitment_point,
5058 counterparty_node_id,
5060 counterparty_shutdown_scriptpubkey,
5064 channel_update_status,
5068 #[cfg(any(test, feature = "fuzztarget"))]
5069 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5070 #[cfg(any(test, feature = "fuzztarget"))]
5071 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5073 workaround_lnd_bug_4006: None,
5075 #[cfg(any(test, feature = "fuzztarget"))]
5076 historical_inbound_htlc_fulfills,
5083 use bitcoin::util::bip143;
5084 use bitcoin::consensus::encode::serialize;
5085 use bitcoin::blockdata::script::{Script, Builder};
5086 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5087 use bitcoin::blockdata::constants::genesis_block;
5088 use bitcoin::blockdata::opcodes;
5089 use bitcoin::network::constants::Network;
5090 use bitcoin::hashes::hex::FromHex;
5092 use ln::{PaymentPreimage, PaymentHash};
5093 use ln::channelmanager::HTLCSource;
5094 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5095 use ln::channel::MAX_FUNDING_SATOSHIS;
5096 use ln::features::InitFeatures;
5097 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5098 use ln::script::ShutdownScript;
5100 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5101 use chain::BestBlock;
5102 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5103 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5104 use chain::transaction::OutPoint;
5105 use util::config::UserConfig;
5106 use util::enforcing_trait_impls::EnforcingSigner;
5107 use util::test_utils;
5108 use util::logger::Logger;
5109 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5110 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5111 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5112 use bitcoin::secp256k1::recovery::RecoverableSignature;
5113 use bitcoin::hashes::sha256::Hash as Sha256;
5114 use bitcoin::hashes::Hash;
5115 use bitcoin::hash_types::{Txid, WPubkeyHash};
5119 struct TestFeeEstimator {
5122 impl FeeEstimator for TestFeeEstimator {
5123 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5129 fn test_max_funding_satoshis() {
5130 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5131 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5135 signer: InMemorySigner,
5137 impl KeysInterface for Keys {
5138 type Signer = InMemorySigner;
5140 fn get_node_secret(&self) -> SecretKey { panic!(); }
5141 fn get_destination_script(&self) -> Script {
5142 let secp_ctx = Secp256k1::signing_only();
5143 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5144 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5145 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5148 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5149 let secp_ctx = Secp256k1::signing_only();
5150 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5151 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5154 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5157 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5158 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5159 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5162 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5163 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5166 // Check that, during channel creation, we use the same feerate in the open channel message
5167 // as we do in the Channel object creation itself.
5169 fn test_open_channel_msg_fee() {
5170 let original_fee = 253;
5171 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5172 let secp_ctx = Secp256k1::new();
5173 let seed = [42; 32];
5174 let network = Network::Testnet;
5175 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5177 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5178 let config = UserConfig::default();
5179 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
5181 // Now change the fee so we can check that the fee in the open_channel message is the
5182 // same as the old fee.
5183 fee_est.fee_est = 500;
5184 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5185 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5189 fn test_holder_vs_counterparty_dust_limit() {
5190 // Test that when calculating the local and remote commitment transaction fees, the correct
5191 // dust limits are used.
5192 let feeest = TestFeeEstimator{fee_est: 15000};
5193 let secp_ctx = Secp256k1::new();
5194 let seed = [42; 32];
5195 let network = Network::Testnet;
5196 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5198 // Go through the flow of opening a channel between two nodes, making sure
5199 // they have different dust limits.
5201 // Create Node A's channel pointing to Node B's pubkey
5202 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5203 let config = UserConfig::default();
5204 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5206 // Create Node B's channel by receiving Node A's open_channel message
5207 // Make sure A's dust limit is as we expect.
5208 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5209 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5210 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5212 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5213 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5214 accept_channel_msg.dust_limit_satoshis = 546;
5215 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5216 node_a_chan.holder_dust_limit_satoshis = 1560;
5218 // Put some inbound and outbound HTLCs in A's channel.
5219 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5220 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5222 amount_msat: htlc_amount_msat,
5223 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5224 cltv_expiry: 300000000,
5225 state: InboundHTLCState::Committed,
5228 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5230 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5231 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5232 cltv_expiry: 200000000,
5233 state: OutboundHTLCState::Committed,
5234 source: HTLCSource::OutboundRoute {
5236 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5237 first_hop_htlc_msat: 548,
5241 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5242 // the dust limit check.
5243 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5244 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5245 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5246 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5248 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5249 // of the HTLCs are seen to be above the dust limit.
5250 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5251 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5252 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5253 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5254 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5258 fn test_timeout_vs_success_htlc_dust_limit() {
5259 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5260 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5261 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5262 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5263 let fee_est = TestFeeEstimator{fee_est: 253 };
5264 let secp_ctx = Secp256k1::new();
5265 let seed = [42; 32];
5266 let network = Network::Testnet;
5267 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5269 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5270 let config = UserConfig::default();
5271 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, 10000000, 100000, 42, &config).unwrap();
5273 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5274 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5276 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5277 // counted as dust when it shouldn't be.
5278 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5279 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5280 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5281 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5283 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5284 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5285 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5286 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5287 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5289 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5291 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5292 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5293 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5294 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5295 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5297 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5298 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5299 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5300 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5301 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5305 fn channel_reestablish_no_updates() {
5306 let feeest = TestFeeEstimator{fee_est: 15000};
5307 let logger = test_utils::TestLogger::new();
5308 let secp_ctx = Secp256k1::new();
5309 let seed = [42; 32];
5310 let network = Network::Testnet;
5311 let best_block = BestBlock::from_genesis(network);
5312 let chain_hash = best_block.block_hash();
5313 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5315 // Go through the flow of opening a channel between two nodes.
5317 // Create Node A's channel pointing to Node B's pubkey
5318 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5319 let config = UserConfig::default();
5320 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5322 // Create Node B's channel by receiving Node A's open_channel message
5323 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5324 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5325 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();
5327 // Node B --> Node A: accept channel
5328 let accept_channel_msg = node_b_chan.get_accept_channel();
5329 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5331 // Node A --> Node B: funding created
5332 let output_script = node_a_chan.get_funding_redeemscript();
5333 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5334 value: 10000000, script_pubkey: output_script.clone(),
5336 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5337 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5338 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5340 // Node B --> Node A: funding signed
5341 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5343 // Now disconnect the two nodes and check that the commitment point in
5344 // Node B's channel_reestablish message is sane.
5345 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5346 let msg = node_b_chan.get_channel_reestablish(&&logger);
5347 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5348 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5349 match msg.data_loss_protect {
5350 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5351 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5356 // Check that the commitment point in Node A's channel_reestablish message
5358 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5359 let msg = node_a_chan.get_channel_reestablish(&&logger);
5360 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5361 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5362 match msg.data_loss_protect {
5363 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5364 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5371 fn channel_update() {
5372 let feeest = TestFeeEstimator{fee_est: 15000};
5373 let secp_ctx = Secp256k1::new();
5374 let seed = [42; 32];
5375 let network = Network::Testnet;
5376 let chain_hash = genesis_block(network).header.block_hash();
5377 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5379 // Create a channel.
5380 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5381 let config = UserConfig::default();
5382 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5383 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5384 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5385 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5387 // Make sure that receiving a channel update will update the Channel as expected.
5388 let update = ChannelUpdate {
5389 contents: UnsignedChannelUpdate {
5391 short_channel_id: 0,
5394 cltv_expiry_delta: 100,
5395 htlc_minimum_msat: 5,
5396 htlc_maximum_msat: OptionalField::Absent,
5398 fee_proportional_millionths: 11,
5399 excess_data: Vec::new(),
5401 signature: Signature::from(unsafe { FFISignature::new() })
5403 node_a_chan.channel_update(&update).unwrap();
5405 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5406 // change our official htlc_minimum_msat.
5407 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5408 match node_a_chan.counterparty_forwarding_info() {
5410 assert_eq!(info.cltv_expiry_delta, 100);
5411 assert_eq!(info.fee_base_msat, 110);
5412 assert_eq!(info.fee_proportional_millionths, 11);
5414 None => panic!("expected counterparty forwarding info to be Some")
5419 fn outbound_commitment_test() {
5420 // Test vectors from BOLT 3 Appendix C:
5421 let feeest = TestFeeEstimator{fee_est: 15000};
5422 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5423 let secp_ctx = Secp256k1::new();
5425 let mut signer = InMemorySigner::new(
5427 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5428 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5429 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5430 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5431 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5433 // These aren't set in the test vectors:
5434 [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],
5439 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5440 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5441 let keys_provider = Keys { signer: signer.clone() };
5443 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5444 let mut config = UserConfig::default();
5445 config.channel_options.announced_channel = false;
5446 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
5447 chan.holder_dust_limit_satoshis = 546;
5448 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5450 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5452 let counterparty_pubkeys = ChannelPublicKeys {
5453 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5454 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5455 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5456 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5457 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5459 chan.channel_transaction_parameters.counterparty_parameters = Some(
5460 CounterpartyChannelTransactionParameters {
5461 pubkeys: counterparty_pubkeys.clone(),
5462 selected_contest_delay: 144
5464 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5465 signer.ready_channel(&chan.channel_transaction_parameters);
5467 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5468 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5470 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5471 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5473 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5474 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5476 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5477 // derived from a commitment_seed, so instead we copy it here and call
5478 // build_commitment_transaction.
5479 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5480 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5481 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5482 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5483 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5485 macro_rules! test_commitment {
5486 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5487 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5489 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5490 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5492 let htlcs = res.2.drain(..)
5493 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5497 let trusted_tx = commitment_tx.trust();
5498 let unsigned_tx = trusted_tx.built_transaction();
5499 let redeemscript = chan.get_funding_redeemscript();
5500 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5501 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5502 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5504 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5505 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5506 let mut counterparty_htlc_sigs = Vec::new();
5507 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5509 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5510 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5511 counterparty_htlc_sigs.push(remote_signature);
5513 assert_eq!(htlcs.len(), per_htlc.len());
5515 let holder_commitment_tx = HolderCommitmentTransaction::new(
5516 commitment_tx.clone(),
5517 counterparty_signature,
5518 counterparty_htlc_sigs,
5519 &chan.holder_signer.pubkeys().funding_pubkey,
5520 chan.counterparty_funding_pubkey()
5522 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5523 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5525 let funding_redeemscript = chan.get_funding_redeemscript();
5526 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5527 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5529 // ((htlc, counterparty_sig), (index, holder_sig))
5530 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5533 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5535 let ref htlc = htlcs[$htlc_idx];
5536 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5537 chan.get_counterparty_selected_contest_delay().unwrap(),
5538 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5539 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5540 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5541 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5543 let mut preimage: Option<PaymentPreimage> = None;
5546 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5547 if out == htlc.payment_hash {
5548 preimage = Some(PaymentPreimage([i; 32]));
5552 assert!(preimage.is_some());
5555 let htlc_sig = htlc_sig_iter.next().unwrap();
5556 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5558 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5559 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5560 let index = (htlc_sig.1).0;
5561 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5562 let trusted_tx = holder_commitment_tx.trust();
5563 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5564 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5566 assert!(htlc_sig_iter.next().is_none());
5570 // simple commitment tx with no HTLCs
5571 chan.value_to_self_msat = 7000000000;
5573 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5574 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5575 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5577 chan.pending_inbound_htlcs.push({
5578 let mut out = InboundHTLCOutput{
5580 amount_msat: 1000000,
5582 payment_hash: PaymentHash([0; 32]),
5583 state: InboundHTLCState::Committed,
5585 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5588 chan.pending_inbound_htlcs.push({
5589 let mut out = InboundHTLCOutput{
5591 amount_msat: 2000000,
5593 payment_hash: PaymentHash([0; 32]),
5594 state: InboundHTLCState::Committed,
5596 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5599 chan.pending_outbound_htlcs.push({
5600 let mut out = OutboundHTLCOutput{
5602 amount_msat: 2000000,
5604 payment_hash: PaymentHash([0; 32]),
5605 state: OutboundHTLCState::Committed,
5606 source: HTLCSource::dummy(),
5608 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5611 chan.pending_outbound_htlcs.push({
5612 let mut out = OutboundHTLCOutput{
5614 amount_msat: 3000000,
5616 payment_hash: PaymentHash([0; 32]),
5617 state: OutboundHTLCState::Committed,
5618 source: HTLCSource::dummy(),
5620 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5623 chan.pending_inbound_htlcs.push({
5624 let mut out = InboundHTLCOutput{
5626 amount_msat: 4000000,
5628 payment_hash: PaymentHash([0; 32]),
5629 state: InboundHTLCState::Committed,
5631 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5635 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5636 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5637 chan.feerate_per_kw = 0;
5639 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5640 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5641 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5644 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5645 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5646 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5649 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5650 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5651 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5654 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5655 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5656 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5659 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5660 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5661 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5664 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5665 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5666 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5669 // commitment tx with seven outputs untrimmed (maximum feerate)
5670 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5671 chan.feerate_per_kw = 647;
5673 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5674 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5675 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5678 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5679 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5680 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5683 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5684 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5685 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5688 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5689 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5690 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5693 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5694 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5695 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5698 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5699 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5700 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5703 // commitment tx with six outputs untrimmed (minimum feerate)
5704 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5705 chan.feerate_per_kw = 648;
5707 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5708 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5709 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5712 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5713 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5714 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5717 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5718 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5719 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5722 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5723 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5724 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5727 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5728 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5729 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5732 // commitment tx with six outputs untrimmed (maximum feerate)
5733 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5734 chan.feerate_per_kw = 2069;
5736 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5737 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5738 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5741 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5742 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5743 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5746 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5747 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5748 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5751 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5752 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5753 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5756 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5757 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5758 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5761 // commitment tx with five outputs untrimmed (minimum feerate)
5762 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5763 chan.feerate_per_kw = 2070;
5765 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5766 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5767 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5770 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5771 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5772 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5775 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5776 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5777 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5780 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5781 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5782 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5785 // commitment tx with five outputs untrimmed (maximum feerate)
5786 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5787 chan.feerate_per_kw = 2194;
5789 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5790 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5791 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5794 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5795 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5796 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5799 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5800 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5801 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5804 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5805 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5806 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5809 // commitment tx with four outputs untrimmed (minimum feerate)
5810 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5811 chan.feerate_per_kw = 2195;
5813 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5814 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5815 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5818 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5819 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5820 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5823 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5824 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5825 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5828 // commitment tx with four outputs untrimmed (maximum feerate)
5829 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5830 chan.feerate_per_kw = 3702;
5832 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5833 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5834 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5837 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5838 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5839 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5842 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5843 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5844 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5847 // commitment tx with three outputs untrimmed (minimum feerate)
5848 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5849 chan.feerate_per_kw = 3703;
5851 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5852 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5853 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5856 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5857 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5858 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5861 // commitment tx with three outputs untrimmed (maximum feerate)
5862 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5863 chan.feerate_per_kw = 4914;
5865 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5866 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5867 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5870 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5871 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5872 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5875 // commitment tx with two outputs untrimmed (minimum feerate)
5876 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5877 chan.feerate_per_kw = 4915;
5879 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5880 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5881 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5883 // commitment tx with two outputs untrimmed (maximum feerate)
5884 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5885 chan.feerate_per_kw = 9651180;
5887 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5888 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5889 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5891 // commitment tx with one output untrimmed (minimum feerate)
5892 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5893 chan.feerate_per_kw = 9651181;
5895 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5896 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5897 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5899 // commitment tx with fee greater than funder amount
5900 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5901 chan.feerate_per_kw = 9651936;
5903 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5904 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5905 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5907 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5908 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5909 chan.feerate_per_kw = 253;
5910 chan.pending_inbound_htlcs.clear();
5911 chan.pending_inbound_htlcs.push({
5912 let mut out = InboundHTLCOutput{
5914 amount_msat: 2000000,
5916 payment_hash: PaymentHash([0; 32]),
5917 state: InboundHTLCState::Committed,
5919 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5922 chan.pending_outbound_htlcs.clear();
5923 chan.pending_outbound_htlcs.push({
5924 let mut out = OutboundHTLCOutput{
5926 amount_msat: 5000000,
5928 payment_hash: PaymentHash([0; 32]),
5929 state: OutboundHTLCState::Committed,
5930 source: HTLCSource::dummy(),
5932 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5935 chan.pending_outbound_htlcs.push({
5936 let mut out = OutboundHTLCOutput{
5938 amount_msat: 5000000,
5940 payment_hash: PaymentHash([0; 32]),
5941 state: OutboundHTLCState::Committed,
5942 source: HTLCSource::dummy(),
5944 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5948 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
5949 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
5950 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5953 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
5954 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
5955 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5957 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
5958 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
5959 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
5961 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
5962 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
5963 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
5968 fn test_per_commitment_secret_gen() {
5969 // Test vectors from BOLT 3 Appendix D:
5971 let mut seed = [0; 32];
5972 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5973 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5974 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5976 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5977 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5978 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5980 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5981 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5983 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5984 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5986 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5987 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5988 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5992 fn test_key_derivation() {
5993 // Test vectors from BOLT 3 Appendix E:
5994 let secp_ctx = Secp256k1::new();
5996 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5997 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5999 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6000 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6002 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6003 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6005 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6006 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6008 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6009 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6011 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6012 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6014 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6015 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());