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;
46 use core::{cmp,mem,fmt};
47 use core::convert::TryFrom;
49 #[cfg(any(test, feature = "fuzztarget", debug_assertions))]
51 use bitcoin::hashes::hex::ToHex;
54 pub struct ChannelValueStat {
55 pub value_to_self_msat: u64,
56 pub channel_value_msat: u64,
57 pub channel_reserve_msat: u64,
58 pub pending_outbound_htlcs_amount_msat: u64,
59 pub pending_inbound_htlcs_amount_msat: u64,
60 pub holding_cell_outbound_amount_msat: u64,
61 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
62 pub counterparty_dust_limit_msat: u64,
65 enum InboundHTLCRemovalReason {
66 FailRelay(msgs::OnionErrorPacket),
67 FailMalformed(([u8; 32], u16)),
68 Fulfill(PaymentPreimage),
71 enum InboundHTLCState {
72 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
73 /// update_add_htlc message for this HTLC.
74 RemoteAnnounced(PendingHTLCStatus),
75 /// Included in a received commitment_signed message (implying we've
76 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
77 /// state (see the example below). We have not yet included this HTLC in a
78 /// commitment_signed message because we are waiting on the remote's
79 /// aforementioned state revocation. One reason this missing remote RAA
80 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
81 /// is because every time we create a new "state", i.e. every time we sign a
82 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
83 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
84 /// sent provided the per_commitment_point for our current commitment tx.
85 /// The other reason we should not send a commitment_signed without their RAA
86 /// is because their RAA serves to ACK our previous commitment_signed.
88 /// Here's an example of how an HTLC could come to be in this state:
89 /// remote --> update_add_htlc(prev_htlc) --> local
90 /// remote --> commitment_signed(prev_htlc) --> local
91 /// remote <-- revoke_and_ack <-- local
92 /// remote <-- commitment_signed(prev_htlc) <-- local
93 /// [note that here, the remote does not respond with a RAA]
94 /// remote --> update_add_htlc(this_htlc) --> local
95 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
96 /// Now `this_htlc` will be assigned this state. It's unable to be officially
97 /// accepted, i.e. included in a commitment_signed, because we're missing the
98 /// RAA that provides our next per_commitment_point. The per_commitment_point
99 /// is used to derive commitment keys, which are used to construct the
100 /// signatures in a commitment_signed message.
101 /// Implies AwaitingRemoteRevoke.
103 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
104 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
105 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
106 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
107 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
108 /// channel (before it can then get forwarded and/or removed).
109 /// Implies AwaitingRemoteRevoke.
110 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
112 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
113 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
115 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
116 /// commitment transaction without it as otherwise we'll have to force-close the channel to
117 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
118 /// anyway). That said, ChannelMonitor does this for us (see
119 /// ChannelMonitor::should_broadcast_holder_commitment_txn) so we actually remove the HTLC from
120 /// our own local state before then, once we're sure that the next commitment_signed and
121 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
122 LocalRemoved(InboundHTLCRemovalReason),
125 struct InboundHTLCOutput {
129 payment_hash: PaymentHash,
130 state: InboundHTLCState,
133 enum OutboundHTLCState {
134 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
135 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
136 /// we will promote to Committed (note that they may not accept it until the next time we
137 /// revoke, but we don't really care about that:
138 /// * they've revoked, so worst case we can announce an old state and get our (option on)
139 /// money back (though we won't), and,
140 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
141 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
142 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
143 /// we'll never get out of sync).
144 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
145 /// OutboundHTLCOutput's size just for a temporary bit
146 LocalAnnounced(Box<msgs::OnionPacket>),
148 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
149 /// the change (though they'll need to revoke before we fail the payment).
150 RemoteRemoved(Option<HTLCFailReason>),
151 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
152 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
153 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
154 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
155 /// remote revoke_and_ack on a previous state before we can do so.
156 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
157 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
158 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
159 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
160 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
161 /// revoke_and_ack to drop completely.
162 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
165 struct OutboundHTLCOutput {
169 payment_hash: PaymentHash,
170 state: OutboundHTLCState,
174 /// See AwaitingRemoteRevoke ChannelState for more info
175 enum HTLCUpdateAwaitingACK {
176 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
180 payment_hash: PaymentHash,
182 onion_routing_packet: msgs::OnionPacket,
185 payment_preimage: PaymentPreimage,
190 err_packet: msgs::OnionErrorPacket,
194 /// There are a few "states" and then a number of flags which can be applied:
195 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
196 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
197 /// move on to ChannelFunded.
198 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
199 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
200 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
202 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
203 OurInitSent = 1 << 0,
204 /// Implies we have received their open_channel/accept_channel message
205 TheirInitSent = 1 << 1,
206 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
207 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
208 /// upon receipt of funding_created, so simply skip this state.
210 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
211 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
212 /// and our counterparty consider the funding transaction confirmed.
214 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
215 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
216 TheirFundingLocked = 1 << 4,
217 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
218 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
219 OurFundingLocked = 1 << 5,
221 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
222 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
224 PeerDisconnected = 1 << 7,
225 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
226 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
227 /// outbound messages until they've managed to do so.
228 MonitorUpdateFailed = 1 << 8,
229 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
230 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
231 /// messages as then we will be unable to determine which HTLCs they included in their
232 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
234 /// Flag is set on ChannelFunded.
235 AwaitingRemoteRevoke = 1 << 9,
236 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
237 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
238 /// to respond with our own shutdown message when possible.
239 RemoteShutdownSent = 1 << 10,
240 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
241 /// point, we may not add any new HTLCs to the channel.
242 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
243 /// us their shutdown.
244 LocalShutdownSent = 1 << 11,
245 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
246 /// to drop us, but we store this anyway.
247 ShutdownComplete = 4096,
249 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
250 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
252 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
254 /// The "channel disabled" bit in channel_update must be set based on whether we are connected to
255 /// our counterparty or not. However, we don't want to announce updates right away to avoid
256 /// spamming the network with updates if the connection is flapping. Instead, we "stage" updates to
257 /// our channel_update message and track the current state here.
258 /// See implementation at [`super::channelmanager::ChannelManager::timer_tick_occurred`].
259 #[derive(Clone, Copy, PartialEq)]
260 pub(super) enum ChannelUpdateStatus {
261 /// We've announced the channel as enabled and are connected to our peer.
263 /// Our channel is no longer live, but we haven't announced the channel as disabled yet.
265 /// Our channel is live again, but we haven't announced the channel as enabled yet.
267 /// We've announced the channel as disabled.
271 /// An enum indicating whether the local or remote side offered a given HTLC.
277 /// Used when calculating whether we or the remote can afford an additional HTLC.
278 struct HTLCCandidate {
280 origin: HTLCInitiator,
284 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
292 /// Information needed for constructing an invoice route hint for this channel.
293 #[derive(Clone, Debug, PartialEq)]
294 pub struct CounterpartyForwardingInfo {
295 /// Base routing fee in millisatoshis.
296 pub fee_base_msat: u32,
297 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
298 pub fee_proportional_millionths: u32,
299 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
300 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
301 /// `cltv_expiry_delta` for more details.
302 pub cltv_expiry_delta: u16,
305 /// A return value enum for get_update_fulfill_htlc. See UpdateFulfillCommitFetch variants for
307 enum UpdateFulfillFetch {
309 monitor_update: ChannelMonitorUpdate,
310 msg: Option<msgs::UpdateFulfillHTLC>,
315 /// The return type of get_update_fulfill_htlc_and_commit.
316 pub enum UpdateFulfillCommitFetch {
317 /// Indicates the HTLC fulfill is new, and either generated an update_fulfill message, placed
318 /// it in the holding cell, or re-generated the update_fulfill message after the same claim was
319 /// previously placed in the holding cell (and has since been removed).
321 /// The ChannelMonitorUpdate which places the new payment preimage in the channel monitor
322 monitor_update: ChannelMonitorUpdate,
323 /// The update_fulfill message and commitment_signed message (if the claim was not placed
324 /// in the holding cell).
325 msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>,
327 /// Indicates the HTLC fulfill is duplicative and already existed either in the holding cell
328 /// or has been forgotten (presumably previously claimed).
332 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
333 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
334 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
337 // Holder designates channel data owned for the benefice of the user client.
338 // Counterparty designates channel data owned by the another channel participant entity.
339 pub(super) struct Channel<Signer: Sign> {
340 config: ChannelConfig,
344 channel_id: [u8; 32],
346 secp_ctx: Secp256k1<secp256k1::All>,
347 channel_value_satoshis: u64,
349 latest_monitor_update_id: u64,
351 holder_signer: Signer,
352 shutdown_scriptpubkey: Option<ShutdownScript>,
353 destination_script: Script,
355 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
356 // generation start at 0 and count up...this simplifies some parts of implementation at the
357 // cost of others, but should really just be changed.
359 cur_holder_commitment_transaction_number: u64,
360 cur_counterparty_commitment_transaction_number: u64,
361 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
362 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
363 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
364 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
366 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
367 /// need to ensure we resend them in the order we originally generated them. Note that because
368 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
369 /// sufficient to simply set this to the opposite of any message we are generating as we
370 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
371 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
373 resend_order: RAACommitmentOrder,
375 monitor_pending_funding_locked: bool,
376 monitor_pending_revoke_and_ack: bool,
377 monitor_pending_commitment_signed: bool,
378 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
379 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
381 // pending_update_fee is filled when sending and receiving update_fee
382 // For outbound channel, feerate_per_kw is updated with the value from
383 // pending_update_fee when revoke_and_ack is received
385 // For inbound channel, feerate_per_kw is updated when it receives
386 // commitment_signed and revoke_and_ack is generated
387 // The pending value is kept when another pair of update_fee and commitment_signed
388 // is received during AwaitingRemoteRevoke and relieved when the expected
389 // revoke_and_ack is received and new commitment_signed is generated to be
390 // sent to the funder. Otherwise, the pending value is removed when receiving
391 // commitment_signed.
392 pending_update_fee: Option<u32>,
393 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
394 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
395 // is received. holding_cell_update_fee is updated when there are additional
396 // update_fee() during ChannelState::AwaitingRemoteRevoke.
397 holding_cell_update_fee: Option<u32>,
398 next_holder_htlc_id: u64,
399 next_counterparty_htlc_id: u64,
400 update_time_counter: u32,
403 #[cfg(debug_assertions)]
404 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
405 holder_max_commitment_tx_output: Mutex<(u64, u64)>,
406 #[cfg(debug_assertions)]
407 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
408 counterparty_max_commitment_tx_output: Mutex<(u64, u64)>,
410 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
412 /// The hash of the block in which the funding transaction was included.
413 funding_tx_confirmed_in: Option<BlockHash>,
414 funding_tx_confirmation_height: u32,
415 short_channel_id: Option<u64>,
417 counterparty_dust_limit_satoshis: u64,
419 pub(super) holder_dust_limit_satoshis: u64,
421 holder_dust_limit_satoshis: u64,
423 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
425 counterparty_max_htlc_value_in_flight_msat: u64,
426 //get_holder_max_htlc_value_in_flight_msat(): u64,
427 /// minimum channel reserve for self to maintain - set by them.
428 counterparty_selected_channel_reserve_satoshis: Option<u64>,
429 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
430 counterparty_htlc_minimum_msat: u64,
431 holder_htlc_minimum_msat: u64,
433 pub counterparty_max_accepted_htlcs: u16,
435 counterparty_max_accepted_htlcs: u16,
436 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
437 minimum_depth: Option<u32>,
439 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
441 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
442 funding_transaction: Option<Transaction>,
444 counterparty_cur_commitment_point: Option<PublicKey>,
445 counterparty_prev_commitment_point: Option<PublicKey>,
446 counterparty_node_id: PublicKey,
448 counterparty_shutdown_scriptpubkey: Option<Script>,
450 commitment_secrets: CounterpartyCommitmentSecrets,
452 channel_update_status: ChannelUpdateStatus,
454 /// Our counterparty's channel_announcement signatures provided in announcement_signatures.
455 /// This can be used to rebroadcast the channel_announcement message later.
456 announcement_sigs: Option<(Signature, Signature)>,
458 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
459 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
460 // be, by comparing the cached values to the fee of the tranaction generated by
461 // `build_commitment_transaction`.
462 #[cfg(any(test, feature = "fuzztarget"))]
463 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
464 #[cfg(any(test, feature = "fuzztarget"))]
465 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
467 /// lnd has a long-standing bug where, upon reconnection, if the channel is not yet confirmed
468 /// they will not send a channel_reestablish until the channel locks in. Then, they will send a
469 /// funding_locked *before* sending the channel_reestablish (which is clearly a violation of
470 /// the BOLT specs). We copy c-lightning's workaround here and simply store the funding_locked
471 /// message until we receive a channel_reestablish.
473 /// See-also <https://github.com/lightningnetwork/lnd/issues/4006>
474 pub workaround_lnd_bug_4006: Option<msgs::FundingLocked>,
476 #[cfg(any(test, feature = "fuzztarget"))]
477 // When we receive an HTLC fulfill on an outbound path, we may immediately fulfill the
478 // corresponding HTLC on the inbound path. If, then, the outbound path channel is
479 // disconnected and reconnected (before we've exchange commitment_signed and revoke_and_ack
480 // messages), they may re-broadcast their update_fulfill_htlc, causing a duplicate claim. This
481 // is fine, but as a sanity check in our failure to generate the second claim, we check here
482 // that the original was a claim, and that we aren't now trying to fulfill a failed HTLC.
483 historical_inbound_htlc_fulfills: HashSet<u64>,
486 #[cfg(any(test, feature = "fuzztarget"))]
487 struct CommitmentTxInfoCached {
489 total_pending_htlcs: usize,
490 next_holder_htlc_id: u64,
491 next_counterparty_htlc_id: u64,
495 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
498 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
500 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
502 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
504 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
506 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
508 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
510 /// Maximum counterparty `dust_limit_satoshis` allowed. 2 * standard dust threshold on p2wsh output
511 /// Scales up on Bitcoin Core's proceeding policy with dust outputs. A typical p2wsh output is 43
512 /// bytes to which Core's `GetDustThreshold()` sums up a minimal spend of 67 bytes (even if
513 /// a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee` is set to 3000sat/kb, thus
514 /// 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs are p2wsh, a value of
515 /// 330 sats is the lower bound desired to ensure good propagation of transactions. We give a bit
516 /// of margin to our counterparty and pick up 660 satoshis as an accepted `dust_limit_satoshis`
517 /// upper bound to avoid negotiation conflicts with other implementations.
518 pub const MAX_DUST_LIMIT_SATOSHIS: u64 = 2 * 330;
520 /// A typical p2wsh output is 43 bytes to which Core's `GetDustThreshold()` sums up a minimal
521 /// spend of 67 bytes (even if a p2wsh witnessScript might be *effectively* smaller), `dustRelayFee`
522 /// is set to 3000sat/kb, thus 110 * 3000 / 1000 = 330. Per-protocol rules, all time-sensitive outputs
523 /// are p2wsh, a value of 330 sats is the lower bound desired to ensure good propagation of transactions.
524 pub const MIN_DUST_LIMIT_SATOSHIS: u64 = 330;
526 /// Used to return a simple Error back to ChannelManager. Will get converted to a
527 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
528 /// channel_id in ChannelManager.
529 pub(super) enum ChannelError {
532 CloseDelayBroadcast(String),
535 impl fmt::Debug for ChannelError {
536 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
538 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
539 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
540 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
545 macro_rules! secp_check {
546 ($res: expr, $err: expr) => {
549 Err(_) => return Err(ChannelError::Close($err)),
554 impl<Signer: Sign> Channel<Signer> {
555 // Convert constants + channel value to limits:
556 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
557 channel_value_satoshis * 1000 / 10 //TODO
560 /// Returns a minimum channel reserve value the remote needs to maintain,
563 /// Guaranteed to return a value no larger than channel_value_satoshis
564 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
565 let (q, _) = channel_value_satoshis.overflowing_div(100);
566 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
570 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, their_features: InitFeatures, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
571 where K::Target: KeysInterface<Signer = Signer>,
572 F::Target: FeeEstimator,
574 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
575 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
576 let pubkeys = holder_signer.pubkeys().clone();
578 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
579 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
581 let channel_value_msat = channel_value_satoshis * 1000;
582 if push_msat > channel_value_msat {
583 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
585 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
586 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
588 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis);
589 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
590 return Err(APIError::APIMisuseError { err: format!("Holder selected channel reserve below implemention limit dust_limit_satoshis {}", holder_selected_channel_reserve_satoshis) });
593 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
595 let mut secp_ctx = Secp256k1::new();
596 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
598 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
599 Some(keys_provider.get_shutdown_scriptpubkey())
602 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
603 if !shutdown_scriptpubkey.is_compatible(&their_features) {
604 return Err(APIError::APIMisuseError { err: format!("Provided a scriptpubkey format not accepted by peer. script: ({})", shutdown_scriptpubkey.clone().into_inner().to_bytes().to_hex()) });
610 config: config.channel_options.clone(),
612 channel_id: keys_provider.get_secure_random_bytes(),
613 channel_state: ChannelState::OurInitSent as u32,
615 channel_value_satoshis,
617 latest_monitor_update_id: 0,
620 shutdown_scriptpubkey,
621 destination_script: keys_provider.get_destination_script(),
623 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
624 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
625 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
627 pending_inbound_htlcs: Vec::new(),
628 pending_outbound_htlcs: Vec::new(),
629 holding_cell_htlc_updates: Vec::new(),
630 pending_update_fee: None,
631 holding_cell_update_fee: None,
632 next_holder_htlc_id: 0,
633 next_counterparty_htlc_id: 0,
634 update_time_counter: 1,
636 resend_order: RAACommitmentOrder::CommitmentFirst,
638 monitor_pending_funding_locked: false,
639 monitor_pending_revoke_and_ack: false,
640 monitor_pending_commitment_signed: false,
641 monitor_pending_forwards: Vec::new(),
642 monitor_pending_failures: Vec::new(),
644 #[cfg(debug_assertions)]
645 holder_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
646 #[cfg(debug_assertions)]
647 counterparty_max_commitment_tx_output: Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
649 last_sent_closing_fee: None,
651 funding_tx_confirmed_in: None,
652 funding_tx_confirmation_height: 0,
653 short_channel_id: None,
655 feerate_per_kw: feerate,
656 counterparty_dust_limit_satoshis: 0,
657 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
658 counterparty_max_htlc_value_in_flight_msat: 0,
659 counterparty_selected_channel_reserve_satoshis: None, // Filled in in accept_channel
660 counterparty_htlc_minimum_msat: 0,
661 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
662 counterparty_max_accepted_htlcs: 0,
663 minimum_depth: None, // Filled in in accept_channel
665 counterparty_forwarding_info: None,
667 channel_transaction_parameters: ChannelTransactionParameters {
668 holder_pubkeys: pubkeys,
669 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
670 is_outbound_from_holder: true,
671 counterparty_parameters: None,
672 funding_outpoint: None
674 funding_transaction: None,
676 counterparty_cur_commitment_point: None,
677 counterparty_prev_commitment_point: None,
678 counterparty_node_id,
680 counterparty_shutdown_scriptpubkey: None,
682 commitment_secrets: CounterpartyCommitmentSecrets::new(),
684 channel_update_status: ChannelUpdateStatus::Enabled,
686 announcement_sigs: None,
688 #[cfg(any(test, feature = "fuzztarget"))]
689 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
690 #[cfg(any(test, feature = "fuzztarget"))]
691 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
693 workaround_lnd_bug_4006: None,
695 #[cfg(any(test, feature = "fuzztarget"))]
696 historical_inbound_htlc_fulfills: HashSet::new(),
700 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
701 where F::Target: FeeEstimator
703 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
704 if feerate_per_kw < lower_limit {
705 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
707 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 2;
708 if feerate_per_kw as u64 > upper_limit {
709 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
714 /// Creates a new channel from a remote sides' request for one.
715 /// Assumes chain_hash has already been checked and corresponds with what we expect!
716 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>
717 where K::Target: KeysInterface<Signer = Signer>,
718 F::Target: FeeEstimator
720 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
721 let pubkeys = holder_signer.pubkeys().clone();
722 let counterparty_pubkeys = ChannelPublicKeys {
723 funding_pubkey: msg.funding_pubkey,
724 revocation_basepoint: msg.revocation_basepoint,
725 payment_point: msg.payment_point,
726 delayed_payment_basepoint: msg.delayed_payment_basepoint,
727 htlc_basepoint: msg.htlc_basepoint
729 let mut local_config = (*config).channel_options.clone();
731 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
732 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)));
735 // Check sanity of message fields:
736 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
737 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
739 if msg.channel_reserve_satoshis > msg.funding_satoshis {
740 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
742 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
743 if msg.push_msat > funding_value {
744 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
746 if msg.dust_limit_satoshis > msg.funding_satoshis {
747 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)));
749 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
750 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
752 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
753 if msg.htlc_minimum_msat >= full_channel_value_msat {
754 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
756 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
758 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
759 if msg.to_self_delay > max_counterparty_selected_contest_delay {
760 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)));
762 if msg.max_accepted_htlcs < 1 {
763 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
765 if msg.max_accepted_htlcs > MAX_HTLCS {
766 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
769 // Now check against optional parameters as set by config...
770 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
771 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)));
773 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
774 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)));
776 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
777 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)));
779 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
780 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)));
782 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
783 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)));
785 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
786 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
788 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
789 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
792 // Convert things into internal flags and prep our state:
794 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
795 if config.peer_channel_config_limits.force_announced_channel_preference {
796 if local_config.announced_channel != announce {
797 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
800 // we either accept their preference or the preferences match
801 local_config.announced_channel = announce;
803 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
805 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
806 if holder_selected_channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
807 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)));
809 if msg.channel_reserve_satoshis < MIN_DUST_LIMIT_SATOSHIS {
810 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
812 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
813 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)));
816 // check if the funder's amount for the initial commitment tx is sufficient
817 // for full fee payment
818 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
819 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
820 if funders_amount_msat < lower_limit {
821 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
824 let to_local_msat = msg.push_msat;
825 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
826 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
827 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
830 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
831 match &msg.shutdown_scriptpubkey {
832 &OptionalField::Present(ref script) => {
833 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
834 if script.len() == 0 {
837 match ShutdownScript::try_from((script.clone(), &their_features)) {
838 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
839 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex()))),
843 // 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
844 &OptionalField::Absent => {
845 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()));
850 let shutdown_scriptpubkey = if config.channel_options.commit_upfront_shutdown_pubkey {
851 Some(keys_provider.get_shutdown_scriptpubkey())
854 if let Some(shutdown_scriptpubkey) = &shutdown_scriptpubkey {
855 if !shutdown_scriptpubkey.is_compatible(&their_features) {
856 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer. script: ({})", shutdown_scriptpubkey.clone().into_inner().to_bytes().to_hex())));
860 let mut secp_ctx = Secp256k1::new();
861 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
865 config: local_config,
867 channel_id: msg.temporary_channel_id,
868 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
871 latest_monitor_update_id: 0,
874 shutdown_scriptpubkey,
875 destination_script: keys_provider.get_destination_script(),
877 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
878 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
879 value_to_self_msat: msg.push_msat,
881 pending_inbound_htlcs: Vec::new(),
882 pending_outbound_htlcs: Vec::new(),
883 holding_cell_htlc_updates: Vec::new(),
884 pending_update_fee: None,
885 holding_cell_update_fee: None,
886 next_holder_htlc_id: 0,
887 next_counterparty_htlc_id: 0,
888 update_time_counter: 1,
890 resend_order: RAACommitmentOrder::CommitmentFirst,
892 monitor_pending_funding_locked: false,
893 monitor_pending_revoke_and_ack: false,
894 monitor_pending_commitment_signed: false,
895 monitor_pending_forwards: Vec::new(),
896 monitor_pending_failures: Vec::new(),
898 #[cfg(debug_assertions)]
899 holder_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
900 #[cfg(debug_assertions)]
901 counterparty_max_commitment_tx_output: Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
903 last_sent_closing_fee: None,
905 funding_tx_confirmed_in: None,
906 funding_tx_confirmation_height: 0,
907 short_channel_id: None,
909 feerate_per_kw: msg.feerate_per_kw,
910 channel_value_satoshis: msg.funding_satoshis,
911 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
912 holder_dust_limit_satoshis: MIN_DUST_LIMIT_SATOSHIS,
913 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
914 counterparty_selected_channel_reserve_satoshis: Some(msg.channel_reserve_satoshis),
915 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
916 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
917 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
918 minimum_depth: Some(config.own_channel_config.minimum_depth),
920 counterparty_forwarding_info: None,
922 channel_transaction_parameters: ChannelTransactionParameters {
923 holder_pubkeys: pubkeys,
924 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
925 is_outbound_from_holder: false,
926 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
927 selected_contest_delay: msg.to_self_delay,
928 pubkeys: counterparty_pubkeys,
930 funding_outpoint: None
932 funding_transaction: None,
934 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
935 counterparty_prev_commitment_point: None,
936 counterparty_node_id,
938 counterparty_shutdown_scriptpubkey,
940 commitment_secrets: CounterpartyCommitmentSecrets::new(),
942 channel_update_status: ChannelUpdateStatus::Enabled,
944 announcement_sigs: None,
946 #[cfg(any(test, feature = "fuzztarget"))]
947 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
948 #[cfg(any(test, feature = "fuzztarget"))]
949 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
951 workaround_lnd_bug_4006: None,
953 #[cfg(any(test, feature = "fuzztarget"))]
954 historical_inbound_htlc_fulfills: HashSet::new(),
960 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
961 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
962 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
963 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
964 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
966 /// @local is used only to convert relevant internal structures which refer to remote vs local
967 /// to decide value of outputs and direction of HTLCs.
968 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
969 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
970 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
971 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
972 /// which peer generated this transaction and "to whom" this transaction flows.
973 /// Returns (the transaction info, the number of HTLC outputs which were present in the
974 /// transaction, the list of HTLCs which were not ignored when building the transaction).
975 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
976 /// sources are provided only for outbound HTLCs in the third return value.
978 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 {
979 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
980 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
981 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
983 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
984 let mut remote_htlc_total_msat = 0;
985 let mut local_htlc_total_msat = 0;
986 let mut value_to_self_msat_offset = 0;
988 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for channel {} for {}, generated by {} with fee {}...",
989 commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number),
990 get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()),
991 log_bytes!(self.channel_id), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
993 macro_rules! get_htlc_in_commitment {
994 ($htlc: expr, $offered: expr) => {
995 HTLCOutputInCommitment {
997 amount_msat: $htlc.amount_msat,
998 cltv_expiry: $htlc.cltv_expiry,
999 payment_hash: $htlc.payment_hash,
1000 transaction_output_index: None
1005 macro_rules! add_htlc_output {
1006 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
1007 if $outbound == local { // "offered HTLC output"
1008 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
1009 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
1010 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);
1011 included_non_dust_htlcs.push((htlc_in_tx, $source));
1013 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);
1014 included_dust_htlcs.push((htlc_in_tx, $source));
1017 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
1018 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
1019 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);
1020 included_non_dust_htlcs.push((htlc_in_tx, $source));
1022 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);
1023 included_dust_htlcs.push((htlc_in_tx, $source));
1029 for ref htlc in self.pending_inbound_htlcs.iter() {
1030 let (include, state_name) = match htlc.state {
1031 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
1032 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
1033 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
1034 InboundHTLCState::Committed => (true, "Committed"),
1035 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
1039 add_htlc_output!(htlc, false, None, state_name);
1040 remote_htlc_total_msat += htlc.amount_msat;
1042 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);
1044 &InboundHTLCState::LocalRemoved(ref reason) => {
1045 if generated_by_local {
1046 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1047 value_to_self_msat_offset += htlc.amount_msat as i64;
1056 for ref htlc in self.pending_outbound_htlcs.iter() {
1057 let (include, state_name) = match htlc.state {
1058 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
1059 OutboundHTLCState::Committed => (true, "Committed"),
1060 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
1061 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
1062 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
1066 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
1067 local_htlc_total_msat += htlc.amount_msat;
1069 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);
1071 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
1072 value_to_self_msat_offset -= htlc.amount_msat as i64;
1074 OutboundHTLCState::RemoteRemoved(None) => {
1075 if !generated_by_local {
1076 value_to_self_msat_offset -= htlc.amount_msat as i64;
1084 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
1085 assert!(value_to_self_msat >= 0);
1086 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
1087 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
1088 // "violate" their reserve value by couting those against it. Thus, we have to convert
1089 // everything to i64 before subtracting as otherwise we can overflow.
1090 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;
1091 assert!(value_to_remote_msat >= 0);
1093 #[cfg(debug_assertions)]
1095 // Make sure that the to_self/to_remote is always either past the appropriate
1096 // channel_reserve *or* it is making progress towards it.
1097 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1098 self.holder_max_commitment_tx_output.lock().unwrap()
1100 self.counterparty_max_commitment_tx_output.lock().unwrap()
1102 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);
1103 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1104 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);
1105 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1108 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;
1109 let (value_to_self, value_to_remote) = if self.is_outbound() {
1110 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1112 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1115 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1116 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1118 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1119 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1124 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1125 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1130 let num_nondust_htlcs = included_non_dust_htlcs.len();
1132 let channel_parameters =
1133 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1134 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1135 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1140 &mut included_non_dust_htlcs,
1143 let mut htlcs_included = included_non_dust_htlcs;
1144 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1145 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1146 htlcs_included.append(&mut included_dust_htlcs);
1148 (tx, num_nondust_htlcs, htlcs_included)
1152 fn get_closing_scriptpubkey(&self) -> Script {
1153 self.shutdown_scriptpubkey.clone().unwrap().into_inner()
1157 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1162 1 + // script length (0)
1166 )*4 + // * 4 for non-witness parts
1167 2 + // witness marker and flag
1168 1 + // witness element count
1169 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1170 self.get_funding_redeemscript().len() as u64 + // funding witness script
1171 2*(1 + 71); // two signatures + sighash type flags
1172 if let Some(spk) = a_scriptpubkey {
1173 ret += ((8+1) + // output values and script length
1174 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1176 if let Some(spk) = b_scriptpubkey {
1177 ret += ((8+1) + // output values and script length
1178 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1184 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1186 let mut ins: Vec<TxIn> = Vec::new();
1188 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1189 script_sig: Script::new(),
1190 sequence: 0xffffffff,
1191 witness: Vec::new(),
1196 assert!(self.pending_inbound_htlcs.is_empty());
1197 assert!(self.pending_outbound_htlcs.is_empty());
1198 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1200 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1201 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1202 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 };
1204 if value_to_self < 0 {
1205 assert!(self.is_outbound());
1206 total_fee_satoshis += (-value_to_self) as u64;
1207 } else if value_to_remote < 0 {
1208 assert!(!self.is_outbound());
1209 total_fee_satoshis += (-value_to_remote) as u64;
1212 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1213 txouts.push((TxOut {
1214 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1215 value: value_to_remote as u64
1219 assert!(self.shutdown_scriptpubkey.is_some());
1220 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1221 txouts.push((TxOut {
1222 script_pubkey: self.get_closing_scriptpubkey(),
1223 value: value_to_self as u64
1227 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1229 let mut outputs: Vec<TxOut> = Vec::new();
1230 for out in txouts.drain(..) {
1231 outputs.push(out.0);
1239 }, total_fee_satoshis)
1242 fn funding_outpoint(&self) -> OutPoint {
1243 self.channel_transaction_parameters.funding_outpoint.unwrap()
1247 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1248 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1249 /// our counterparty!)
1250 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1251 /// TODO Some magic rust shit to compile-time check this?
1252 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1253 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1254 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1255 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1256 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1258 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()))
1262 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1263 /// will sign and send to our counterparty.
1264 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1265 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1266 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1267 //may see payments to it!
1268 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1269 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1270 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1272 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()))
1275 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1276 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1277 /// Panics if called before accept_channel/new_from_req
1278 pub fn get_funding_redeemscript(&self) -> Script {
1279 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1282 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> UpdateFulfillFetch where L::Target: Logger {
1283 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1284 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1285 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1287 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1288 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1290 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1292 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1294 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1295 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1296 // these, but for now we just have to treat them as normal.
1298 let mut pending_idx = core::usize::MAX;
1299 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1300 if htlc.htlc_id == htlc_id_arg {
1301 assert_eq!(htlc.payment_hash, payment_hash_calc);
1303 InboundHTLCState::Committed => {},
1304 InboundHTLCState::LocalRemoved(ref reason) => {
1305 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1307 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()));
1308 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1310 return UpdateFulfillFetch::DuplicateClaim {};
1313 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1314 // Don't return in release mode here so that we can update channel_monitor
1321 if pending_idx == core::usize::MAX {
1322 #[cfg(any(test, feature = "fuzztarget"))]
1323 // If we failed to find an HTLC to fulfill, make sure it was previously fulfilled and
1324 // this is simply a duplicate claim, not previously failed and we lost funds.
1325 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1326 return UpdateFulfillFetch::DuplicateClaim {};
1329 // Now update local state:
1331 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1332 // can claim it even if the channel hits the chain before we see their next commitment.
1333 self.latest_monitor_update_id += 1;
1334 let monitor_update = ChannelMonitorUpdate {
1335 update_id: self.latest_monitor_update_id,
1336 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1337 payment_preimage: payment_preimage_arg.clone(),
1341 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1342 for pending_update in self.holding_cell_htlc_updates.iter() {
1343 match pending_update {
1344 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1345 if htlc_id_arg == htlc_id {
1346 // Make sure we don't leave latest_monitor_update_id incremented here:
1347 self.latest_monitor_update_id -= 1;
1348 #[cfg(any(test, feature = "fuzztarget"))]
1349 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1350 return UpdateFulfillFetch::DuplicateClaim {};
1353 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1354 if htlc_id_arg == htlc_id {
1355 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1356 // TODO: We may actually be able to switch to a fulfill here, though its
1357 // rare enough it may not be worth the complexity burden.
1358 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1359 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1365 log_trace!(logger, "Adding HTLC claim to holding_cell in channel {}! Current state: {}", log_bytes!(self.channel_id()), self.channel_state);
1366 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1367 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1369 #[cfg(any(test, feature = "fuzztarget"))]
1370 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1371 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1373 #[cfg(any(test, feature = "fuzztarget"))]
1374 self.historical_inbound_htlc_fulfills.insert(htlc_id_arg);
1377 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1378 if let InboundHTLCState::Committed = htlc.state {
1380 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1381 return UpdateFulfillFetch::NewClaim { monitor_update, msg: None };
1383 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill in channel {}!", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
1384 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1387 UpdateFulfillFetch::NewClaim {
1389 msg: Some(msgs::UpdateFulfillHTLC {
1390 channel_id: self.channel_id(),
1391 htlc_id: htlc_id_arg,
1392 payment_preimage: payment_preimage_arg,
1397 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 {
1398 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
1399 UpdateFulfillFetch::NewClaim { mut monitor_update, msg: Some(update_fulfill_htlc) } => {
1400 let (commitment, mut additional_update) = match self.send_commitment_no_status_check(logger) {
1401 Err(e) => return Err((e, monitor_update)),
1404 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1405 // strictly increasing by one, so decrement it here.
1406 self.latest_monitor_update_id = monitor_update.update_id;
1407 monitor_update.updates.append(&mut additional_update.updates);
1408 Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, msgs: Some((update_fulfill_htlc, commitment)) })
1410 UpdateFulfillFetch::NewClaim { monitor_update, msg: None } => Ok(UpdateFulfillCommitFetch::NewClaim { monitor_update, msgs: None }),
1411 UpdateFulfillFetch::DuplicateClaim {} => Ok(UpdateFulfillCommitFetch::DuplicateClaim {}),
1415 /// We can only have one resolution per HTLC. In some cases around reconnect, we may fulfill
1416 /// an HTLC more than once or fulfill once and then attempt to fail after reconnect. We cannot,
1417 /// however, fail more than once as we wait for an upstream failure to be irrevocably committed
1418 /// before we fail backwards.
1419 /// If we do fail twice, we debug_assert!(false) and return Ok(None). Thus, will always return
1420 /// Ok(_) if debug assertions are turned on or preconditions are met.
1421 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 {
1422 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1423 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1425 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1427 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1428 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1429 // these, but for now we just have to treat them as normal.
1431 let mut pending_idx = core::usize::MAX;
1432 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1433 if htlc.htlc_id == htlc_id_arg {
1435 InboundHTLCState::Committed => {},
1436 InboundHTLCState::LocalRemoved(ref reason) => {
1437 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1439 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1444 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1445 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1451 if pending_idx == core::usize::MAX {
1452 #[cfg(any(test, feature = "fuzztarget"))]
1453 // If we failed to find an HTLC to fail, make sure it was previously fulfilled and this
1454 // is simply a duplicate fail, not previously failed and we failed-back too early.
1455 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1459 // Now update local state:
1460 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1461 for pending_update in self.holding_cell_htlc_updates.iter() {
1462 match pending_update {
1463 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1464 if htlc_id_arg == htlc_id {
1465 #[cfg(any(test, feature = "fuzztarget"))]
1466 debug_assert!(self.historical_inbound_htlc_fulfills.contains(&htlc_id_arg));
1470 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1471 if htlc_id_arg == htlc_id {
1472 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1473 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1479 log_trace!(logger, "Placing failure for HTLC ID {} in holding cell in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1480 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1481 htlc_id: htlc_id_arg,
1487 log_trace!(logger, "Failing HTLC ID {} back with a update_fail_htlc message in channel {}.", htlc_id_arg, log_bytes!(self.channel_id()));
1489 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1490 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1493 Ok(Some(msgs::UpdateFailHTLC {
1494 channel_id: self.channel_id(),
1495 htlc_id: htlc_id_arg,
1500 // Message handlers:
1502 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1503 // Check sanity of message fields:
1504 if !self.is_outbound() {
1505 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1507 if self.channel_state != ChannelState::OurInitSent as u32 {
1508 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1510 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1511 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1513 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1514 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1516 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1517 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)));
1519 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1520 if msg.dust_limit_satoshis > remote_reserve {
1521 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1523 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1524 if msg.htlc_minimum_msat >= full_channel_value_msat {
1525 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1527 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1528 if msg.to_self_delay > max_delay_acceptable {
1529 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)));
1531 if msg.max_accepted_htlcs < 1 {
1532 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1534 if msg.max_accepted_htlcs > MAX_HTLCS {
1535 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1538 // Now check against optional parameters as set by config...
1539 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1540 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)));
1542 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1543 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)));
1545 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1546 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)));
1548 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1549 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)));
1551 if msg.dust_limit_satoshis < MIN_DUST_LIMIT_SATOSHIS {
1552 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the implementation limit ({})", msg.dust_limit_satoshis, MIN_DUST_LIMIT_SATOSHIS)));
1554 if msg.dust_limit_satoshis > MAX_DUST_LIMIT_SATOSHIS {
1555 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the implementation limit ({})", msg.dust_limit_satoshis, MAX_DUST_LIMIT_SATOSHIS)));
1557 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1558 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)));
1560 if msg.minimum_depth == 0 {
1561 // Note that if this changes we should update the serialization minimum version to
1562 // indicate to older clients that they don't understand some features of the current
1564 return Err(ChannelError::Close("Minimum confirmation depth must be at least 1".to_owned()));
1567 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1568 match &msg.shutdown_scriptpubkey {
1569 &OptionalField::Present(ref script) => {
1570 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1571 if script.len() == 0 {
1574 match ShutdownScript::try_from((script.clone(), &their_features)) {
1575 Ok(shutdown_script) => Some(shutdown_script.into_inner()),
1576 Err(_) => return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex()))),
1580 // 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
1581 &OptionalField::Absent => {
1582 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()));
1587 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1588 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1589 self.counterparty_selected_channel_reserve_satoshis = Some(msg.channel_reserve_satoshis);
1590 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1591 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1592 self.minimum_depth = Some(msg.minimum_depth);
1594 let counterparty_pubkeys = ChannelPublicKeys {
1595 funding_pubkey: msg.funding_pubkey,
1596 revocation_basepoint: msg.revocation_basepoint,
1597 payment_point: msg.payment_point,
1598 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1599 htlc_basepoint: msg.htlc_basepoint
1602 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1603 selected_contest_delay: msg.to_self_delay,
1604 pubkeys: counterparty_pubkeys,
1607 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1608 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1610 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1615 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1616 let funding_script = self.get_funding_redeemscript();
1618 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1619 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1621 let trusted_tx = initial_commitment_tx.trust();
1622 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1623 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1624 // They sign the holder commitment transaction...
1625 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} for channel {}.",
1626 log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()),
1627 encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]),
1628 encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
1629 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1632 let counterparty_keys = self.build_remote_transaction_keys()?;
1633 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;
1635 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1636 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1637 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1638 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1640 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1641 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1643 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1644 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1647 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1648 &self.get_counterparty_pubkeys().funding_pubkey
1651 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 {
1652 if self.is_outbound() {
1653 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1655 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1656 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1657 // remember the channel, so it's safe to just send an error_message here and drop the
1659 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1661 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1662 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1663 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1664 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1667 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1668 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1669 // This is an externally observable change before we finish all our checks. In particular
1670 // funding_created_signature may fail.
1671 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1673 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1675 Err(ChannelError::Close(e)) => {
1676 self.channel_transaction_parameters.funding_outpoint = None;
1677 return Err(ChannelError::Close(e));
1680 // The only error we know how to handle is ChannelError::Close, so we fall over here
1681 // to make sure we don't continue with an inconsistent state.
1682 panic!("unexpected error type from funding_created_signature {:?}", e);
1686 let holder_commitment_tx = HolderCommitmentTransaction::new(
1687 initial_commitment_tx,
1690 &self.get_holder_pubkeys().funding_pubkey,
1691 self.counterparty_funding_pubkey()
1694 // Now that we're past error-generating stuff, update our local state:
1696 let funding_redeemscript = self.get_funding_redeemscript();
1697 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1698 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1699 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1700 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1701 shutdown_script, self.get_holder_selected_contest_delay(),
1702 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1703 &self.channel_transaction_parameters,
1704 funding_redeemscript.clone(), self.channel_value_satoshis,
1706 holder_commitment_tx, best_block);
1708 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);
1710 self.channel_state = ChannelState::FundingSent as u32;
1711 self.channel_id = funding_txo.to_channel_id();
1712 self.cur_counterparty_commitment_transaction_number -= 1;
1713 self.cur_holder_commitment_transaction_number -= 1;
1715 log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
1717 Ok((msgs::FundingSigned {
1718 channel_id: self.channel_id,
1720 }, channel_monitor))
1723 /// Handles a funding_signed message from the remote end.
1724 /// If this call is successful, broadcast the funding transaction (and not before!)
1725 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 {
1726 if !self.is_outbound() {
1727 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1729 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1730 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1732 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1733 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1734 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1735 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1738 let funding_script = self.get_funding_redeemscript();
1740 let counterparty_keys = self.build_remote_transaction_keys()?;
1741 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;
1742 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1743 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1745 log_trace!(logger, "Initial counterparty tx for channel {} is: txid {} tx {}",
1746 log_bytes!(self.channel_id()), counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1748 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1749 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1751 let trusted_tx = initial_commitment_tx.trust();
1752 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1753 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1754 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1755 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1756 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1760 let holder_commitment_tx = HolderCommitmentTransaction::new(
1761 initial_commitment_tx,
1764 &self.get_holder_pubkeys().funding_pubkey,
1765 self.counterparty_funding_pubkey()
1769 let funding_redeemscript = self.get_funding_redeemscript();
1770 let funding_txo = self.get_funding_txo().unwrap();
1771 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1772 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1773 let shutdown_script = self.shutdown_scriptpubkey.clone().map(|script| script.into_inner());
1774 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1775 shutdown_script, self.get_holder_selected_contest_delay(),
1776 &self.destination_script, (funding_txo, funding_txo_script),
1777 &self.channel_transaction_parameters,
1778 funding_redeemscript.clone(), self.channel_value_satoshis,
1780 holder_commitment_tx, best_block);
1782 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);
1784 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1785 self.channel_state = ChannelState::FundingSent as u32;
1786 self.cur_holder_commitment_transaction_number -= 1;
1787 self.cur_counterparty_commitment_transaction_number -= 1;
1789 log_info!(logger, "Received funding_signed from peer for channel {}", log_bytes!(self.channel_id()));
1791 Ok((channel_monitor, self.funding_transaction.as_ref().cloned().unwrap()))
1794 pub fn funding_locked<L: Deref>(&mut self, msg: &msgs::FundingLocked, logger: &L) -> Result<(), ChannelError> where L::Target: Logger {
1795 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1796 self.workaround_lnd_bug_4006 = Some(msg.clone());
1797 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()));
1800 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1802 if non_shutdown_state == ChannelState::FundingSent as u32 {
1803 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1804 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1805 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1806 self.update_time_counter += 1;
1807 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1808 // Note that funding_signed/funding_created will have decremented both by 1!
1809 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1810 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1811 // If we reconnected before sending our funding locked they may still resend theirs:
1812 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1813 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1814 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1815 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1817 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1820 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1823 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1824 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1826 log_info!(logger, "Received funding_locked from peer for channel {}", log_bytes!(self.channel_id()));
1831 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1832 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1833 let mut htlc_inbound_value_msat = 0;
1834 for ref htlc in self.pending_inbound_htlcs.iter() {
1835 htlc_inbound_value_msat += htlc.amount_msat;
1837 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1840 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1842 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1843 let mut htlc_outbound_value_msat = 0;
1844 for ref htlc in self.pending_outbound_htlcs.iter() {
1845 htlc_outbound_value_msat += htlc.amount_msat;
1848 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1849 for update in self.holding_cell_htlc_updates.iter() {
1850 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1851 htlc_outbound_count += 1;
1852 htlc_outbound_value_msat += amount_msat;
1856 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1859 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1860 /// Doesn't bother handling the
1861 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1862 /// corner case properly.
1863 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1864 // Note that we have to handle overflow due to the above case.
1866 cmp::max(self.channel_value_satoshis as i64 * 1000
1867 - self.value_to_self_msat as i64
1868 - self.get_inbound_pending_htlc_stats().1 as i64
1869 - Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) as i64 * 1000,
1871 cmp::max(self.value_to_self_msat as i64
1872 - self.get_outbound_pending_htlc_stats().1 as i64
1873 - self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0) as i64 * 1000,
1878 pub fn get_holder_counterparty_selected_channel_reserve_satoshis(&self) -> (u64, Option<u64>) {
1879 (Self::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
1880 self.counterparty_selected_channel_reserve_satoshis)
1883 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1884 // Note that num_htlcs should not include dust HTLCs.
1885 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1886 // Note that we need to divide before multiplying to round properly,
1887 // since the lowest denomination of bitcoin on-chain is the satoshi.
1888 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1891 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1892 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1893 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1895 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1896 assert!(self.is_outbound());
1898 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1899 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1901 let mut addl_htlcs = 0;
1902 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1904 HTLCInitiator::LocalOffered => {
1905 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1909 HTLCInitiator::RemoteOffered => {
1910 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1916 let mut included_htlcs = 0;
1917 for ref htlc in self.pending_inbound_htlcs.iter() {
1918 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1921 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1922 // transaction including this HTLC if it times out before they RAA.
1923 included_htlcs += 1;
1926 for ref htlc in self.pending_outbound_htlcs.iter() {
1927 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1931 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1932 OutboundHTLCState::Committed => included_htlcs += 1,
1933 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1934 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1935 // transaction won't be generated until they send us their next RAA, which will mean
1936 // dropping any HTLCs in this state.
1941 for htlc in self.holding_cell_htlc_updates.iter() {
1943 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1944 if amount_msat / 1000 < real_dust_limit_timeout_sat {
1949 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1950 // ack we're guaranteed to never include them in commitment txs anymore.
1954 let num_htlcs = included_htlcs + addl_htlcs;
1955 let res = self.commit_tx_fee_msat(num_htlcs);
1956 #[cfg(any(test, feature = "fuzztarget"))]
1959 if fee_spike_buffer_htlc.is_some() {
1960 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1962 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1963 + self.holding_cell_htlc_updates.len();
1964 let commitment_tx_info = CommitmentTxInfoCached {
1966 total_pending_htlcs,
1967 next_holder_htlc_id: match htlc.origin {
1968 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1969 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1971 next_counterparty_htlc_id: match htlc.origin {
1972 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1973 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1975 feerate: self.feerate_per_kw,
1977 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1982 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1983 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1984 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1986 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1987 assert!(!self.is_outbound());
1989 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1990 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1992 let mut addl_htlcs = 0;
1993 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1995 HTLCInitiator::LocalOffered => {
1996 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
2000 HTLCInitiator::RemoteOffered => {
2001 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
2007 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
2008 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
2009 // committed outbound HTLCs, see below.
2010 let mut included_htlcs = 0;
2011 for ref htlc in self.pending_inbound_htlcs.iter() {
2012 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
2015 included_htlcs += 1;
2018 for ref htlc in self.pending_outbound_htlcs.iter() {
2019 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
2022 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
2023 // i.e. if they've responded to us with an RAA after announcement.
2025 OutboundHTLCState::Committed => included_htlcs += 1,
2026 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
2027 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
2032 let num_htlcs = included_htlcs + addl_htlcs;
2033 let res = self.commit_tx_fee_msat(num_htlcs);
2034 #[cfg(any(test, feature = "fuzztarget"))]
2037 if fee_spike_buffer_htlc.is_some() {
2038 fee = self.commit_tx_fee_msat(num_htlcs - 1);
2040 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
2041 let commitment_tx_info = CommitmentTxInfoCached {
2043 total_pending_htlcs,
2044 next_holder_htlc_id: match htlc.origin {
2045 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
2046 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
2048 next_counterparty_htlc_id: match htlc.origin {
2049 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
2050 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
2052 feerate: self.feerate_per_kw,
2054 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
2059 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>
2060 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
2061 // We can't accept HTLCs sent after we've sent a shutdown.
2062 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2063 if local_sent_shutdown {
2064 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
2066 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
2067 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
2068 if remote_sent_shutdown {
2069 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
2071 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2072 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
2074 if msg.amount_msat > self.channel_value_satoshis * 1000 {
2075 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
2077 if msg.amount_msat == 0 {
2078 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
2080 if msg.amount_msat < self.holder_htlc_minimum_msat {
2081 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)));
2084 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
2085 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
2086 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
2088 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
2089 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
2090 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
2092 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
2093 // the reserve_satoshis we told them to always have as direct payment so that they lose
2094 // something if we punish them for broadcasting an old state).
2095 // Note that we don't really care about having a small/no to_remote output in our local
2096 // commitment transactions, as the purpose of the channel reserve is to ensure we can
2097 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
2098 // present in the next commitment transaction we send them (at least for fulfilled ones,
2099 // failed ones won't modify value_to_self).
2100 // Note that we will send HTLCs which another instance of rust-lightning would think
2101 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
2102 // Channel state once they will not be present in the next received commitment
2104 let mut removed_outbound_total_msat = 0;
2105 for ref htlc in self.pending_outbound_htlcs.iter() {
2106 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
2107 removed_outbound_total_msat += htlc.amount_msat;
2108 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
2109 removed_outbound_total_msat += htlc.amount_msat;
2113 let pending_value_to_self_msat =
2114 self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
2115 let pending_remote_value_msat =
2116 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
2117 if pending_remote_value_msat < msg.amount_msat {
2118 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
2121 // Check that the remote can afford to pay for this HTLC on-chain at the current
2122 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
2123 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
2124 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2125 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
2127 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
2128 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
2131 let chan_reserve_msat =
2132 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
2133 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
2134 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2137 if !self.is_outbound() {
2138 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2139 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2140 // receiver's side, only on the sender's.
2141 // Note that when we eventually remove support for fee updates and switch to anchor output
2142 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2143 // the extra htlc when calculating the next remote commitment transaction fee as we should
2144 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2145 // sensitive to fee spikes.
2146 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2147 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2148 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2149 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2150 // the HTLC, i.e. its status is already set to failing.
2151 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation in channel {}. Rebalancing is required.", log_bytes!(self.channel_id()));
2152 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2155 // Check that they won't violate our local required channel reserve by adding this HTLC.
2156 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2157 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2158 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000 + local_commit_tx_fee_msat {
2159 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2162 if self.next_counterparty_htlc_id != msg.htlc_id {
2163 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2165 if msg.cltv_expiry >= 500000000 {
2166 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2169 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2170 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2171 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2175 // Now update local state:
2176 self.next_counterparty_htlc_id += 1;
2177 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2178 htlc_id: msg.htlc_id,
2179 amount_msat: msg.amount_msat,
2180 payment_hash: msg.payment_hash,
2181 cltv_expiry: msg.cltv_expiry,
2182 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2187 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2189 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
2190 for htlc in self.pending_outbound_htlcs.iter_mut() {
2191 if htlc.htlc_id == htlc_id {
2192 match check_preimage {
2194 Some(payment_hash) =>
2195 if payment_hash != htlc.payment_hash {
2196 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2200 OutboundHTLCState::LocalAnnounced(_) =>
2201 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2202 OutboundHTLCState::Committed => {
2203 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2205 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2206 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2208 return Ok(&htlc.source);
2211 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2214 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
2215 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2216 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2218 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2219 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2222 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2223 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
2226 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2227 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2228 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2230 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2231 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2234 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2238 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2239 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2240 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2242 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2243 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2246 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2250 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)>
2251 where F::Target: FeeEstimator,
2254 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2255 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2257 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2258 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2260 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2261 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2264 let funding_script = self.get_funding_redeemscript();
2266 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2268 let mut update_fee = false;
2269 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2271 self.pending_update_fee.unwrap()
2276 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2277 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2278 let commitment_txid = {
2279 let trusted_tx = commitment_tx.0.trust();
2280 let bitcoin_tx = trusted_tx.built_transaction();
2281 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2283 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}",
2284 log_bytes!(msg.signature.serialize_compact()[..]),
2285 log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction),
2286 log_bytes!(sighash[..]), encode::serialize_hex(&funding_script), log_bytes!(self.channel_id()));
2287 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2288 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2292 let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2293 (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2296 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2297 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2299 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2300 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2301 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2304 #[cfg(any(test, feature = "fuzztarget"))]
2306 if self.is_outbound() {
2307 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2308 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2309 if let Some(info) = projected_commit_tx_info {
2310 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2311 + self.holding_cell_htlc_updates.len();
2312 if info.total_pending_htlcs == total_pending_htlcs
2313 && info.next_holder_htlc_id == self.next_holder_htlc_id
2314 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2315 && info.feerate == self.feerate_per_kw {
2316 assert_eq!(total_fee, info.fee / 1000);
2322 if msg.htlc_signatures.len() != num_htlcs {
2323 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2326 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2327 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2328 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2329 if let Some(_) = htlc.transaction_output_index {
2330 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, feerate_per_kw,
2331 self.get_counterparty_selected_contest_delay().unwrap(), &htlc,
2332 &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
2334 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2335 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2336 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {} in channel {}.",
2337 log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()),
2338 encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript), log_bytes!(self.channel_id()));
2339 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2340 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2342 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2344 htlcs_and_sigs.push((htlc, None, source));
2348 let holder_commitment_tx = HolderCommitmentTransaction::new(
2351 msg.htlc_signatures.clone(),
2352 &self.get_holder_pubkeys().funding_pubkey,
2353 self.counterparty_funding_pubkey()
2356 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2357 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2359 // Update state now that we've passed all the can-fail calls...
2360 let mut need_commitment = false;
2361 if !self.is_outbound() {
2362 if let Some(fee_update) = self.pending_update_fee {
2363 self.feerate_per_kw = fee_update;
2364 // We later use the presence of pending_update_fee to indicate we should generate a
2365 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2366 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2367 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2368 need_commitment = true;
2369 self.pending_update_fee = None;
2374 self.latest_monitor_update_id += 1;
2375 let mut monitor_update = ChannelMonitorUpdate {
2376 update_id: self.latest_monitor_update_id,
2377 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2378 commitment_tx: holder_commitment_tx,
2379 htlc_outputs: htlcs_and_sigs
2383 for htlc in self.pending_inbound_htlcs.iter_mut() {
2384 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2385 Some(forward_info.clone())
2387 if let Some(forward_info) = new_forward {
2388 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToAnnounce due to commitment_signed in channel {}.",
2389 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2390 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2391 need_commitment = true;
2394 for htlc in self.pending_outbound_htlcs.iter_mut() {
2395 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2396 Some(fail_reason.take())
2398 log_trace!(logger, "Updating HTLC {} to AwaitingRemoteRevokeToRemove due to commitment_signed in channel {}.",
2399 log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id));
2400 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2401 need_commitment = true;
2405 self.cur_holder_commitment_transaction_number -= 1;
2406 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2407 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2408 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2410 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2411 // In case we initially failed monitor updating without requiring a response, we need
2412 // to make sure the RAA gets sent first.
2413 self.monitor_pending_revoke_and_ack = true;
2414 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2415 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2416 // the corresponding HTLC status updates so that get_last_commitment_update
2417 // includes the right HTLCs.
2418 self.monitor_pending_commitment_signed = true;
2419 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2420 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2421 // strictly increasing by one, so decrement it here.
2422 self.latest_monitor_update_id = monitor_update.update_id;
2423 monitor_update.updates.append(&mut additional_update.updates);
2425 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updated HTLC state but awaiting a monitor update resolution to reply.",
2426 log_bytes!(self.channel_id));
2427 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2428 // re-send the message on restoration)
2429 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2432 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2433 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2434 // we'll send one right away when we get the revoke_and_ack when we
2435 // free_holding_cell_htlcs().
2436 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2437 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2438 // strictly increasing by one, so decrement it here.
2439 self.latest_monitor_update_id = monitor_update.update_id;
2440 monitor_update.updates.append(&mut additional_update.updates);
2442 } else if !need_commitment {
2443 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2444 } else { (None, None) };
2446 log_debug!(logger, "Received valid commitment_signed from peer in channel {}, updating HTLC state and responding with{} a revoke_and_ack.",
2447 log_bytes!(self.channel_id()), if commitment_signed.is_some() { " our own commitment_signed and" } else { "" });
2449 Ok((msgs::RevokeAndACK {
2450 channel_id: self.channel_id,
2451 per_commitment_secret,
2452 next_per_commitment_point,
2453 }, commitment_signed, closing_signed, monitor_update))
2456 /// Public version of the below, checking relevant preconditions first.
2457 /// If we're not in a state where freeing the holding cell makes sense, this is a no-op and
2458 /// returns `(None, Vec::new())`.
2459 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 {
2460 if self.channel_state >= ChannelState::ChannelFunded as u32 &&
2461 (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2462 self.free_holding_cell_htlcs(logger)
2463 } else { Ok((None, Vec::new())) }
2466 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2467 /// fulfilling or failing the last pending HTLC)
2468 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2469 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2470 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2471 log_trace!(logger, "Freeing holding cell with {} HTLC updates{} in channel {}", self.holding_cell_htlc_updates.len(),
2472 if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" }, log_bytes!(self.channel_id()));
2474 let mut monitor_update = ChannelMonitorUpdate {
2475 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2476 updates: Vec::new(),
2479 let mut htlc_updates = Vec::new();
2480 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2481 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2482 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2483 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2484 let mut htlcs_to_fail = Vec::new();
2485 for htlc_update in htlc_updates.drain(..) {
2486 // Note that this *can* fail, though it should be due to rather-rare conditions on
2487 // fee races with adding too many outputs which push our total payments just over
2488 // the limit. In case it's less rare than I anticipate, we may want to revisit
2489 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2490 // to rebalance channels.
2491 match &htlc_update {
2492 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2493 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2494 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2497 ChannelError::Ignore(ref msg) => {
2498 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {} in channel {}",
2499 log_bytes!(payment_hash.0), msg, log_bytes!(self.channel_id()));
2500 // If we fail to send here, then this HTLC should
2501 // be failed backwards. Failing to send here
2502 // indicates that this HTLC may keep being put back
2503 // into the holding cell without ever being
2504 // successfully forwarded/failed/fulfilled, causing
2505 // our counterparty to eventually close on us.
2506 htlcs_to_fail.push((source.clone(), *payment_hash));
2509 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2515 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2516 // If an HTLC claim was previously added to the holding cell (via
2517 // `get_update_fulfill_htlc`, then generating the claim message itself must
2518 // not fail - any in between attempts to claim the HTLC will have resulted
2519 // in it hitting the holding cell again and we cannot change the state of a
2520 // holding cell HTLC from fulfill to anything else.
2521 let (update_fulfill_msg_option, mut additional_monitor_update) =
2522 if let UpdateFulfillFetch::NewClaim { msg, monitor_update } = self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2523 (msg, monitor_update)
2524 } else { unreachable!() };
2525 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2526 monitor_update.updates.append(&mut additional_monitor_update.updates);
2528 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2529 match self.get_update_fail_htlc(htlc_id, err_packet.clone(), logger) {
2530 Ok(update_fail_msg_option) => {
2531 // If an HTLC failure was previously added to the holding cell (via
2532 // `get_update_fail_htlc`) then generating the fail message itself
2533 // must not fail - we should never end up in a state where we
2534 // double-fail an HTLC or fail-then-claim an HTLC as it indicates
2535 // we didn't wait for a full revocation before failing.
2536 update_fail_htlcs.push(update_fail_msg_option.unwrap())
2539 if let ChannelError::Ignore(_) = e {}
2541 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2548 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2549 return Ok((None, htlcs_to_fail));
2551 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2552 self.pending_update_fee = self.holding_cell_update_fee.take();
2553 Some(msgs::UpdateFee {
2554 channel_id: self.channel_id,
2555 feerate_per_kw: feerate as u32,
2561 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2562 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2563 // but we want them to be strictly increasing by one, so reset it here.
2564 self.latest_monitor_update_id = monitor_update.update_id;
2565 monitor_update.updates.append(&mut additional_update.updates);
2567 log_debug!(logger, "Freeing holding cell in channel {} resulted in {}{} HTLCs added, {} HTLCs fulfilled, and {} HTLCs failed.",
2568 log_bytes!(self.channel_id()), if update_fee.is_some() { "a fee update, " } else { "" },
2569 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len());
2571 Ok((Some((msgs::CommitmentUpdate {
2573 update_fulfill_htlcs,
2575 update_fail_malformed_htlcs: Vec::new(),
2578 }, monitor_update)), htlcs_to_fail))
2580 Ok((None, Vec::new()))
2584 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2585 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2586 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2587 /// generating an appropriate error *after* the channel state has been updated based on the
2588 /// revoke_and_ack message.
2589 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>
2590 where F::Target: FeeEstimator,
2593 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2594 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2596 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2597 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2599 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2600 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2603 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2604 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 {
2605 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2609 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2610 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2611 // haven't given them a new commitment transaction to broadcast). We should probably
2612 // take advantage of this by updating our channel monitor, sending them an error, and
2613 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2614 // lot of work, and there's some chance this is all a misunderstanding anyway.
2615 // We have to do *something*, though, since our signer may get mad at us for otherwise
2616 // jumping a remote commitment number, so best to just force-close and move on.
2617 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2620 #[cfg(any(test, feature = "fuzztarget"))]
2622 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2623 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2626 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2627 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2628 self.latest_monitor_update_id += 1;
2629 let mut monitor_update = ChannelMonitorUpdate {
2630 update_id: self.latest_monitor_update_id,
2631 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2632 idx: self.cur_counterparty_commitment_transaction_number + 1,
2633 secret: msg.per_commitment_secret,
2637 // Update state now that we've passed all the can-fail calls...
2638 // (note that we may still fail to generate the new commitment_signed message, but that's
2639 // OK, we step the channel here and *then* if the new generation fails we can fail the
2640 // channel based on that, but stepping stuff here should be safe either way.
2641 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2642 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2643 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2644 self.cur_counterparty_commitment_transaction_number -= 1;
2646 log_trace!(logger, "Updating HTLCs on receipt of RAA in channel {}...", log_bytes!(self.channel_id()));
2647 let mut to_forward_infos = Vec::new();
2648 let mut revoked_htlcs = Vec::new();
2649 let mut update_fail_htlcs = Vec::new();
2650 let mut update_fail_malformed_htlcs = Vec::new();
2651 let mut require_commitment = false;
2652 let mut value_to_self_msat_diff: i64 = 0;
2655 // Take references explicitly so that we can hold multiple references to self.
2656 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2657 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2659 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2660 pending_inbound_htlcs.retain(|htlc| {
2661 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2662 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2663 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2664 value_to_self_msat_diff += htlc.amount_msat as i64;
2669 pending_outbound_htlcs.retain(|htlc| {
2670 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2671 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2672 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2673 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2675 // They fulfilled, so we sent them money
2676 value_to_self_msat_diff -= htlc.amount_msat as i64;
2681 for htlc in pending_inbound_htlcs.iter_mut() {
2682 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2684 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2688 let mut state = InboundHTLCState::Committed;
2689 mem::swap(&mut state, &mut htlc.state);
2691 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2692 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to AwaitingAnnouncedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2693 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2694 require_commitment = true;
2695 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2696 match forward_info {
2697 PendingHTLCStatus::Fail(fail_msg) => {
2698 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to LocalRemoved due to PendingHTLCStatus indicating failure", log_bytes!(htlc.payment_hash.0));
2699 require_commitment = true;
2701 HTLCFailureMsg::Relay(msg) => {
2702 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2703 update_fail_htlcs.push(msg)
2705 HTLCFailureMsg::Malformed(msg) => {
2706 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2707 update_fail_malformed_htlcs.push(msg)
2711 PendingHTLCStatus::Forward(forward_info) => {
2712 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2713 to_forward_infos.push((forward_info, htlc.htlc_id));
2714 htlc.state = InboundHTLCState::Committed;
2720 for htlc in pending_outbound_htlcs.iter_mut() {
2721 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2722 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2723 htlc.state = OutboundHTLCState::Committed;
2725 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2726 Some(fail_reason.take())
2728 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2729 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2730 require_commitment = true;
2734 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2736 if self.is_outbound() {
2737 if let Some(feerate) = self.pending_update_fee.take() {
2738 self.feerate_per_kw = feerate;
2741 if let Some(feerate) = self.pending_update_fee {
2742 // Because a node cannot send two commitment_signeds in a row without getting a
2743 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2744 // it should use to create keys with) and because a node can't send a
2745 // commitment_signed without changes, checking if the feerate is equal to the
2746 // pending feerate update is sufficient to detect require_commitment.
2747 if feerate == self.feerate_per_kw {
2748 require_commitment = true;
2749 self.pending_update_fee = None;
2754 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2755 // We can't actually generate a new commitment transaction (incl by freeing holding
2756 // cells) while we can't update the monitor, so we just return what we have.
2757 if require_commitment {
2758 self.monitor_pending_commitment_signed = true;
2759 // When the monitor updating is restored we'll call get_last_commitment_update(),
2760 // which does not update state, but we're definitely now awaiting a remote revoke
2761 // before we can step forward any more, so set it here.
2762 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2763 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2764 // strictly increasing by one, so decrement it here.
2765 self.latest_monitor_update_id = monitor_update.update_id;
2766 monitor_update.updates.append(&mut additional_update.updates);
2768 self.monitor_pending_forwards.append(&mut to_forward_infos);
2769 self.monitor_pending_failures.append(&mut revoked_htlcs);
2770 log_debug!(logger, "Received a valid revoke_and_ack for channel {} but awaiting a monitor update resolution to reply.", log_bytes!(self.channel_id()));
2771 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2774 match self.free_holding_cell_htlcs(logger)? {
2775 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2776 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2777 for fail_msg in update_fail_htlcs.drain(..) {
2778 commitment_update.update_fail_htlcs.push(fail_msg);
2780 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2781 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2782 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2785 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2786 // strictly increasing by one, so decrement it here.
2787 self.latest_monitor_update_id = monitor_update.update_id;
2788 monitor_update.updates.append(&mut additional_update.updates);
2790 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2792 (None, htlcs_to_fail) => {
2793 if require_commitment {
2794 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2796 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2797 // strictly increasing by one, so decrement it here.
2798 self.latest_monitor_update_id = monitor_update.update_id;
2799 monitor_update.updates.append(&mut additional_update.updates);
2801 log_debug!(logger, "Received a valid revoke_and_ack for channel {}. Responding with a commitment update with {} HTLCs failed.",
2802 log_bytes!(self.channel_id()), update_fail_htlcs.len() + update_fail_malformed_htlcs.len());
2803 Ok((Some(msgs::CommitmentUpdate {
2804 update_add_htlcs: Vec::new(),
2805 update_fulfill_htlcs: Vec::new(),
2807 update_fail_malformed_htlcs,
2810 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2812 log_debug!(logger, "Received a valid revoke_and_ack for channel {} with no reply necessary.", log_bytes!(self.channel_id()));
2813 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2820 /// Adds a pending update to this channel. See the doc for send_htlc for
2821 /// further details on the optionness of the return value.
2822 /// You MUST call send_commitment prior to any other calls on this Channel
2823 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2824 if !self.is_outbound() {
2825 panic!("Cannot send fee from inbound channel");
2827 if !self.is_usable() {
2828 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2830 if !self.is_live() {
2831 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2834 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2835 self.holding_cell_update_fee = Some(feerate_per_kw);
2839 debug_assert!(self.pending_update_fee.is_none());
2840 self.pending_update_fee = Some(feerate_per_kw);
2842 Some(msgs::UpdateFee {
2843 channel_id: self.channel_id,
2848 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 {
2849 match self.send_update_fee(feerate_per_kw) {
2850 Some(update_fee) => {
2851 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2852 Ok(Some((update_fee, commitment_signed, monitor_update)))
2858 /// Removes any uncommitted inbound HTLCs and resets the state of uncommitted outbound HTLC
2859 /// updates, to be used on peer disconnection. After this, update_*_htlc messages need to be
2861 /// No further message handling calls may be made until a channel_reestablish dance has
2863 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) where L::Target: Logger {
2864 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2865 if self.channel_state < ChannelState::FundingSent as u32 {
2866 self.channel_state = ChannelState::ShutdownComplete as u32;
2869 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2870 // will be retransmitted.
2871 self.last_sent_closing_fee = None;
2873 let mut inbound_drop_count = 0;
2874 self.pending_inbound_htlcs.retain(|htlc| {
2876 InboundHTLCState::RemoteAnnounced(_) => {
2877 // They sent us an update_add_htlc but we never got the commitment_signed.
2878 // We'll tell them what commitment_signed we're expecting next and they'll drop
2879 // this HTLC accordingly
2880 inbound_drop_count += 1;
2883 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2884 // We received a commitment_signed updating this HTLC and (at least hopefully)
2885 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2886 // in response to it yet, so don't touch it.
2889 InboundHTLCState::Committed => true,
2890 InboundHTLCState::LocalRemoved(_) => {
2891 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2892 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2893 // (that we missed). Keep this around for now and if they tell us they missed
2894 // the commitment_signed we can re-transmit the update then.
2899 self.next_counterparty_htlc_id -= inbound_drop_count;
2901 for htlc in self.pending_outbound_htlcs.iter_mut() {
2902 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2903 // They sent us an update to remove this but haven't yet sent the corresponding
2904 // commitment_signed, we need to move it back to Committed and they can re-send
2905 // the update upon reconnection.
2906 htlc.state = OutboundHTLCState::Committed;
2910 self.channel_state |= ChannelState::PeerDisconnected as u32;
2911 log_trace!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops on channel {}", inbound_drop_count, log_bytes!(self.channel_id()));
2914 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2915 /// updates are partially paused.
2916 /// This must be called immediately after the call which generated the ChannelMonitor update
2917 /// which failed. The messages which were generated from that call which generated the
2918 /// monitor update failure must *not* have been sent to the remote end, and must instead
2919 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2920 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)>) {
2921 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2922 self.monitor_pending_revoke_and_ack = resend_raa;
2923 self.monitor_pending_commitment_signed = resend_commitment;
2924 assert!(self.monitor_pending_forwards.is_empty());
2925 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2926 assert!(self.monitor_pending_failures.is_empty());
2927 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2928 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2931 /// Indicates that the latest ChannelMonitor update has been committed by the client
2932 /// successfully and we should restore normal operation. Returns messages which should be sent
2933 /// to the remote side.
2934 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 {
2935 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2936 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2938 let funding_broadcastable = if self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound() {
2939 self.funding_transaction.take()
2942 // We will never broadcast the funding transaction when we're in MonitorUpdateFailed (and
2943 // we assume the user never directly broadcasts the funding transaction and waits for us to
2944 // do it). Thus, we can only ever hit monitor_pending_funding_locked when we're an inbound
2945 // channel which failed to persist the monitor on funding_created, and we got the funding
2946 // transaction confirmed before the monitor was persisted.
2947 let funding_locked = if self.monitor_pending_funding_locked {
2948 assert!(!self.is_outbound(), "Funding transaction broadcast by the local client before it should have - LDK didn't do it!");
2949 self.monitor_pending_funding_locked = false;
2950 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2951 Some(msgs::FundingLocked {
2952 channel_id: self.channel_id(),
2953 next_per_commitment_point,
2957 let mut forwards = Vec::new();
2958 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2959 let mut failures = Vec::new();
2960 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2962 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2963 self.monitor_pending_revoke_and_ack = false;
2964 self.monitor_pending_commitment_signed = false;
2965 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, funding_broadcastable, funding_locked);
2968 let raa = if self.monitor_pending_revoke_and_ack {
2969 Some(self.get_last_revoke_and_ack())
2971 let commitment_update = if self.monitor_pending_commitment_signed {
2972 Some(self.get_last_commitment_update(logger))
2975 self.monitor_pending_revoke_and_ack = false;
2976 self.monitor_pending_commitment_signed = false;
2977 let order = self.resend_order.clone();
2978 log_debug!(logger, "Restored monitor updating in channel {} resulting in {}{} commitment update and {} RAA, with {} first",
2979 log_bytes!(self.channel_id()), if funding_broadcastable.is_some() { "a funding broadcastable, " } else { "" },
2980 if commitment_update.is_some() { "a" } else { "no" }, if raa.is_some() { "an" } else { "no" },
2981 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2982 (raa, commitment_update, order, forwards, failures, funding_broadcastable, funding_locked)
2985 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2986 where F::Target: FeeEstimator
2988 if self.is_outbound() {
2989 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2991 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2992 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2994 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2995 self.pending_update_fee = Some(msg.feerate_per_kw);
2996 self.update_time_counter += 1;
3000 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
3001 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3002 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
3003 msgs::RevokeAndACK {
3004 channel_id: self.channel_id,
3005 per_commitment_secret,
3006 next_per_commitment_point,
3010 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
3011 let mut update_add_htlcs = Vec::new();
3012 let mut update_fulfill_htlcs = Vec::new();
3013 let mut update_fail_htlcs = Vec::new();
3014 let mut update_fail_malformed_htlcs = Vec::new();
3016 for htlc in self.pending_outbound_htlcs.iter() {
3017 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
3018 update_add_htlcs.push(msgs::UpdateAddHTLC {
3019 channel_id: self.channel_id(),
3020 htlc_id: htlc.htlc_id,
3021 amount_msat: htlc.amount_msat,
3022 payment_hash: htlc.payment_hash,
3023 cltv_expiry: htlc.cltv_expiry,
3024 onion_routing_packet: (**onion_packet).clone(),
3029 for htlc in self.pending_inbound_htlcs.iter() {
3030 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
3032 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
3033 update_fail_htlcs.push(msgs::UpdateFailHTLC {
3034 channel_id: self.channel_id(),
3035 htlc_id: htlc.htlc_id,
3036 reason: err_packet.clone()
3039 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
3040 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
3041 channel_id: self.channel_id(),
3042 htlc_id: htlc.htlc_id,
3043 sha256_of_onion: sha256_of_onion.clone(),
3044 failure_code: failure_code.clone(),
3047 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3048 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
3049 channel_id: self.channel_id(),
3050 htlc_id: htlc.htlc_id,
3051 payment_preimage: payment_preimage.clone(),
3058 log_trace!(logger, "Regenerated latest commitment update in channel {} with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
3059 log_bytes!(self.channel_id()), update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
3060 msgs::CommitmentUpdate {
3061 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
3063 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,
3067 /// May panic if some calls other than message-handling calls (which will all Err immediately)
3068 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
3069 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 {
3070 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
3071 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
3072 // almost certainly indicates we are going to end up out-of-sync in some way, so we
3073 // just close here instead of trying to recover.
3074 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
3077 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
3078 msg.next_local_commitment_number == 0 {
3079 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
3082 if msg.next_remote_commitment_number > 0 {
3083 match msg.data_loss_protect {
3084 OptionalField::Present(ref data_loss) => {
3085 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
3086 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
3087 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
3088 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
3089 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
3091 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3092 return Err(ChannelError::CloseDelayBroadcast(
3093 "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()
3097 OptionalField::Absent => {}
3101 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
3102 // remaining cases either succeed or ErrorMessage-fail).
3103 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
3105 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
3106 assert!(self.shutdown_scriptpubkey.is_some());
3107 Some(msgs::Shutdown {
3108 channel_id: self.channel_id,
3109 scriptpubkey: self.get_closing_scriptpubkey(),
3113 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
3114 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
3115 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
3116 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3117 if msg.next_remote_commitment_number != 0 {
3118 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
3120 // Short circuit the whole handler as there is nothing we can resend them
3121 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3124 // We have OurFundingLocked set!
3125 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3126 return Ok((Some(msgs::FundingLocked {
3127 channel_id: self.channel_id(),
3128 next_per_commitment_point,
3129 }), None, None, None, RAACommitmentOrder::CommitmentFirst, Vec::new(), shutdown_msg));
3132 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
3133 // Remote isn't waiting on any RevokeAndACK from us!
3134 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
3136 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
3137 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3138 self.monitor_pending_revoke_and_ack = true;
3141 Some(self.get_last_revoke_and_ack())
3144 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
3147 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
3148 // revoke_and_ack, not on sending commitment_signed, so we add one if have
3149 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
3150 // the corresponding revoke_and_ack back yet.
3151 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 };
3153 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
3154 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
3155 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3156 Some(msgs::FundingLocked {
3157 channel_id: self.channel_id(),
3158 next_per_commitment_point,
3162 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3163 if required_revoke.is_some() {
3164 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3166 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3169 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3170 // We're up-to-date and not waiting on a remote revoke (if we are our
3171 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3172 // have received some updates while we were disconnected. Free the holding cell
3174 match self.free_holding_cell_htlcs(logger) {
3175 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3176 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3177 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3178 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3180 Ok((None, htlcs_to_fail)) => {
3181 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), htlcs_to_fail, shutdown_msg));
3185 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3187 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3188 if required_revoke.is_some() {
3189 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3191 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3194 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3195 self.monitor_pending_commitment_signed = true;
3196 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3199 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), Vec::new(), shutdown_msg));
3201 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3205 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3206 where F::Target: FeeEstimator
3208 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3209 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3210 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3214 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3215 if self.feerate_per_kw > proposed_feerate {
3216 proposed_feerate = self.feerate_per_kw;
3218 assert!(self.shutdown_scriptpubkey.is_some());
3219 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3220 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3222 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3223 let sig = self.holder_signer
3224 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3226 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3227 if sig.is_none() { return None; }
3229 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3230 Some(msgs::ClosingSigned {
3231 channel_id: self.channel_id,
3232 fee_satoshis: total_fee_satoshis,
3233 signature: sig.unwrap(),
3237 pub fn shutdown<F: Deref, K: Deref>(
3238 &mut self, fee_estimator: &F, keys_provider: &K, their_features: &InitFeatures, msg: &msgs::Shutdown
3239 ) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3241 F::Target: FeeEstimator,
3242 K::Target: KeysInterface<Signer = Signer>
3244 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3245 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3247 if self.channel_state < ChannelState::FundingSent as u32 {
3248 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3249 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3250 // can do that via error message without getting a connection fail anyway...
3251 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3253 for htlc in self.pending_inbound_htlcs.iter() {
3254 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3255 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3258 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3260 let shutdown_scriptpubkey = match ShutdownScript::try_from((msg.scriptpubkey.clone(), their_features)) {
3261 Ok(script) => script.into_inner(),
3262 Err(_) => return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex()))),
3265 if self.counterparty_shutdown_scriptpubkey.is_some() {
3266 if Some(&shutdown_scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3267 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", shutdown_scriptpubkey.to_bytes().to_hex())));
3270 self.counterparty_shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3273 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3274 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3275 // any further commitment updates after we set LocalShutdownSent.
3276 let send_shutdown = (self.channel_state & ChannelState::LocalShutdownSent as u32) != ChannelState::LocalShutdownSent as u32;
3278 let shutdown_scriptpubkey = match self.shutdown_scriptpubkey {
3281 assert!(send_shutdown);
3282 let shutdown_scriptpubkey = keys_provider.get_shutdown_scriptpubkey();
3283 if !shutdown_scriptpubkey.is_compatible(their_features) {
3284 return Err(ChannelError::Close(format!("Provided a scriptpubkey format not accepted by peer. script: ({})", shutdown_scriptpubkey.clone().into_inner().to_bytes().to_hex())));
3286 Some(shutdown_scriptpubkey)
3290 // From here on out, we may not fail!
3292 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3293 self.update_time_counter += 1;
3295 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3296 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3297 // cell HTLCs and return them to fail the payment.
3298 self.holding_cell_update_fee = None;
3299 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3300 self.holding_cell_htlc_updates.retain(|htlc_update| {
3302 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3303 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3310 let monitor_update = match shutdown_scriptpubkey {
3311 Some(shutdown_scriptpubkey) => {
3312 self.shutdown_scriptpubkey = Some(shutdown_scriptpubkey);
3313 self.latest_monitor_update_id += 1;
3314 Some(ChannelMonitorUpdate {
3315 update_id: self.latest_monitor_update_id,
3316 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
3317 scriptpubkey: self.get_closing_scriptpubkey(),
3323 let shutdown = if send_shutdown {
3324 Some(msgs::Shutdown {
3325 channel_id: self.channel_id,
3326 scriptpubkey: self.get_closing_scriptpubkey(),
3330 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3331 self.update_time_counter += 1;
3333 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, dropped_outbound_htlcs))
3336 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3337 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3338 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3339 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3341 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3343 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3344 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3345 if funding_key[..] < counterparty_funding_key[..] {
3346 tx.input[0].witness.push(sig.serialize_der().to_vec());
3347 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3349 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3350 tx.input[0].witness.push(sig.serialize_der().to_vec());
3352 tx.input[0].witness[1].push(SigHashType::All as u8);
3353 tx.input[0].witness[2].push(SigHashType::All as u8);
3355 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3358 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3359 where F::Target: FeeEstimator
3361 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3362 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3364 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3365 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3367 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3368 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3370 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3371 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3374 let funding_redeemscript = self.get_funding_redeemscript();
3375 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3376 if used_total_fee != msg.fee_satoshis {
3377 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)));
3379 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3381 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3384 // The remote end may have decided to revoke their output due to inconsistent dust
3385 // limits, so check for that case by re-checking the signature here.
3386 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3387 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3388 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3392 let closing_tx_max_weight = self.get_closing_transaction_weight(
3393 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3394 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3395 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3396 if last_fee == msg.fee_satoshis {
3397 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3398 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3399 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3400 self.channel_state = ChannelState::ShutdownComplete as u32;
3401 self.update_time_counter += 1;
3402 return Ok((None, Some(closing_tx)));
3406 macro_rules! propose_new_feerate {
3407 ($new_feerate: expr) => {
3408 assert!(self.shutdown_scriptpubkey.is_some());
3409 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3410 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3411 let sig = self.holder_signer
3412 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3413 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3414 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3415 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3416 return Ok((Some(msgs::ClosingSigned {
3417 channel_id: self.channel_id,
3418 fee_satoshis: used_total_fee,
3424 let mut min_feerate = 253;
3425 if self.is_outbound() {
3426 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3427 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3428 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3429 if max_feerate <= last_feerate {
3430 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)));
3433 propose_new_feerate!(max_feerate);
3436 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3438 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3439 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3440 if min_feerate >= last_feerate {
3441 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)));
3444 propose_new_feerate!(min_feerate);
3447 let sig = self.holder_signer
3448 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3449 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3450 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3451 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3452 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3454 self.channel_state = ChannelState::ShutdownComplete as u32;
3455 self.update_time_counter += 1;
3457 Ok((Some(msgs::ClosingSigned {
3458 channel_id: self.channel_id,
3459 fee_satoshis: msg.fee_satoshis,
3461 }), Some(closing_tx)))
3464 // Public utilities:
3466 pub fn channel_id(&self) -> [u8; 32] {
3470 pub fn minimum_depth(&self) -> Option<u32> {
3474 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3475 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3476 pub fn get_user_id(&self) -> u64 {
3480 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3481 /// is_usable() returns true).
3482 /// Allowed in any state (including after shutdown)
3483 pub fn get_short_channel_id(&self) -> Option<u64> {
3484 self.short_channel_id
3487 /// Returns the funding_txo we either got from our peer, or were given by
3488 /// get_outbound_funding_created.
3489 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3490 self.channel_transaction_parameters.funding_outpoint
3493 fn get_holder_selected_contest_delay(&self) -> u16 {
3494 self.channel_transaction_parameters.holder_selected_contest_delay
3497 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3498 &self.channel_transaction_parameters.holder_pubkeys
3501 pub fn get_counterparty_selected_contest_delay(&self) -> Option<u16> {
3502 self.channel_transaction_parameters.counterparty_parameters
3503 .as_ref().map(|params| params.selected_contest_delay)
3506 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3507 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3510 /// Allowed in any state (including after shutdown)
3511 pub fn get_counterparty_node_id(&self) -> PublicKey {
3512 self.counterparty_node_id
3515 /// Allowed in any state (including after shutdown)
3517 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3518 self.holder_htlc_minimum_msat
3521 /// Allowed in any state (including after shutdown)
3522 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3524 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3525 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3526 // channel might have been used to route very small values (either by honest users or as DoS).
3527 self.channel_value_satoshis * 1000 * 9 / 10,
3529 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3533 /// Allowed in any state (including after shutdown)
3534 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3535 self.counterparty_htlc_minimum_msat
3538 pub fn get_value_satoshis(&self) -> u64 {
3539 self.channel_value_satoshis
3542 pub fn get_fee_proportional_millionths(&self) -> u32 {
3543 self.config.forwarding_fee_proportional_millionths
3546 pub fn get_cltv_expiry_delta(&self) -> u16 {
3547 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3551 pub fn get_feerate(&self) -> u32 {
3555 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3556 self.cur_holder_commitment_transaction_number + 1
3559 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3560 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3563 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3564 self.cur_counterparty_commitment_transaction_number + 2
3568 pub fn get_signer(&self) -> &Signer {
3573 pub fn get_value_stat(&self) -> ChannelValueStat {
3575 value_to_self_msat: self.value_to_self_msat,
3576 channel_value_msat: self.channel_value_satoshis * 1000,
3577 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000,
3578 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3579 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3580 holding_cell_outbound_amount_msat: {
3582 for h in self.holding_cell_htlc_updates.iter() {
3584 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3592 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3593 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3597 /// Allowed in any state (including after shutdown)
3598 pub fn get_update_time_counter(&self) -> u32 {
3599 self.update_time_counter
3602 pub fn get_latest_monitor_update_id(&self) -> u64 {
3603 self.latest_monitor_update_id
3606 pub fn should_announce(&self) -> bool {
3607 self.config.announced_channel
3610 pub fn is_outbound(&self) -> bool {
3611 self.channel_transaction_parameters.is_outbound_from_holder
3614 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3615 /// Allowed in any state (including after shutdown)
3616 pub fn get_outbound_forwarding_fee_base_msat(&self) -> u32 {
3617 self.config.forwarding_fee_base_msat
3620 /// Returns true if we've ever received a message from the remote end for this Channel
3621 pub fn have_received_message(&self) -> bool {
3622 self.channel_state > (ChannelState::OurInitSent as u32)
3625 /// Returns true if this channel is fully established and not known to be closing.
3626 /// Allowed in any state (including after shutdown)
3627 pub fn is_usable(&self) -> bool {
3628 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3629 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3632 /// Returns true if this channel is currently available for use. This is a superset of
3633 /// is_usable() and considers things like the channel being temporarily disabled.
3634 /// Allowed in any state (including after shutdown)
3635 pub fn is_live(&self) -> bool {
3636 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32) == 0)
3639 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3640 /// Allowed in any state (including after shutdown)
3641 pub fn is_awaiting_monitor_update(&self) -> bool {
3642 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3645 /// Returns true if funding_created was sent/received.
3646 pub fn is_funding_initiated(&self) -> bool {
3647 self.channel_state >= ChannelState::FundingSent as u32
3650 /// Returns true if this channel is fully shut down. True here implies that no further actions
3651 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3652 /// will be handled appropriately by the chain monitor.
3653 pub fn is_shutdown(&self) -> bool {
3654 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3655 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3660 pub fn channel_update_status(&self) -> ChannelUpdateStatus {
3661 self.channel_update_status
3664 pub fn set_channel_update_status(&mut self, status: ChannelUpdateStatus) {
3665 self.channel_update_status = status;
3668 fn check_get_funding_locked(&mut self, height: u32) -> Option<msgs::FundingLocked> {
3669 if self.funding_tx_confirmation_height == 0 {
3673 let funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3674 if funding_tx_confirmations <= 0 {
3675 self.funding_tx_confirmation_height = 0;
3678 if funding_tx_confirmations < self.minimum_depth.unwrap_or(0) as i64 {
3682 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3683 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3684 self.channel_state |= ChannelState::OurFundingLocked as u32;
3686 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3687 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3688 self.update_time_counter += 1;
3690 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3691 // We got a reorg but not enough to trigger a force close, just ignore.
3693 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3694 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3696 // We got a reorg but not enough to trigger a force close, just ignore.
3700 if need_commitment_update {
3701 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3702 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3703 return Some(msgs::FundingLocked {
3704 channel_id: self.channel_id,
3705 next_per_commitment_point,
3708 self.monitor_pending_funding_locked = true;
3714 /// When a transaction is confirmed, we check whether it is or spends the funding transaction
3715 /// In the first case, we store the confirmation height and calculating the short channel id.
3716 /// In the second, we simply return an Err indicating we need to be force-closed now.
3717 pub fn transactions_confirmed<L: Deref>(&mut self, block_hash: &BlockHash, height: u32, txdata: &TransactionData, logger: &L)
3718 -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> where L::Target: Logger {
3719 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3720 for &(index_in_block, tx) in txdata.iter() {
3721 if let Some(funding_txo) = self.get_funding_txo() {
3722 // If we haven't yet sent a funding_locked, but are in FundingSent (ignoring
3723 // whether they've sent a funding_locked or not), check if we should send one.
3724 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3725 if tx.txid() == funding_txo.txid {
3726 let txo_idx = funding_txo.index as usize;
3727 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3728 tx.output[txo_idx].value != self.channel_value_satoshis {
3729 if self.is_outbound() {
3730 // If we generated the funding transaction and it doesn't match what it
3731 // should, the client is really broken and we should just panic and
3732 // tell them off. That said, because hash collisions happen with high
3733 // probability in fuzztarget mode, if we're fuzzing we just close the
3734 // channel and move on.
3735 #[cfg(not(feature = "fuzztarget"))]
3736 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3738 self.update_time_counter += 1;
3739 return Err(msgs::ErrorMessage {
3740 channel_id: self.channel_id(),
3741 data: "funding tx had wrong script/value or output index".to_owned()
3744 if self.is_outbound() {
3745 for input in tx.input.iter() {
3746 if input.witness.is_empty() {
3747 // We generated a malleable funding transaction, implying we've
3748 // just exposed ourselves to funds loss to our counterparty.
3749 #[cfg(not(feature = "fuzztarget"))]
3750 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3754 self.funding_tx_confirmation_height = height;
3755 self.funding_tx_confirmed_in = Some(*block_hash);
3756 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3757 Ok(scid) => Some(scid),
3758 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3762 // If we allow 1-conf funding, we may need to check for funding_locked here and
3763 // send it immediately instead of waiting for a best_block_updated call (which
3764 // may have already happened for this block).
3765 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3766 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3767 return Ok(Some(funding_locked));
3770 for inp in tx.input.iter() {
3771 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
3772 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()));
3773 return Err(msgs::ErrorMessage {
3774 channel_id: self.channel_id(),
3775 data: "Commitment or closing transaction was confirmed on chain.".to_owned()
3784 /// When a new block is connected, we check the height of the block against outbound holding
3785 /// cell HTLCs in case we need to give up on them prematurely and time them out. Everything
3786 /// else (e.g. commitment transaction broadcasts, HTLC transaction broadcasting, etc) is
3787 /// handled by the ChannelMonitor.
3789 /// If we return Err, the channel may have been closed, at which point the standard
3790 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3793 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3795 pub fn best_block_updated<L: Deref>(&mut self, height: u32, highest_header_time: u32, logger: &L)
3796 -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> where L::Target: Logger {
3797 let mut timed_out_htlcs = Vec::new();
3798 let unforwarded_htlc_cltv_limit = height + HTLC_FAIL_BACK_BUFFER;
3799 self.holding_cell_htlc_updates.retain(|htlc_update| {
3801 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3802 if *cltv_expiry <= unforwarded_htlc_cltv_limit {
3803 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3811 self.update_time_counter = cmp::max(self.update_time_counter, highest_header_time);
3813 if let Some(funding_locked) = self.check_get_funding_locked(height) {
3814 log_info!(logger, "Sending a funding_locked to our peer for channel {}", log_bytes!(self.channel_id));
3815 return Ok((Some(funding_locked), timed_out_htlcs));
3818 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3819 if non_shutdown_state >= ChannelState::ChannelFunded as u32 ||
3820 (non_shutdown_state & ChannelState::OurFundingLocked as u32) == ChannelState::OurFundingLocked as u32 {
3821 let mut funding_tx_confirmations = height as i64 - self.funding_tx_confirmation_height as i64 + 1;
3822 if self.funding_tx_confirmation_height == 0 {
3823 // Note that check_get_funding_locked may reset funding_tx_confirmation_height to
3824 // zero if it has been reorged out, however in either case, our state flags
3825 // indicate we've already sent a funding_locked
3826 funding_tx_confirmations = 0;
3829 // If we've sent funding_locked (or have both sent and received funding_locked), and
3830 // the funding transaction's confirmation count has dipped below minimum_depth / 2,
3831 // close the channel and hope we can get the latest state on chain (because presumably
3832 // the funding transaction is at least still in the mempool of most nodes).
3833 if funding_tx_confirmations < self.minimum_depth.unwrap() as i64 / 2 {
3834 return Err(msgs::ErrorMessage {
3835 channel_id: self.channel_id(),
3836 data: format!("Funding transaction was un-confirmed. Locked at {} confs, now have {} confs.", self.minimum_depth.unwrap(), funding_tx_confirmations),
3841 Ok((None, timed_out_htlcs))
3844 /// Indicates the funding transaction is no longer confirmed in the main chain. This may
3845 /// force-close the channel, but may also indicate a harmless reorganization of a block or two
3846 /// before the channel has reached funding_locked and we can just wait for more blocks.
3847 pub fn funding_transaction_unconfirmed<L: Deref>(&mut self, logger: &L) -> Result<(), msgs::ErrorMessage> where L::Target: Logger {
3848 if self.funding_tx_confirmation_height != 0 {
3849 // We handle the funding disconnection by calling best_block_updated with a height one
3850 // below where our funding was connected, implying a reorg back to conf_height - 1.
3851 let reorg_height = self.funding_tx_confirmation_height - 1;
3852 // We use the time field to bump the current time we set on channel updates if its
3853 // larger. If we don't know that time has moved forward, we can just set it to the last
3854 // time we saw and it will be ignored.
3855 let best_time = self.update_time_counter;
3856 match self.best_block_updated(reorg_height, best_time, logger) {
3857 Ok((funding_locked, timed_out_htlcs)) => {
3858 assert!(funding_locked.is_none(), "We can't generate a funding with 0 confirmations?");
3859 assert!(timed_out_htlcs.is_empty(), "We can't have accepted HTLCs with a timeout before our funding confirmation?");
3865 // We never learned about the funding confirmation anyway, just ignore
3870 // Methods to get unprompted messages to send to the remote end (or where we already returned
3871 // something in the handler for the message that prompted this message):
3873 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3874 if !self.is_outbound() {
3875 panic!("Tried to open a channel for an inbound channel?");
3877 if self.channel_state != ChannelState::OurInitSent as u32 {
3878 panic!("Cannot generate an open_channel after we've moved forward");
3881 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3882 panic!("Tried to send an open_channel for a channel that has already advanced");
3885 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3886 let keys = self.get_holder_pubkeys();
3890 temporary_channel_id: self.channel_id,
3891 funding_satoshis: self.channel_value_satoshis,
3892 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3893 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3894 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3895 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3896 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3897 feerate_per_kw: self.feerate_per_kw as u32,
3898 to_self_delay: self.get_holder_selected_contest_delay(),
3899 max_accepted_htlcs: OUR_MAX_HTLCS,
3900 funding_pubkey: keys.funding_pubkey,
3901 revocation_basepoint: keys.revocation_basepoint,
3902 payment_point: keys.payment_point,
3903 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3904 htlc_basepoint: keys.htlc_basepoint,
3905 first_per_commitment_point,
3906 channel_flags: if self.config.announced_channel {1} else {0},
3907 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
3908 Some(script) => script.clone().into_inner(),
3909 None => Builder::new().into_script(),
3914 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3915 if self.is_outbound() {
3916 panic!("Tried to send accept_channel for an outbound channel?");
3918 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3919 panic!("Tried to send accept_channel after channel had moved forward");
3921 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3922 panic!("Tried to send an accept_channel for a channel that has already advanced");
3925 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3926 let keys = self.get_holder_pubkeys();
3928 msgs::AcceptChannel {
3929 temporary_channel_id: self.channel_id,
3930 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3931 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3932 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3933 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3934 minimum_depth: self.minimum_depth.unwrap(),
3935 to_self_delay: self.get_holder_selected_contest_delay(),
3936 max_accepted_htlcs: OUR_MAX_HTLCS,
3937 funding_pubkey: keys.funding_pubkey,
3938 revocation_basepoint: keys.revocation_basepoint,
3939 payment_point: keys.payment_point,
3940 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3941 htlc_basepoint: keys.htlc_basepoint,
3942 first_per_commitment_point,
3943 shutdown_scriptpubkey: OptionalField::Present(match &self.shutdown_scriptpubkey {
3944 Some(script) => script.clone().into_inner(),
3945 None => Builder::new().into_script(),
3950 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3951 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3952 let counterparty_keys = self.build_remote_transaction_keys()?;
3953 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;
3954 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3955 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3958 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3959 /// a funding_created message for the remote peer.
3960 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3961 /// or if called on an inbound channel.
3962 /// Note that channel_id changes during this call!
3963 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3964 /// If an Err is returned, it is a ChannelError::Close.
3965 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 {
3966 if !self.is_outbound() {
3967 panic!("Tried to create outbound funding_created message on an inbound channel!");
3969 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3970 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)");
3972 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3973 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3974 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3975 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3978 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3979 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3981 let signature = match self.get_outbound_funding_created_signature(logger) {
3984 log_error!(logger, "Got bad signatures: {:?}!", e);
3985 self.channel_transaction_parameters.funding_outpoint = None;
3990 let temporary_channel_id = self.channel_id;
3992 // Now that we're past error-generating stuff, update our local state:
3994 self.channel_state = ChannelState::FundingCreated as u32;
3995 self.channel_id = funding_txo.to_channel_id();
3996 self.funding_transaction = Some(funding_transaction);
3998 Ok(msgs::FundingCreated {
3999 temporary_channel_id,
4000 funding_txid: funding_txo.txid,
4001 funding_output_index: funding_txo.index,
4006 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
4007 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
4008 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
4009 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
4010 /// Will only fail if we're not in a state where channel_announcement may be sent (including
4012 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
4013 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
4015 /// This will only return ChannelError::Ignore upon failure.
4016 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
4017 if !self.config.announced_channel {
4018 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
4020 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
4021 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
4023 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
4024 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
4027 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
4029 let msg = msgs::UnsignedChannelAnnouncement {
4030 features: ChannelFeatures::known(),
4032 short_channel_id: self.get_short_channel_id().unwrap(),
4033 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
4034 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
4035 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
4036 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
4037 excess_data: Vec::new(),
4040 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
4041 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
4046 /// Signs the given channel announcement, returning a ChannelError::Ignore if no keys are
4048 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> {
4049 if let Some((their_node_sig, their_bitcoin_sig)) = self.announcement_sigs {
4050 let were_node_one = announcement.node_id_1 == our_node_id;
4052 let our_node_sig = self.secp_ctx.sign(&msghash, our_node_secret);
4053 Ok(msgs::ChannelAnnouncement {
4054 node_signature_1: if were_node_one { our_node_sig } else { their_node_sig },
4055 node_signature_2: if were_node_one { their_node_sig } else { our_node_sig },
4056 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { their_bitcoin_sig },
4057 bitcoin_signature_2: if were_node_one { their_bitcoin_sig } else { our_bitcoin_sig },
4058 contents: announcement,
4061 Err(ChannelError::Ignore("Attempted to sign channel announcement before we'd received announcement_signatures".to_string()))
4065 /// Processes an incoming announcement_signatures message, providing a fully-signed
4066 /// channel_announcement message which we can broadcast and storing our counterparty's
4067 /// signatures for later reconstruction/rebroadcast of the channel_announcement.
4068 pub fn announcement_signatures(&mut self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash, msg: &msgs::AnnouncementSignatures) -> Result<msgs::ChannelAnnouncement, ChannelError> {
4069 let (announcement, our_bitcoin_sig) = self.get_channel_announcement(our_node_id.clone(), chain_hash)?;
4071 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4073 if self.secp_ctx.verify(&msghash, &msg.node_signature, &self.get_counterparty_node_id()).is_err() {
4074 return Err(ChannelError::Close(format!(
4075 "Bad announcement_signatures. Failed to verify node_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}",
4076 &announcement, self.get_counterparty_node_id())));
4078 if self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, self.counterparty_funding_pubkey()).is_err() {
4079 return Err(ChannelError::Close(format!(
4080 "Bad announcement_signatures. Failed to verify bitcoin_signature. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})",
4081 &announcement, self.counterparty_funding_pubkey())));
4084 self.announcement_sigs = Some((msg.node_signature, msg.bitcoin_signature));
4086 self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig)
4089 /// Gets a signed channel_announcement for this channel, if we previously received an
4090 /// announcement_signatures from our counterparty.
4091 pub fn get_signed_channel_announcement(&self, our_node_secret: &SecretKey, our_node_id: PublicKey, chain_hash: BlockHash) -> Option<msgs::ChannelAnnouncement> {
4092 let (announcement, our_bitcoin_sig) = match self.get_channel_announcement(our_node_id.clone(), chain_hash) {
4094 Err(_) => return None,
4096 let msghash = hash_to_message!(&Sha256d::hash(&announcement.encode()[..])[..]);
4097 match self.sign_channel_announcement(our_node_secret, our_node_id, msghash, announcement, our_bitcoin_sig) {
4098 Ok(res) => Some(res),
4103 /// May panic if called on a channel that wasn't immediately-previously
4104 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
4105 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
4106 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
4107 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
4108 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
4109 // current to_remote balances. However, it no longer has any use, and thus is now simply
4110 // set to a dummy (but valid, as required by the spec) public key.
4111 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
4112 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
4113 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
4114 let mut pk = [2; 33]; pk[1] = 0xff;
4115 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
4116 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
4117 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
4118 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()));
4119 OptionalField::Present(DataLossProtect {
4120 your_last_per_commitment_secret: remote_last_secret,
4121 my_current_per_commitment_point: dummy_pubkey
4124 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret for channel {}", log_bytes!(self.channel_id()));
4125 OptionalField::Present(DataLossProtect {
4126 your_last_per_commitment_secret: [0;32],
4127 my_current_per_commitment_point: dummy_pubkey,
4130 msgs::ChannelReestablish {
4131 channel_id: self.channel_id(),
4132 // The protocol has two different commitment number concepts - the "commitment
4133 // transaction number", which starts from 0 and counts up, and the "revocation key
4134 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
4135 // commitment transaction numbers by the index which will be used to reveal the
4136 // revocation key for that commitment transaction, which means we have to convert them
4137 // to protocol-level commitment numbers here...
4139 // next_local_commitment_number is the next commitment_signed number we expect to
4140 // receive (indicating if they need to resend one that we missed).
4141 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
4142 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
4143 // receive, however we track it by the next commitment number for a remote transaction
4144 // (which is one further, as they always revoke previous commitment transaction, not
4145 // the one we send) so we have to decrement by 1. Note that if
4146 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
4147 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
4149 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
4155 // Send stuff to our remote peers:
4157 /// Adds a pending outbound HTLC to this channel, note that you probably want
4158 /// send_htlc_and_commit instead cause you'll want both messages at once.
4160 /// This returns an optional UpdateAddHTLC as we may be in a state where we cannot add HTLCs on
4162 /// * In cases where we're waiting on the remote peer to send us a revoke_and_ack, we
4163 /// wouldn't be able to determine what they actually ACK'ed if we have two sets of updates
4165 /// * In cases where we're marked MonitorUpdateFailed, we cannot commit to a new state as we
4166 /// may not yet have sent the previous commitment update messages and will need to regenerate
4169 /// You MUST call send_commitment prior to calling any other methods on this Channel!
4171 /// If an Err is returned, it's a ChannelError::Ignore!
4172 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> {
4173 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
4174 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
4176 let channel_total_msat = self.channel_value_satoshis * 1000;
4177 if amount_msat > channel_total_msat {
4178 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
4181 if amount_msat == 0 {
4182 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
4185 if amount_msat < self.counterparty_htlc_minimum_msat {
4186 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
4189 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) != 0 {
4190 // Note that this should never really happen, if we're !is_live() on receipt of an
4191 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
4192 // the user to send directly into a !is_live() channel. However, if we
4193 // disconnected during the time the previous hop was doing the commitment dance we may
4194 // end up getting here after the forwarding delay. In any case, returning an
4195 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
4196 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected from channel counterparty".to_owned()));
4199 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
4200 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
4201 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
4203 // Check their_max_htlc_value_in_flight_msat
4204 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
4205 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)));
4208 if !self.is_outbound() {
4209 // Check that we won't violate the remote channel reserve by adding this HTLC.
4210 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
4211 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
4212 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4213 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4214 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
4215 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
4219 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
4220 if pending_value_to_self_msat < amount_msat {
4221 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)));
4224 // `2 *` and extra HTLC are for the fee spike buffer.
4225 let commit_tx_fee_msat = if self.is_outbound() {
4226 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
4227 2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
4229 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
4230 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)));
4233 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
4234 // reserve for the remote to have something to claim if we misbehave)
4235 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis.unwrap() * 1000;
4236 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
4237 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
4240 // Now update local state:
4241 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
4242 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
4247 onion_routing_packet,
4252 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
4253 htlc_id: self.next_holder_htlc_id,
4255 payment_hash: payment_hash.clone(),
4257 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
4261 let res = msgs::UpdateAddHTLC {
4262 channel_id: self.channel_id,
4263 htlc_id: self.next_holder_htlc_id,
4267 onion_routing_packet,
4269 self.next_holder_htlc_id += 1;
4274 /// Creates a signed commitment transaction to send to the remote peer.
4275 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
4276 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
4277 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
4278 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4279 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
4280 panic!("Cannot create commitment tx until channel is fully established");
4282 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
4283 panic!("Cannot create commitment tx until remote revokes their previous commitment");
4285 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
4286 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
4288 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
4289 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");
4291 let mut have_updates = self.pending_update_fee.is_some();
4292 for htlc in self.pending_outbound_htlcs.iter() {
4293 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4294 have_updates = true;
4296 if have_updates { break; }
4298 for htlc in self.pending_inbound_htlcs.iter() {
4299 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4300 have_updates = true;
4302 if have_updates { break; }
4305 panic!("Cannot create commitment tx until we have some updates to send");
4307 self.send_commitment_no_status_check(logger)
4309 /// Only fails in case of bad keys
4310 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4311 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4312 // fail to generate this, we still are at least at a position where upgrading their status
4314 for htlc in self.pending_inbound_htlcs.iter_mut() {
4315 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4316 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4318 if let Some(state) = new_state {
4322 for htlc in self.pending_outbound_htlcs.iter_mut() {
4323 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4324 Some(fail_reason.take())
4326 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4329 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4331 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4332 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4333 // Update state now that we've passed all the can-fail calls...
4334 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4335 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4336 (res, counterparty_commitment_tx, htlcs_no_ref)
4338 Err(e) => return Err(e),
4341 self.latest_monitor_update_id += 1;
4342 let monitor_update = ChannelMonitorUpdate {
4343 update_id: self.latest_monitor_update_id,
4344 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4345 commitment_txid: counterparty_commitment_txid,
4346 htlc_outputs: htlcs.clone(),
4347 commitment_number: self.cur_counterparty_commitment_transaction_number,
4348 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4351 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4352 Ok((res, monitor_update))
4355 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4356 /// when we shouldn't change HTLC/channel state.
4357 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4358 let mut feerate_per_kw = self.feerate_per_kw;
4359 if let Some(feerate) = self.pending_update_fee {
4360 if self.is_outbound() {
4361 feerate_per_kw = feerate;
4365 let counterparty_keys = self.build_remote_transaction_keys()?;
4366 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4367 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4368 let (signature, htlc_signatures);
4370 #[cfg(any(test, feature = "fuzztarget"))]
4372 if !self.is_outbound() {
4373 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4374 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4375 if let Some(info) = projected_commit_tx_info {
4376 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4377 if info.total_pending_htlcs == total_pending_htlcs
4378 && info.next_holder_htlc_id == self.next_holder_htlc_id
4379 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4380 && info.feerate == self.feerate_per_kw {
4381 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4382 assert_eq!(actual_fee, info.fee);
4389 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4390 for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4394 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4395 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4397 htlc_signatures = res.1;
4399 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {} in channel {}",
4400 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4401 &counterparty_commitment_txid, encode::serialize_hex(&self.get_funding_redeemscript()),
4402 log_bytes!(signature.serialize_compact()[..]), log_bytes!(self.channel_id()));
4404 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4405 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {} in channel {}",
4406 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)),
4407 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4408 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4409 log_bytes!(htlc_sig.serialize_compact()[..]), log_bytes!(self.channel_id()));
4413 Ok((msgs::CommitmentSigned {
4414 channel_id: self.channel_id,
4417 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4420 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4421 /// to send to the remote peer in one go.
4422 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4424 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 {
4425 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4426 Some(update_add_htlc) => {
4427 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4428 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4434 /// Get forwarding information for the counterparty.
4435 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4436 self.counterparty_forwarding_info.clone()
4439 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4440 if msg.contents.htlc_minimum_msat >= self.channel_value_satoshis * 1000 {
4441 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4443 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4444 fee_base_msat: msg.contents.fee_base_msat,
4445 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4446 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4452 /// Begins the shutdown process, getting a message for the remote peer and returning all
4453 /// holding cell HTLCs for payment failure.
4454 pub fn get_shutdown<K: Deref>(&mut self, keys_provider: &K) -> Result<(msgs::Shutdown, Option<ChannelMonitorUpdate>, Vec<(HTLCSource, PaymentHash)>), APIError>
4455 where K::Target: KeysInterface<Signer = Signer> {
4456 for htlc in self.pending_outbound_htlcs.iter() {
4457 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4458 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4461 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4462 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4463 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4465 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4466 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4469 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4470 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4471 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()});
4474 let monitor_update = if self.shutdown_scriptpubkey.is_none() {
4475 self.shutdown_scriptpubkey = Some(keys_provider.get_shutdown_scriptpubkey());
4476 self.latest_monitor_update_id += 1;
4477 Some(ChannelMonitorUpdate {
4478 update_id: self.latest_monitor_update_id,
4479 updates: vec![ChannelMonitorUpdateStep::ShutdownScript {
4480 scriptpubkey: self.get_closing_scriptpubkey(),
4485 // From here on out, we may not fail!
4486 if self.channel_state < ChannelState::FundingSent as u32 {
4487 self.channel_state = ChannelState::ShutdownComplete as u32;
4489 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4491 self.update_time_counter += 1;
4493 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4494 // our shutdown until we've committed all of the pending changes.
4495 self.holding_cell_update_fee = None;
4496 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4497 self.holding_cell_htlc_updates.retain(|htlc_update| {
4499 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4500 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4507 Ok((msgs::Shutdown {
4508 channel_id: self.channel_id,
4509 scriptpubkey: self.get_closing_scriptpubkey(),
4510 }, monitor_update, dropped_outbound_htlcs))
4513 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4514 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4515 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4516 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4517 /// immediately (others we will have to allow to time out).
4518 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4519 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4520 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4521 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4522 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4523 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4525 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4526 // return them to fail the payment.
4527 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4528 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4530 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4531 dropped_outbound_htlcs.push((source, payment_hash));
4536 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4537 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4538 // returning a channel monitor update here would imply a channel monitor update before
4539 // we even registered the channel monitor to begin with, which is invalid.
4540 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4541 // funding transaction, don't return a funding txo (which prevents providing the
4542 // monitor update to the user, even if we return one).
4543 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4544 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4545 self.latest_monitor_update_id += 1;
4546 Some((funding_txo, ChannelMonitorUpdate {
4547 update_id: self.latest_monitor_update_id,
4548 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4553 self.channel_state = ChannelState::ShutdownComplete as u32;
4554 self.update_time_counter += 1;
4555 (monitor_update, dropped_outbound_htlcs)
4559 const SERIALIZATION_VERSION: u8 = 2;
4560 const MIN_SERIALIZATION_VERSION: u8 = 1;
4562 impl_writeable_tlv_based_enum!(InboundHTLCRemovalReason,;
4568 impl Writeable for ChannelUpdateStatus {
4569 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4570 // We only care about writing out the current state as it was announced, ie only either
4571 // Enabled or Disabled. In the case of DisabledStaged, we most recently announced the
4572 // channel as enabled, so we write 0. For EnabledStaged, we similarly write a 1.
4574 ChannelUpdateStatus::Enabled => 0u8.write(writer)?,
4575 ChannelUpdateStatus::DisabledStaged => 0u8.write(writer)?,
4576 ChannelUpdateStatus::EnabledStaged => 1u8.write(writer)?,
4577 ChannelUpdateStatus::Disabled => 1u8.write(writer)?,
4583 impl Readable for ChannelUpdateStatus {
4584 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4585 Ok(match <u8 as Readable>::read(reader)? {
4586 0 => ChannelUpdateStatus::Enabled,
4587 1 => ChannelUpdateStatus::Disabled,
4588 _ => return Err(DecodeError::InvalidValue),
4593 impl<Signer: Sign> Writeable for Channel<Signer> {
4594 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4595 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4598 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4600 self.user_id.write(writer)?;
4602 // Write out the old serialization for the config object. This is read by version-1
4603 // deserializers, but we will read the version in the TLV at the end instead.
4604 self.config.forwarding_fee_proportional_millionths.write(writer)?;
4605 self.config.cltv_expiry_delta.write(writer)?;
4606 self.config.announced_channel.write(writer)?;
4607 self.config.commit_upfront_shutdown_pubkey.write(writer)?;
4609 self.channel_id.write(writer)?;
4610 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4611 self.channel_value_satoshis.write(writer)?;
4613 self.latest_monitor_update_id.write(writer)?;
4615 let mut key_data = VecWriter(Vec::new());
4616 self.holder_signer.write(&mut key_data)?;
4617 assert!(key_data.0.len() < core::usize::MAX);
4618 assert!(key_data.0.len() < core::u32::MAX as usize);
4619 (key_data.0.len() as u32).write(writer)?;
4620 writer.write_all(&key_data.0[..])?;
4622 // Write out the old serialization for shutdown_pubkey for backwards compatibility, if
4623 // deserialized from that format.
4624 match self.shutdown_scriptpubkey.as_ref().and_then(|script| script.as_legacy_pubkey()) {
4625 Some(shutdown_pubkey) => shutdown_pubkey.write(writer)?,
4626 None => [0u8; PUBLIC_KEY_SIZE].write(writer)?,
4628 self.destination_script.write(writer)?;
4630 self.cur_holder_commitment_transaction_number.write(writer)?;
4631 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4632 self.value_to_self_msat.write(writer)?;
4634 let mut dropped_inbound_htlcs = 0;
4635 for htlc in self.pending_inbound_htlcs.iter() {
4636 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4637 dropped_inbound_htlcs += 1;
4640 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4641 for htlc in self.pending_inbound_htlcs.iter() {
4642 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4645 htlc.htlc_id.write(writer)?;
4646 htlc.amount_msat.write(writer)?;
4647 htlc.cltv_expiry.write(writer)?;
4648 htlc.payment_hash.write(writer)?;
4650 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4651 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4653 htlc_state.write(writer)?;
4655 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4657 htlc_state.write(writer)?;
4659 &InboundHTLCState::Committed => {
4662 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4664 removal_reason.write(writer)?;
4669 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4670 for htlc in self.pending_outbound_htlcs.iter() {
4671 htlc.htlc_id.write(writer)?;
4672 htlc.amount_msat.write(writer)?;
4673 htlc.cltv_expiry.write(writer)?;
4674 htlc.payment_hash.write(writer)?;
4675 htlc.source.write(writer)?;
4677 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4679 onion_packet.write(writer)?;
4681 &OutboundHTLCState::Committed => {
4684 &OutboundHTLCState::RemoteRemoved(_) => {
4685 // Treat this as a Committed because we haven't received the CS - they'll
4686 // resend the claim/fail on reconnect as we all (hopefully) the missing CS.
4689 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4691 fail_reason.write(writer)?;
4693 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4695 fail_reason.write(writer)?;
4700 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4701 for update in self.holding_cell_htlc_updates.iter() {
4703 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4705 amount_msat.write(writer)?;
4706 cltv_expiry.write(writer)?;
4707 payment_hash.write(writer)?;
4708 source.write(writer)?;
4709 onion_routing_packet.write(writer)?;
4711 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4713 payment_preimage.write(writer)?;
4714 htlc_id.write(writer)?;
4716 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4718 htlc_id.write(writer)?;
4719 err_packet.write(writer)?;
4724 match self.resend_order {
4725 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4726 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4729 self.monitor_pending_funding_locked.write(writer)?;
4730 self.monitor_pending_revoke_and_ack.write(writer)?;
4731 self.monitor_pending_commitment_signed.write(writer)?;
4733 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4734 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4735 pending_forward.write(writer)?;
4736 htlc_id.write(writer)?;
4739 (self.monitor_pending_failures.len() as u64).write(writer)?;
4740 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4741 htlc_source.write(writer)?;
4742 payment_hash.write(writer)?;
4743 fail_reason.write(writer)?;
4746 self.pending_update_fee.write(writer)?;
4747 self.holding_cell_update_fee.write(writer)?;
4749 self.next_holder_htlc_id.write(writer)?;
4750 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4751 self.update_time_counter.write(writer)?;
4752 self.feerate_per_kw.write(writer)?;
4754 match self.last_sent_closing_fee {
4755 Some((feerate, fee, sig)) => {
4757 feerate.write(writer)?;
4761 None => 0u8.write(writer)?,
4764 self.funding_tx_confirmed_in.write(writer)?;
4765 self.funding_tx_confirmation_height.write(writer)?;
4766 self.short_channel_id.write(writer)?;
4768 self.counterparty_dust_limit_satoshis.write(writer)?;
4769 self.holder_dust_limit_satoshis.write(writer)?;
4770 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4772 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4773 self.counterparty_selected_channel_reserve_satoshis.unwrap_or(0).write(writer)?;
4775 self.counterparty_htlc_minimum_msat.write(writer)?;
4776 self.holder_htlc_minimum_msat.write(writer)?;
4777 self.counterparty_max_accepted_htlcs.write(writer)?;
4779 // Note that this field is ignored by 0.0.99+ as the TLV Optional variant is used instead.
4780 self.minimum_depth.unwrap_or(0).write(writer)?;
4782 match &self.counterparty_forwarding_info {
4785 info.fee_base_msat.write(writer)?;
4786 info.fee_proportional_millionths.write(writer)?;
4787 info.cltv_expiry_delta.write(writer)?;
4789 None => 0u8.write(writer)?
4792 self.channel_transaction_parameters.write(writer)?;
4793 self.funding_transaction.write(writer)?;
4795 self.counterparty_cur_commitment_point.write(writer)?;
4796 self.counterparty_prev_commitment_point.write(writer)?;
4797 self.counterparty_node_id.write(writer)?;
4799 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4801 self.commitment_secrets.write(writer)?;
4803 self.channel_update_status.write(writer)?;
4805 #[cfg(any(test, feature = "fuzztarget"))]
4806 (self.historical_inbound_htlc_fulfills.len() as u64).write(writer)?;
4807 #[cfg(any(test, feature = "fuzztarget"))]
4808 for htlc in self.historical_inbound_htlc_fulfills.iter() {
4809 htlc.write(writer)?;
4812 write_tlv_fields!(writer, {
4813 (0, self.announcement_sigs, option),
4814 // minimum_depth and counterparty_selected_channel_reserve_satoshis used to have a
4815 // default value instead of being Option<>al. Thus, to maintain compatibility we write
4816 // them twice, once with their original default values above, and once as an option
4817 // here. On the read side, old versions will simply ignore the odd-type entries here,
4818 // and new versions map the default values to None and allow the TLV entries here to
4820 (1, self.minimum_depth, option),
4821 (3, self.counterparty_selected_channel_reserve_satoshis, option),
4822 (5, self.config, required),
4823 (7, self.shutdown_scriptpubkey, option),
4830 const MAX_ALLOC_SIZE: usize = 64*1024;
4831 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4832 where K::Target: KeysInterface<Signer = Signer> {
4833 fn read<R : ::std::io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4834 let ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4836 let user_id = Readable::read(reader)?;
4838 let mut config = Some(ChannelConfig::default());
4840 // Read the old serialization of the ChannelConfig from version 0.0.98.
4841 config.as_mut().unwrap().forwarding_fee_proportional_millionths = Readable::read(reader)?;
4842 config.as_mut().unwrap().cltv_expiry_delta = Readable::read(reader)?;
4843 config.as_mut().unwrap().announced_channel = Readable::read(reader)?;
4844 config.as_mut().unwrap().commit_upfront_shutdown_pubkey = Readable::read(reader)?;
4846 // Read the 8 bytes of backwards-compatibility ChannelConfig data.
4847 let mut _val: u64 = Readable::read(reader)?;
4850 let channel_id = Readable::read(reader)?;
4851 let channel_state = Readable::read(reader)?;
4852 let channel_value_satoshis = Readable::read(reader)?;
4854 let latest_monitor_update_id = Readable::read(reader)?;
4856 let keys_len: u32 = Readable::read(reader)?;
4857 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4858 while keys_data.len() != keys_len as usize {
4859 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4860 let mut data = [0; 1024];
4861 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4862 reader.read_exact(read_slice)?;
4863 keys_data.extend_from_slice(read_slice);
4865 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4867 // Read the old serialization for shutdown_pubkey, preferring it for shutdown_scriptpubkey
4868 // over the TLV if valid.
4869 let mut shutdown_scriptpubkey = match <PublicKey as Readable>::read(reader) {
4870 Ok(pubkey) => Some(ShutdownScript::new_p2wpkh_from_pubkey(pubkey)),
4873 let destination_script = Readable::read(reader)?;
4875 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4876 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4877 let value_to_self_msat = Readable::read(reader)?;
4879 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4880 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4881 for _ in 0..pending_inbound_htlc_count {
4882 pending_inbound_htlcs.push(InboundHTLCOutput {
4883 htlc_id: Readable::read(reader)?,
4884 amount_msat: Readable::read(reader)?,
4885 cltv_expiry: Readable::read(reader)?,
4886 payment_hash: Readable::read(reader)?,
4887 state: match <u8 as Readable>::read(reader)? {
4888 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4889 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4890 3 => InboundHTLCState::Committed,
4891 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4892 _ => return Err(DecodeError::InvalidValue),
4897 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4898 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4899 for _ in 0..pending_outbound_htlc_count {
4900 pending_outbound_htlcs.push(OutboundHTLCOutput {
4901 htlc_id: Readable::read(reader)?,
4902 amount_msat: Readable::read(reader)?,
4903 cltv_expiry: Readable::read(reader)?,
4904 payment_hash: Readable::read(reader)?,
4905 source: Readable::read(reader)?,
4906 state: match <u8 as Readable>::read(reader)? {
4907 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4908 1 => OutboundHTLCState::Committed,
4909 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4910 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4911 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4912 _ => return Err(DecodeError::InvalidValue),
4917 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4918 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4919 for _ in 0..holding_cell_htlc_update_count {
4920 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4921 0 => HTLCUpdateAwaitingACK::AddHTLC {
4922 amount_msat: Readable::read(reader)?,
4923 cltv_expiry: Readable::read(reader)?,
4924 payment_hash: Readable::read(reader)?,
4925 source: Readable::read(reader)?,
4926 onion_routing_packet: Readable::read(reader)?,
4928 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4929 payment_preimage: Readable::read(reader)?,
4930 htlc_id: Readable::read(reader)?,
4932 2 => HTLCUpdateAwaitingACK::FailHTLC {
4933 htlc_id: Readable::read(reader)?,
4934 err_packet: Readable::read(reader)?,
4936 _ => return Err(DecodeError::InvalidValue),
4940 let resend_order = match <u8 as Readable>::read(reader)? {
4941 0 => RAACommitmentOrder::CommitmentFirst,
4942 1 => RAACommitmentOrder::RevokeAndACKFirst,
4943 _ => return Err(DecodeError::InvalidValue),
4946 let monitor_pending_funding_locked = Readable::read(reader)?;
4947 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4948 let monitor_pending_commitment_signed = Readable::read(reader)?;
4950 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4951 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4952 for _ in 0..monitor_pending_forwards_count {
4953 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4956 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4957 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4958 for _ in 0..monitor_pending_failures_count {
4959 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4962 let pending_update_fee = Readable::read(reader)?;
4963 let holding_cell_update_fee = Readable::read(reader)?;
4965 let next_holder_htlc_id = Readable::read(reader)?;
4966 let next_counterparty_htlc_id = Readable::read(reader)?;
4967 let update_time_counter = Readable::read(reader)?;
4968 let feerate_per_kw = Readable::read(reader)?;
4970 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4972 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4973 _ => return Err(DecodeError::InvalidValue),
4976 let funding_tx_confirmed_in = Readable::read(reader)?;
4977 let funding_tx_confirmation_height = Readable::read(reader)?;
4978 let short_channel_id = Readable::read(reader)?;
4980 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4981 let holder_dust_limit_satoshis = Readable::read(reader)?;
4982 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4983 let mut counterparty_selected_channel_reserve_satoshis = None;
4985 // Read the old serialization from version 0.0.98.
4986 counterparty_selected_channel_reserve_satoshis = Some(Readable::read(reader)?);
4988 // Read the 8 bytes of backwards-compatibility data.
4989 let _dummy: u64 = Readable::read(reader)?;
4991 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4992 let holder_htlc_minimum_msat = Readable::read(reader)?;
4993 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4995 let mut minimum_depth = None;
4997 // Read the old serialization from version 0.0.98.
4998 minimum_depth = Some(Readable::read(reader)?);
5000 // Read the 4 bytes of backwards-compatibility data.
5001 let _dummy: u32 = Readable::read(reader)?;
5004 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
5006 1 => Some(CounterpartyForwardingInfo {
5007 fee_base_msat: Readable::read(reader)?,
5008 fee_proportional_millionths: Readable::read(reader)?,
5009 cltv_expiry_delta: Readable::read(reader)?,
5011 _ => return Err(DecodeError::InvalidValue),
5014 let channel_parameters = Readable::read(reader)?;
5015 let funding_transaction = Readable::read(reader)?;
5017 let counterparty_cur_commitment_point = Readable::read(reader)?;
5019 let counterparty_prev_commitment_point = Readable::read(reader)?;
5020 let counterparty_node_id = Readable::read(reader)?;
5022 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
5023 let commitment_secrets = Readable::read(reader)?;
5025 let channel_update_status = Readable::read(reader)?;
5027 #[cfg(any(test, feature = "fuzztarget"))]
5028 let mut historical_inbound_htlc_fulfills = HashSet::new();
5029 #[cfg(any(test, feature = "fuzztarget"))]
5031 let htlc_fulfills_len: u64 = Readable::read(reader)?;
5032 for _ in 0..htlc_fulfills_len {
5033 assert!(historical_inbound_htlc_fulfills.insert(Readable::read(reader)?));
5037 let mut announcement_sigs = None;
5038 read_tlv_fields!(reader, {
5039 (0, announcement_sigs, option),
5040 (1, minimum_depth, option),
5041 (3, counterparty_selected_channel_reserve_satoshis, option),
5042 (5, config, option), // Note that if none is provided we will *not* overwrite the existing one.
5043 (7, shutdown_scriptpubkey, option),
5046 let mut secp_ctx = Secp256k1::new();
5047 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
5052 config: config.unwrap(),
5056 channel_value_satoshis,
5058 latest_monitor_update_id,
5061 shutdown_scriptpubkey,
5064 cur_holder_commitment_transaction_number,
5065 cur_counterparty_commitment_transaction_number,
5068 pending_inbound_htlcs,
5069 pending_outbound_htlcs,
5070 holding_cell_htlc_updates,
5074 monitor_pending_funding_locked,
5075 monitor_pending_revoke_and_ack,
5076 monitor_pending_commitment_signed,
5077 monitor_pending_forwards,
5078 monitor_pending_failures,
5081 holding_cell_update_fee,
5082 next_holder_htlc_id,
5083 next_counterparty_htlc_id,
5084 update_time_counter,
5087 #[cfg(debug_assertions)]
5088 holder_max_commitment_tx_output: Mutex::new((0, 0)),
5089 #[cfg(debug_assertions)]
5090 counterparty_max_commitment_tx_output: Mutex::new((0, 0)),
5092 last_sent_closing_fee,
5094 funding_tx_confirmed_in,
5095 funding_tx_confirmation_height,
5098 counterparty_dust_limit_satoshis,
5099 holder_dust_limit_satoshis,
5100 counterparty_max_htlc_value_in_flight_msat,
5101 counterparty_selected_channel_reserve_satoshis,
5102 counterparty_htlc_minimum_msat,
5103 holder_htlc_minimum_msat,
5104 counterparty_max_accepted_htlcs,
5107 counterparty_forwarding_info,
5109 channel_transaction_parameters: channel_parameters,
5110 funding_transaction,
5112 counterparty_cur_commitment_point,
5113 counterparty_prev_commitment_point,
5114 counterparty_node_id,
5116 counterparty_shutdown_scriptpubkey,
5120 channel_update_status,
5124 #[cfg(any(test, feature = "fuzztarget"))]
5125 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
5126 #[cfg(any(test, feature = "fuzztarget"))]
5127 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
5129 workaround_lnd_bug_4006: None,
5131 #[cfg(any(test, feature = "fuzztarget"))]
5132 historical_inbound_htlc_fulfills,
5139 use bitcoin::util::bip143;
5140 use bitcoin::consensus::encode::serialize;
5141 use bitcoin::blockdata::script::{Script, Builder};
5142 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
5143 use bitcoin::blockdata::constants::genesis_block;
5144 use bitcoin::blockdata::opcodes;
5145 use bitcoin::network::constants::Network;
5146 use bitcoin::hashes::hex::FromHex;
5148 use ln::{PaymentPreimage, PaymentHash};
5149 use ln::channelmanager::HTLCSource;
5150 use ln::channel::{Channel,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
5151 use ln::channel::MAX_FUNDING_SATOSHIS;
5152 use ln::features::InitFeatures;
5153 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
5154 use ln::script::ShutdownScript;
5156 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
5157 use chain::BestBlock;
5158 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
5159 use chain::keysinterface::{InMemorySigner, KeysInterface, BaseSign};
5160 use chain::transaction::OutPoint;
5161 use util::config::UserConfig;
5162 use util::enforcing_trait_impls::EnforcingSigner;
5163 use util::test_utils;
5164 use util::logger::Logger;
5165 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
5166 use bitcoin::secp256k1::ffi::Signature as FFISignature;
5167 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
5168 use bitcoin::secp256k1::recovery::RecoverableSignature;
5169 use bitcoin::hashes::sha256::Hash as Sha256;
5170 use bitcoin::hashes::Hash;
5171 use bitcoin::hash_types::{Txid, WPubkeyHash};
5175 struct TestFeeEstimator {
5178 impl FeeEstimator for TestFeeEstimator {
5179 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
5185 fn test_max_funding_satoshis() {
5186 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
5187 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
5191 signer: InMemorySigner,
5193 impl KeysInterface for Keys {
5194 type Signer = InMemorySigner;
5196 fn get_node_secret(&self) -> SecretKey { panic!(); }
5197 fn get_destination_script(&self) -> Script {
5198 let secp_ctx = Secp256k1::signing_only();
5199 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5200 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
5201 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
5204 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
5205 let secp_ctx = Secp256k1::signing_only();
5206 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
5207 ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key))
5210 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
5213 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
5214 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
5215 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { panic!(); }
5218 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
5219 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
5222 // Check that, during channel creation, we use the same feerate in the open channel message
5223 // as we do in the Channel object creation itself.
5225 fn test_open_channel_msg_fee() {
5226 let original_fee = 253;
5227 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
5228 let secp_ctx = Secp256k1::new();
5229 let seed = [42; 32];
5230 let network = Network::Testnet;
5231 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5233 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5234 let config = UserConfig::default();
5235 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5237 // Now change the fee so we can check that the fee in the open_channel message is the
5238 // same as the old fee.
5239 fee_est.fee_est = 500;
5240 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5241 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
5245 fn test_holder_vs_counterparty_dust_limit() {
5246 // Test that when calculating the local and remote commitment transaction fees, the correct
5247 // dust limits are used.
5248 let feeest = TestFeeEstimator{fee_est: 15000};
5249 let secp_ctx = Secp256k1::new();
5250 let seed = [42; 32];
5251 let network = Network::Testnet;
5252 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5254 // Go through the flow of opening a channel between two nodes, making sure
5255 // they have different dust limits.
5257 // Create Node A's channel pointing to Node B's pubkey
5258 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5259 let config = UserConfig::default();
5260 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5262 // Create Node B's channel by receiving Node A's open_channel message
5263 // Make sure A's dust limit is as we expect.
5264 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
5265 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5266 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
5268 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
5269 let mut accept_channel_msg = node_b_chan.get_accept_channel();
5270 accept_channel_msg.dust_limit_satoshis = 546;
5271 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5272 node_a_chan.holder_dust_limit_satoshis = 1560;
5274 // Put some inbound and outbound HTLCs in A's channel.
5275 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
5276 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
5278 amount_msat: htlc_amount_msat,
5279 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
5280 cltv_expiry: 300000000,
5281 state: InboundHTLCState::Committed,
5284 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
5286 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
5287 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
5288 cltv_expiry: 200000000,
5289 state: OutboundHTLCState::Committed,
5290 source: HTLCSource::OutboundRoute {
5292 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5293 first_hop_htlc_msat: 548,
5297 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
5298 // the dust limit check.
5299 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5300 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5301 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
5302 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
5304 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
5305 // of the HTLCs are seen to be above the dust limit.
5306 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
5307 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
5308 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
5309 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5310 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
5314 fn test_timeout_vs_success_htlc_dust_limit() {
5315 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
5316 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
5317 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
5318 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
5319 let fee_est = TestFeeEstimator{fee_est: 253 };
5320 let secp_ctx = Secp256k1::new();
5321 let seed = [42; 32];
5322 let network = Network::Testnet;
5323 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5325 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5326 let config = UserConfig::default();
5327 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5329 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
5330 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
5332 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
5333 // counted as dust when it shouldn't be.
5334 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
5335 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5336 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5337 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5339 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5340 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
5341 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5342 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
5343 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5345 chan.channel_transaction_parameters.is_outbound_from_holder = false;
5347 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
5348 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
5349 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
5350 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5351 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
5353 // If swapped: this HTLC would be counted as dust when it shouldn't be.
5354 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
5355 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
5356 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
5357 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
5361 fn channel_reestablish_no_updates() {
5362 let feeest = TestFeeEstimator{fee_est: 15000};
5363 let logger = test_utils::TestLogger::new();
5364 let secp_ctx = Secp256k1::new();
5365 let seed = [42; 32];
5366 let network = Network::Testnet;
5367 let best_block = BestBlock::from_genesis(network);
5368 let chain_hash = best_block.block_hash();
5369 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5371 // Go through the flow of opening a channel between two nodes.
5373 // Create Node A's channel pointing to Node B's pubkey
5374 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5375 let config = UserConfig::default();
5376 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5378 // Create Node B's channel by receiving Node A's open_channel message
5379 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
5380 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
5381 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();
5383 // Node B --> Node A: accept channel
5384 let accept_channel_msg = node_b_chan.get_accept_channel();
5385 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
5387 // Node A --> Node B: funding created
5388 let output_script = node_a_chan.get_funding_redeemscript();
5389 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5390 value: 10000000, script_pubkey: output_script.clone(),
5392 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5393 let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
5394 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&logger).unwrap();
5396 // Node B --> Node A: funding signed
5397 let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&logger);
5399 // Now disconnect the two nodes and check that the commitment point in
5400 // Node B's channel_reestablish message is sane.
5401 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5402 let msg = node_b_chan.get_channel_reestablish(&&logger);
5403 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5404 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5405 match msg.data_loss_protect {
5406 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5407 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5412 // Check that the commitment point in Node A's channel_reestablish message
5414 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5415 let msg = node_a_chan.get_channel_reestablish(&&logger);
5416 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5417 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5418 match msg.data_loss_protect {
5419 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5420 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5427 fn channel_update() {
5428 let feeest = TestFeeEstimator{fee_est: 15000};
5429 let secp_ctx = Secp256k1::new();
5430 let seed = [42; 32];
5431 let network = Network::Testnet;
5432 let chain_hash = genesis_block(network).header.block_hash();
5433 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5435 // Create a channel.
5436 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5437 let config = UserConfig::default();
5438 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), 10000000, 100000, 42, &config).unwrap();
5439 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5440 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5441 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5443 // Make sure that receiving a channel update will update the Channel as expected.
5444 let update = ChannelUpdate {
5445 contents: UnsignedChannelUpdate {
5447 short_channel_id: 0,
5450 cltv_expiry_delta: 100,
5451 htlc_minimum_msat: 5,
5452 htlc_maximum_msat: OptionalField::Absent,
5454 fee_proportional_millionths: 11,
5455 excess_data: Vec::new(),
5457 signature: Signature::from(unsafe { FFISignature::new() })
5459 node_a_chan.channel_update(&update).unwrap();
5461 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5462 // change our official htlc_minimum_msat.
5463 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5464 match node_a_chan.counterparty_forwarding_info() {
5466 assert_eq!(info.cltv_expiry_delta, 100);
5467 assert_eq!(info.fee_base_msat, 110);
5468 assert_eq!(info.fee_proportional_millionths, 11);
5470 None => panic!("expected counterparty forwarding info to be Some")
5475 fn outbound_commitment_test() {
5476 // Test vectors from BOLT 3 Appendix C:
5477 let feeest = TestFeeEstimator{fee_est: 15000};
5478 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5479 let secp_ctx = Secp256k1::new();
5481 let mut signer = InMemorySigner::new(
5483 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5484 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5485 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5486 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5487 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5489 // These aren't set in the test vectors:
5490 [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],
5495 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5496 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5497 let keys_provider = Keys { signer: signer.clone() };
5499 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5500 let mut config = UserConfig::default();
5501 config.channel_options.announced_channel = false;
5502 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, InitFeatures::known(), 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5503 chan.holder_dust_limit_satoshis = 546;
5504 chan.counterparty_selected_channel_reserve_satoshis = Some(0); // Filled in in accept_channel
5506 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5508 let counterparty_pubkeys = ChannelPublicKeys {
5509 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5510 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5511 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5512 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5513 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5515 chan.channel_transaction_parameters.counterparty_parameters = Some(
5516 CounterpartyChannelTransactionParameters {
5517 pubkeys: counterparty_pubkeys.clone(),
5518 selected_contest_delay: 144
5520 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5521 signer.ready_channel(&chan.channel_transaction_parameters);
5523 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5524 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5526 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5527 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5529 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5530 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5532 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5533 // derived from a commitment_seed, so instead we copy it here and call
5534 // build_commitment_transaction.
5535 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5536 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5537 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5538 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5539 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5541 macro_rules! test_commitment {
5542 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5543 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5545 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5546 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5548 let htlcs = res.2.drain(..)
5549 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5553 let trusted_tx = commitment_tx.trust();
5554 let unsigned_tx = trusted_tx.built_transaction();
5555 let redeemscript = chan.get_funding_redeemscript();
5556 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5557 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5558 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5560 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5561 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5562 let mut counterparty_htlc_sigs = Vec::new();
5563 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5565 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5566 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5567 counterparty_htlc_sigs.push(remote_signature);
5569 assert_eq!(htlcs.len(), per_htlc.len());
5571 let holder_commitment_tx = HolderCommitmentTransaction::new(
5572 commitment_tx.clone(),
5573 counterparty_signature,
5574 counterparty_htlc_sigs,
5575 &chan.holder_signer.pubkeys().funding_pubkey,
5576 chan.counterparty_funding_pubkey()
5578 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5579 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5581 let funding_redeemscript = chan.get_funding_redeemscript();
5582 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5583 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5585 // ((htlc, counterparty_sig), (index, holder_sig))
5586 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5589 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5591 let ref htlc = htlcs[$htlc_idx];
5592 let htlc_tx = chan_utils::build_htlc_transaction(&unsigned_tx.txid, chan.feerate_per_kw,
5593 chan.get_counterparty_selected_contest_delay().unwrap(),
5594 &htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
5595 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5596 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5597 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5599 let mut preimage: Option<PaymentPreimage> = None;
5602 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5603 if out == htlc.payment_hash {
5604 preimage = Some(PaymentPreimage([i; 32]));
5608 assert!(preimage.is_some());
5611 let htlc_sig = htlc_sig_iter.next().unwrap();
5612 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5614 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5615 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5616 let index = (htlc_sig.1).0;
5617 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5618 let trusted_tx = holder_commitment_tx.trust();
5619 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5620 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5622 assert!(htlc_sig_iter.next().is_none());
5626 // simple commitment tx with no HTLCs
5627 chan.value_to_self_msat = 7000000000;
5629 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5630 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5631 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5633 chan.pending_inbound_htlcs.push({
5634 let mut out = InboundHTLCOutput{
5636 amount_msat: 1000000,
5638 payment_hash: PaymentHash([0; 32]),
5639 state: InboundHTLCState::Committed,
5641 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5644 chan.pending_inbound_htlcs.push({
5645 let mut out = InboundHTLCOutput{
5647 amount_msat: 2000000,
5649 payment_hash: PaymentHash([0; 32]),
5650 state: InboundHTLCState::Committed,
5652 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5655 chan.pending_outbound_htlcs.push({
5656 let mut out = OutboundHTLCOutput{
5658 amount_msat: 2000000,
5660 payment_hash: PaymentHash([0; 32]),
5661 state: OutboundHTLCState::Committed,
5662 source: HTLCSource::dummy(),
5664 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5667 chan.pending_outbound_htlcs.push({
5668 let mut out = OutboundHTLCOutput{
5670 amount_msat: 3000000,
5672 payment_hash: PaymentHash([0; 32]),
5673 state: OutboundHTLCState::Committed,
5674 source: HTLCSource::dummy(),
5676 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5679 chan.pending_inbound_htlcs.push({
5680 let mut out = InboundHTLCOutput{
5682 amount_msat: 4000000,
5684 payment_hash: PaymentHash([0; 32]),
5685 state: InboundHTLCState::Committed,
5687 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5691 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5692 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5693 chan.feerate_per_kw = 0;
5695 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5696 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5697 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5700 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5701 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5702 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5705 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5706 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5707 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5710 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5711 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5712 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5715 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5716 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5717 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5720 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5721 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5722 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5725 // commitment tx with seven outputs untrimmed (maximum feerate)
5726 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5727 chan.feerate_per_kw = 647;
5729 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5730 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5731 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5734 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5735 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5736 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5739 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5740 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5741 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5744 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5745 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5746 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5749 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5750 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5751 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5754 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5755 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5756 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5759 // commitment tx with six outputs untrimmed (minimum feerate)
5760 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5761 chan.feerate_per_kw = 648;
5763 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5764 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5765 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5768 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5769 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5770 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5773 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5774 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5775 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5778 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5779 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5780 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5783 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5784 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5785 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5788 // commitment tx with six outputs untrimmed (maximum feerate)
5789 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5790 chan.feerate_per_kw = 2069;
5792 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5793 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5794 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5797 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5798 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5799 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5802 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5803 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5804 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5807 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5808 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5809 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5812 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5813 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5814 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5817 // commitment tx with five outputs untrimmed (minimum feerate)
5818 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5819 chan.feerate_per_kw = 2070;
5821 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5822 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5823 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5826 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5827 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5828 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5831 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5832 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5833 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5836 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5837 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5838 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5841 // commitment tx with five outputs untrimmed (maximum feerate)
5842 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5843 chan.feerate_per_kw = 2194;
5845 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5846 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5847 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5850 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5851 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5852 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5855 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5856 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5857 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5860 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5861 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5862 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5865 // commitment tx with four outputs untrimmed (minimum feerate)
5866 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5867 chan.feerate_per_kw = 2195;
5869 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5870 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5871 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5874 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5875 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5876 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5879 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5880 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5881 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5884 // commitment tx with four outputs untrimmed (maximum feerate)
5885 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5886 chan.feerate_per_kw = 3702;
5888 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5889 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5890 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5893 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5894 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5895 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5898 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5899 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5900 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5903 // commitment tx with three outputs untrimmed (minimum feerate)
5904 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5905 chan.feerate_per_kw = 3703;
5907 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5908 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5909 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5912 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5913 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5914 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5917 // commitment tx with three outputs untrimmed (maximum feerate)
5918 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5919 chan.feerate_per_kw = 4914;
5921 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5922 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5923 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5926 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5927 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5928 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5931 // commitment tx with two outputs untrimmed (minimum feerate)
5932 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5933 chan.feerate_per_kw = 4915;
5935 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5936 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5937 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5939 // commitment tx with two outputs untrimmed (maximum feerate)
5940 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5941 chan.feerate_per_kw = 9651180;
5943 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5944 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5945 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5947 // commitment tx with one output untrimmed (minimum feerate)
5948 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5949 chan.feerate_per_kw = 9651181;
5951 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5952 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5953 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5955 // commitment tx with fee greater than funder amount
5956 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5957 chan.feerate_per_kw = 9651936;
5959 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5960 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5961 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5963 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5964 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5965 chan.feerate_per_kw = 253;
5966 chan.pending_inbound_htlcs.clear();
5967 chan.pending_inbound_htlcs.push({
5968 let mut out = InboundHTLCOutput{
5970 amount_msat: 2000000,
5972 payment_hash: PaymentHash([0; 32]),
5973 state: InboundHTLCState::Committed,
5975 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5978 chan.pending_outbound_htlcs.clear();
5979 chan.pending_outbound_htlcs.push({
5980 let mut out = OutboundHTLCOutput{
5982 amount_msat: 5000000,
5984 payment_hash: PaymentHash([0; 32]),
5985 state: OutboundHTLCState::Committed,
5986 source: HTLCSource::dummy(),
5988 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5991 chan.pending_outbound_htlcs.push({
5992 let mut out = OutboundHTLCOutput{
5994 amount_msat: 5000000,
5996 payment_hash: PaymentHash([0; 32]),
5997 state: OutboundHTLCState::Committed,
5998 source: HTLCSource::dummy(),
6000 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
6004 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
6005 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
6006 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
6009 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
6010 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
6011 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
6013 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
6014 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
6015 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
6017 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
6018 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
6019 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
6024 fn test_per_commitment_secret_gen() {
6025 // Test vectors from BOLT 3 Appendix D:
6027 let mut seed = [0; 32];
6028 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
6029 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6030 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
6032 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
6033 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
6034 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
6036 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
6037 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
6039 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
6040 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
6042 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
6043 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
6044 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
6048 fn test_key_derivation() {
6049 // Test vectors from BOLT 3 Appendix E:
6050 let secp_ctx = Secp256k1::new();
6052 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
6053 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
6055 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
6056 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
6058 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
6059 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
6061 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6062 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
6064 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
6065 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
6067 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
6068 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
6070 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
6071 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());