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::block::BlockHeader;
11 use bitcoin::blockdata::script::{Script,Builder};
12 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
13 use bitcoin::blockdata::opcodes;
14 use bitcoin::util::bip143;
15 use bitcoin::consensus::encode;
17 use bitcoin::hashes::Hash;
18 use bitcoin::hashes::sha256::Hash as Sha256;
19 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
21 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
22 use bitcoin::secp256k1::{Secp256k1,Signature};
23 use bitcoin::secp256k1;
25 use ln::features::{ChannelFeatures, InitFeatures};
27 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
28 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MIN_CLTV_EXPIRY_DELTA, MAX_LOCAL_BREAKDOWN_TIMEOUT};
29 use ln::chan_utils::{CounterpartyCommitmentSecrets, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, CommitmentTransaction, HolderCommitmentTransaction, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, MAX_HTLCS, get_commitment_transaction_number_obscure_factor};
31 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
32 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
33 use chain::transaction::{OutPoint, TransactionData};
34 use chain::keysinterface::{Sign, KeysInterface};
35 use util::transaction_utils;
36 use util::ser::{Readable, ReadableArgs, Writeable, Writer, VecWriter};
37 use util::logger::Logger;
38 use util::errors::APIError;
39 use util::config::{UserConfig,ChannelConfig};
40 use util::scid_utils::scid_from_parts;
43 use std::{cmp,mem,fmt};
45 #[cfg(any(test, feature = "fuzztarget"))]
47 use bitcoin::hashes::hex::ToHex;
48 use bitcoin::blockdata::opcodes::all::OP_PUSHBYTES_0;
51 pub struct ChannelValueStat {
52 pub value_to_self_msat: u64,
53 pub channel_value_msat: u64,
54 pub channel_reserve_msat: u64,
55 pub pending_outbound_htlcs_amount_msat: u64,
56 pub pending_inbound_htlcs_amount_msat: u64,
57 pub holding_cell_outbound_amount_msat: u64,
58 pub counterparty_max_htlc_value_in_flight_msat: u64, // outgoing
59 pub counterparty_dust_limit_msat: u64,
62 enum InboundHTLCRemovalReason {
63 FailRelay(msgs::OnionErrorPacket),
64 FailMalformed(([u8; 32], u16)),
65 Fulfill(PaymentPreimage),
68 enum InboundHTLCState {
69 /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
70 /// update_add_htlc message for this HTLC.
71 RemoteAnnounced(PendingHTLCStatus),
72 /// Included in a received commitment_signed message (implying we've
73 /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
74 /// state (see the example below). We have not yet included this HTLC in a
75 /// commitment_signed message because we are waiting on the remote's
76 /// aforementioned state revocation. One reason this missing remote RAA
77 /// (revoke_and_ack) blocks us from constructing a commitment_signed message
78 /// is because every time we create a new "state", i.e. every time we sign a
79 /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
80 /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
81 /// sent provided the per_commitment_point for our current commitment tx.
82 /// The other reason we should not send a commitment_signed without their RAA
83 /// is because their RAA serves to ACK our previous commitment_signed.
85 /// Here's an example of how an HTLC could come to be in this state:
86 /// remote --> update_add_htlc(prev_htlc) --> local
87 /// remote --> commitment_signed(prev_htlc) --> local
88 /// remote <-- revoke_and_ack <-- local
89 /// remote <-- commitment_signed(prev_htlc) <-- local
90 /// [note that here, the remote does not respond with a RAA]
91 /// remote --> update_add_htlc(this_htlc) --> local
92 /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
93 /// Now `this_htlc` will be assigned this state. It's unable to be officially
94 /// accepted, i.e. included in a commitment_signed, because we're missing the
95 /// RAA that provides our next per_commitment_point. The per_commitment_point
96 /// is used to derive commitment keys, which are used to construct the
97 /// signatures in a commitment_signed message.
98 /// Implies AwaitingRemoteRevoke.
100 /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
101 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
102 /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
103 /// We have also included this HTLC in our latest commitment_signed and are now just waiting
104 /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
105 /// channel (before it can then get forwarded and/or removed).
106 /// Implies AwaitingRemoteRevoke.
107 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
109 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
110 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
112 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
113 /// commitment transaction without it as otherwise we'll have to force-close the channel to
114 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
115 /// anyway). That said, ChannelMonitor does this for us (see
116 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
117 /// local state before then, once we're sure that the next commitment_signed and
118 /// ChannelMonitor::provide_latest_local_commitment_tx will not include this HTLC.
119 LocalRemoved(InboundHTLCRemovalReason),
122 struct InboundHTLCOutput {
126 payment_hash: PaymentHash,
127 state: InboundHTLCState,
130 enum OutboundHTLCState {
131 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
132 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
133 /// we will promote to Committed (note that they may not accept it until the next time we
134 /// revoke, but we don't really care about that:
135 /// * they've revoked, so worst case we can announce an old state and get our (option on)
136 /// money back (though we won't), and,
137 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
138 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
139 /// doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
140 /// we'll never get out of sync).
141 /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
142 /// OutboundHTLCOutput's size just for a temporary bit
143 LocalAnnounced(Box<msgs::OnionPacket>),
145 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
146 /// the change (though they'll need to revoke before we fail the payment).
147 RemoteRemoved(Option<HTLCFailReason>),
148 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
149 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
150 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
151 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
152 /// remote revoke_and_ack on a previous state before we can do so.
153 AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
154 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
155 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
156 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
157 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
158 /// revoke_and_ack to drop completely.
159 AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
162 struct OutboundHTLCOutput {
166 payment_hash: PaymentHash,
167 state: OutboundHTLCState,
171 /// See AwaitingRemoteRevoke ChannelState for more info
172 enum HTLCUpdateAwaitingACK {
173 AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
177 payment_hash: PaymentHash,
179 onion_routing_packet: msgs::OnionPacket,
182 payment_preimage: PaymentPreimage,
187 err_packet: msgs::OnionErrorPacket,
191 /// There are a few "states" and then a number of flags which can be applied:
192 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
193 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
194 /// move on to ChannelFunded.
195 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
196 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
197 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
199 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
200 OurInitSent = 1 << 0,
201 /// Implies we have received their open_channel/accept_channel message
202 TheirInitSent = 1 << 1,
203 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
204 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
205 /// upon receipt of funding_created, so simply skip this state.
207 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
208 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
209 /// and our counterparty consider the funding transaction confirmed.
211 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
212 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
213 TheirFundingLocked = 1 << 4,
214 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
215 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
216 OurFundingLocked = 1 << 5,
218 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
219 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
221 PeerDisconnected = 1 << 7,
222 /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
223 /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
224 /// outbound messages until they've managed to do so.
225 MonitorUpdateFailed = 1 << 8,
226 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
227 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
228 /// messages as then we will be unable to determine which HTLCs they included in their
229 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
231 /// Flag is set on ChannelFunded.
232 AwaitingRemoteRevoke = 1 << 9,
233 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
234 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
235 /// to respond with our own shutdown message when possible.
236 RemoteShutdownSent = 1 << 10,
237 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
238 /// point, we may not add any new HTLCs to the channel.
239 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
240 /// us their shutdown.
241 LocalShutdownSent = 1 << 11,
242 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
243 /// to drop us, but we store this anyway.
244 ShutdownComplete = 4096,
246 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
247 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
249 pub const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
251 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
252 /// If channel is public, network should have a liveness view announced by us on a
253 /// best-effort, which means we may filter out some status transitions to avoid spam.
254 /// See further timer_chan_freshness_every_min.
257 /// Status has been gossiped.
259 /// Status has been changed.
261 /// Status has been marked to be gossiped at next flush
265 /// An enum indicating whether the local or remote side offered a given HTLC.
271 /// Used when calculating whether we or the remote can afford an additional HTLC.
272 struct HTLCCandidate {
274 origin: HTLCInitiator,
278 fn new(amount_msat: u64, origin: HTLCInitiator) -> Self {
286 /// Information needed for constructing an invoice route hint for this channel.
288 pub struct CounterpartyForwardingInfo {
289 /// Base routing fee in millisatoshis.
290 pub fee_base_msat: u32,
291 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
292 pub fee_proportional_millionths: u32,
293 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
294 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
295 /// `cltv_expiry_delta` for more details.
296 pub cltv_expiry_delta: u16,
299 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
300 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
301 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
304 // Holder designates channel data owned for the benefice of the user client.
305 // Counterparty designates channel data owned by the another channel participant entity.
306 pub(super) struct Channel<Signer: Sign> {
307 config: ChannelConfig,
311 channel_id: [u8; 32],
313 secp_ctx: Secp256k1<secp256k1::All>,
314 channel_value_satoshis: u64,
316 latest_monitor_update_id: u64,
318 holder_signer: Signer,
319 shutdown_pubkey: PublicKey,
320 destination_script: Script,
322 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
323 // generation start at 0 and count up...this simplifies some parts of implementation at the
324 // cost of others, but should really just be changed.
326 cur_holder_commitment_transaction_number: u64,
327 cur_counterparty_commitment_transaction_number: u64,
328 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
329 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
330 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
331 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
333 /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
334 /// need to ensure we resend them in the order we originally generated them. Note that because
335 /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
336 /// sufficient to simply set this to the opposite of any message we are generating as we
337 /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
338 /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
340 resend_order: RAACommitmentOrder,
342 monitor_pending_funding_locked: bool,
343 monitor_pending_revoke_and_ack: bool,
344 monitor_pending_commitment_signed: bool,
345 monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
346 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
348 // pending_update_fee is filled when sending and receiving update_fee
349 // For outbound channel, feerate_per_kw is updated with the value from
350 // pending_update_fee when revoke_and_ack is received
352 // For inbound channel, feerate_per_kw is updated when it receives
353 // commitment_signed and revoke_and_ack is generated
354 // The pending value is kept when another pair of update_fee and commitment_signed
355 // is received during AwaitingRemoteRevoke and relieved when the expected
356 // revoke_and_ack is received and new commitment_signed is generated to be
357 // sent to the funder. Otherwise, the pending value is removed when receiving
358 // commitment_signed.
359 pending_update_fee: Option<u32>,
360 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
361 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
362 // is received. holding_cell_update_fee is updated when there are additional
363 // update_fee() during ChannelState::AwaitingRemoteRevoke.
364 holding_cell_update_fee: Option<u32>,
365 next_holder_htlc_id: u64,
366 next_counterparty_htlc_id: u64,
367 update_time_counter: u32,
370 #[cfg(debug_assertions)]
371 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
372 holder_max_commitment_tx_output: ::std::sync::Mutex<(u64, u64)>,
373 #[cfg(debug_assertions)]
374 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
375 counterparty_max_commitment_tx_output: ::std::sync::Mutex<(u64, u64)>,
377 last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, holder_sig)
379 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
380 /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
381 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
382 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
383 funding_tx_confirmed_in: Option<BlockHash>,
384 short_channel_id: Option<u64>,
385 funding_tx_confirmations: u64,
387 counterparty_dust_limit_satoshis: u64,
389 pub(super) holder_dust_limit_satoshis: u64,
391 holder_dust_limit_satoshis: u64,
393 pub(super) counterparty_max_htlc_value_in_flight_msat: u64,
395 counterparty_max_htlc_value_in_flight_msat: u64,
396 //get_holder_max_htlc_value_in_flight_msat(): u64,
397 /// minimum channel reserve for self to maintain - set by them.
398 counterparty_selected_channel_reserve_satoshis: u64,
399 // get_holder_selected_channel_reserve_satoshis(channel_value_sats: u64): u64
400 counterparty_htlc_minimum_msat: u64,
401 holder_htlc_minimum_msat: u64,
403 pub counterparty_max_accepted_htlcs: u16,
405 counterparty_max_accepted_htlcs: u16,
406 //implied by OUR_MAX_HTLCS: max_accepted_htlcs: u16,
409 counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
411 pub(crate) channel_transaction_parameters: ChannelTransactionParameters,
413 counterparty_cur_commitment_point: Option<PublicKey>,
415 counterparty_prev_commitment_point: Option<PublicKey>,
416 counterparty_node_id: PublicKey,
418 counterparty_shutdown_scriptpubkey: Option<Script>,
420 commitment_secrets: CounterpartyCommitmentSecrets,
422 network_sync: UpdateStatus,
424 // We save these values so we can make sure `next_local_commit_tx_fee_msat` and
425 // `next_remote_commit_tx_fee_msat` properly predict what the next commitment transaction fee will
426 // be, by comparing the cached values to the fee of the tranaction generated by
427 // `build_commitment_transaction`.
428 #[cfg(any(test, feature = "fuzztarget"))]
429 next_local_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
430 #[cfg(any(test, feature = "fuzztarget"))]
431 next_remote_commitment_tx_fee_info_cached: Mutex<Option<CommitmentTxInfoCached>>,
434 #[cfg(any(test, feature = "fuzztarget"))]
435 struct CommitmentTxInfoCached {
437 total_pending_htlcs: usize,
438 next_holder_htlc_id: u64,
439 next_counterparty_htlc_id: u64,
443 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
444 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
445 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
446 /// really allow for this, so instead we're stuck closing it out at that point.
447 const UNCONF_THRESHOLD: u32 = 6;
448 const SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT: u64 = 79; // prevout: 36, nSequence: 4, script len: 1, witness lengths: (3+1)/4, sig: 73/4, if-selector: 1, redeemScript: (6 ops + 2*33 pubkeys + 1*2 delay)/4
449 const B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT: u64 = 104; // prevout: 40, nSequence: 4, script len: 1, witness lengths: 3/4, sig: 73/4, pubkey: 33/4, output: 31 (TODO: Wrong? Useless?)
452 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
454 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
456 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
458 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
460 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
462 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
464 /// Used to return a simple Error back to ChannelManager. Will get converted to a
465 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
466 /// channel_id in ChannelManager.
467 pub(super) enum ChannelError {
470 CloseDelayBroadcast(String),
473 impl fmt::Debug for ChannelError {
474 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
476 &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
477 &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
478 &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
483 macro_rules! secp_check {
484 ($res: expr, $err: expr) => {
487 Err(_) => return Err(ChannelError::Close($err)),
492 impl<Signer: Sign> Channel<Signer> {
493 // Convert constants + channel value to limits:
494 fn get_holder_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
495 channel_value_satoshis * 1000 / 10 //TODO
498 /// Returns a minimum channel reserve value the remote needs to maintain,
501 /// Guaranteed to return a value no larger than channel_value_satoshis
502 pub(crate) fn get_holder_selected_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
503 let (q, _) = channel_value_satoshis.overflowing_div(100);
504 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
507 fn derive_holder_dust_limit_satoshis(at_open_background_feerate: u32) -> u64 {
508 cmp::max(at_open_background_feerate as u64 * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
512 pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, counterparty_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<Signer>, APIError>
513 where K::Target: KeysInterface<Signer = Signer>,
514 F::Target: FeeEstimator,
516 let holder_selected_contest_delay = config.own_channel_config.our_to_self_delay;
517 let holder_signer = keys_provider.get_channel_signer(false, channel_value_satoshis);
518 let pubkeys = holder_signer.pubkeys().clone();
520 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
521 return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
523 let channel_value_msat = channel_value_satoshis * 1000;
524 if push_msat > channel_value_msat {
525 return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
527 if holder_selected_contest_delay < BREAKDOWN_TIMEOUT {
528 return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", holder_selected_contest_delay)});
530 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
531 if Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(channel_value_satoshis) < Channel::<Signer>::derive_holder_dust_limit_satoshis(background_feerate) {
532 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
535 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
537 let mut secp_ctx = Secp256k1::new();
538 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
542 config: config.channel_options.clone(),
544 channel_id: keys_provider.get_secure_random_bytes(),
545 channel_state: ChannelState::OurInitSent as u32,
547 channel_value_satoshis,
549 latest_monitor_update_id: 0,
552 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
553 destination_script: keys_provider.get_destination_script(),
555 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
556 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
557 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
559 pending_inbound_htlcs: Vec::new(),
560 pending_outbound_htlcs: Vec::new(),
561 holding_cell_htlc_updates: Vec::new(),
562 pending_update_fee: None,
563 holding_cell_update_fee: None,
564 next_holder_htlc_id: 0,
565 next_counterparty_htlc_id: 0,
566 update_time_counter: 1,
568 resend_order: RAACommitmentOrder::CommitmentFirst,
570 monitor_pending_funding_locked: false,
571 monitor_pending_revoke_and_ack: false,
572 monitor_pending_commitment_signed: false,
573 monitor_pending_forwards: Vec::new(),
574 monitor_pending_failures: Vec::new(),
576 #[cfg(debug_assertions)]
577 holder_max_commitment_tx_output: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
578 #[cfg(debug_assertions)]
579 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
581 last_sent_closing_fee: None,
583 funding_tx_confirmed_in: None,
584 short_channel_id: None,
585 funding_tx_confirmations: 0,
587 feerate_per_kw: feerate,
588 counterparty_dust_limit_satoshis: 0,
589 holder_dust_limit_satoshis: Channel::<Signer>::derive_holder_dust_limit_satoshis(background_feerate),
590 counterparty_max_htlc_value_in_flight_msat: 0,
591 counterparty_selected_channel_reserve_satoshis: 0,
592 counterparty_htlc_minimum_msat: 0,
593 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
594 counterparty_max_accepted_htlcs: 0,
595 minimum_depth: 0, // Filled in in accept_channel
597 counterparty_forwarding_info: None,
599 channel_transaction_parameters: ChannelTransactionParameters {
600 holder_pubkeys: pubkeys,
601 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
602 is_outbound_from_holder: true,
603 counterparty_parameters: None,
604 funding_outpoint: None
606 counterparty_cur_commitment_point: None,
608 counterparty_prev_commitment_point: None,
609 counterparty_node_id,
611 counterparty_shutdown_scriptpubkey: None,
613 commitment_secrets: CounterpartyCommitmentSecrets::new(),
615 network_sync: UpdateStatus::Fresh,
617 #[cfg(any(test, feature = "fuzztarget"))]
618 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
619 #[cfg(any(test, feature = "fuzztarget"))]
620 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
624 fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
625 where F::Target: FeeEstimator
627 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
628 if feerate_per_kw < lower_limit {
629 return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
631 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64 * 2;
632 if feerate_per_kw as u64 > upper_limit {
633 return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
638 /// Creates a new channel from a remote sides' request for one.
639 /// Assumes chain_hash has already been checked and corresponds with what we expect!
640 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>
641 where K::Target: KeysInterface<Signer = Signer>,
642 F::Target: FeeEstimator
644 let holder_signer = keys_provider.get_channel_signer(true, msg.funding_satoshis);
645 let pubkeys = holder_signer.pubkeys().clone();
646 let counterparty_pubkeys = ChannelPublicKeys {
647 funding_pubkey: msg.funding_pubkey,
648 revocation_basepoint: msg.revocation_basepoint,
649 payment_point: msg.payment_point,
650 delayed_payment_basepoint: msg.delayed_payment_basepoint,
651 htlc_basepoint: msg.htlc_basepoint
653 let mut local_config = (*config).channel_options.clone();
655 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
656 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)));
659 // Check sanity of message fields:
660 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
661 return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
663 if msg.channel_reserve_satoshis > msg.funding_satoshis {
664 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
666 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
667 if msg.push_msat > funding_value {
668 return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
670 if msg.dust_limit_satoshis > msg.funding_satoshis {
671 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)));
673 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
674 return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
676 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
677 if msg.htlc_minimum_msat >= full_channel_value_msat {
678 return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
680 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
682 let max_counterparty_selected_contest_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
683 if msg.to_self_delay > max_counterparty_selected_contest_delay {
684 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)));
686 if msg.max_accepted_htlcs < 1 {
687 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
689 if msg.max_accepted_htlcs > MAX_HTLCS {
690 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
693 // Now check against optional parameters as set by config...
694 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
695 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)));
697 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
698 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)));
700 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
701 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)));
703 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
704 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)));
706 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
707 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)));
709 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
710 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.min_dust_limit_satoshis)));
712 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
713 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.max_dust_limit_satoshis)));
716 // Convert things into internal flags and prep our state:
718 let announce = if (msg.channel_flags & 1) == 1 { true } else { false };
719 if config.peer_channel_config_limits.force_announced_channel_preference {
720 if local_config.announced_channel != announce {
721 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
724 // we either accept their preference or the preferences match
725 local_config.announced_channel = announce;
727 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
729 let holder_dust_limit_satoshis = Channel::<Signer>::derive_holder_dust_limit_satoshis(background_feerate);
730 let holder_selected_channel_reserve_satoshis = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(msg.funding_satoshis);
731 if holder_selected_channel_reserve_satoshis < holder_dust_limit_satoshis {
732 return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). dust_limit_satoshis is ({}).", holder_selected_channel_reserve_satoshis, holder_dust_limit_satoshis)));
734 if msg.channel_reserve_satoshis < holder_dust_limit_satoshis {
735 return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, holder_dust_limit_satoshis)));
737 if holder_selected_channel_reserve_satoshis < msg.dust_limit_satoshis {
738 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)));
741 // check if the funder's amount for the initial commitment tx is sufficient
742 // for full fee payment
743 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
744 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
745 if funders_amount_msat < lower_limit {
746 return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
749 let to_local_msat = msg.push_msat;
750 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
751 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= holder_selected_channel_reserve_satoshis * 1000 {
752 return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
755 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
756 match &msg.shutdown_scriptpubkey {
757 &OptionalField::Present(ref script) => {
758 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
759 if script.len() == 0 {
761 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
762 } else if is_unsupported_shutdown_script(&their_features, script) {
763 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
768 // 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
769 &OptionalField::Absent => {
770 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()));
775 let mut secp_ctx = Secp256k1::new();
776 secp_ctx.seeded_randomize(&keys_provider.get_secure_random_bytes());
780 config: local_config,
782 channel_id: msg.temporary_channel_id,
783 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
786 latest_monitor_update_id: 0,
789 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
790 destination_script: keys_provider.get_destination_script(),
792 cur_holder_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
793 cur_counterparty_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
794 value_to_self_msat: msg.push_msat,
796 pending_inbound_htlcs: Vec::new(),
797 pending_outbound_htlcs: Vec::new(),
798 holding_cell_htlc_updates: Vec::new(),
799 pending_update_fee: None,
800 holding_cell_update_fee: None,
801 next_holder_htlc_id: 0,
802 next_counterparty_htlc_id: 0,
803 update_time_counter: 1,
805 resend_order: RAACommitmentOrder::CommitmentFirst,
807 monitor_pending_funding_locked: false,
808 monitor_pending_revoke_and_ack: false,
809 monitor_pending_commitment_signed: false,
810 monitor_pending_forwards: Vec::new(),
811 monitor_pending_failures: Vec::new(),
813 #[cfg(debug_assertions)]
814 holder_max_commitment_tx_output: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
815 #[cfg(debug_assertions)]
816 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
818 last_sent_closing_fee: None,
820 funding_tx_confirmed_in: None,
821 short_channel_id: None,
822 funding_tx_confirmations: 0,
824 feerate_per_kw: msg.feerate_per_kw,
825 channel_value_satoshis: msg.funding_satoshis,
826 counterparty_dust_limit_satoshis: msg.dust_limit_satoshis,
827 holder_dust_limit_satoshis,
828 counterparty_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
829 counterparty_selected_channel_reserve_satoshis: msg.channel_reserve_satoshis,
830 counterparty_htlc_minimum_msat: msg.htlc_minimum_msat,
831 holder_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
832 counterparty_max_accepted_htlcs: msg.max_accepted_htlcs,
833 minimum_depth: config.own_channel_config.minimum_depth,
835 counterparty_forwarding_info: None,
837 channel_transaction_parameters: ChannelTransactionParameters {
838 holder_pubkeys: pubkeys,
839 holder_selected_contest_delay: config.own_channel_config.our_to_self_delay,
840 is_outbound_from_holder: false,
841 counterparty_parameters: Some(CounterpartyChannelTransactionParameters {
842 selected_contest_delay: msg.to_self_delay,
843 pubkeys: counterparty_pubkeys,
845 funding_outpoint: None
847 counterparty_cur_commitment_point: Some(msg.first_per_commitment_point),
849 counterparty_prev_commitment_point: None,
850 counterparty_node_id,
852 counterparty_shutdown_scriptpubkey,
854 commitment_secrets: CounterpartyCommitmentSecrets::new(),
856 network_sync: UpdateStatus::Fresh,
858 #[cfg(any(test, feature = "fuzztarget"))]
859 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
860 #[cfg(any(test, feature = "fuzztarget"))]
861 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
867 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
868 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
869 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
870 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
871 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
873 /// @local is used only to convert relevant internal structures which refer to remote vs local
874 /// to decide value of outputs and direction of HTLCs.
875 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
876 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
877 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
878 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
879 /// which peer generated this transaction and "to whom" this transaction flows.
880 /// Returns (the transaction info, the number of HTLC outputs which were present in the
881 /// transaction, the list of HTLCs which were not ignored when building the transaction).
882 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
883 /// sources are provided only for outbound HTLCs in the third return value.
885 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 {
886 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
887 let num_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
888 let mut included_non_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(num_htlcs);
890 let broadcaster_dust_limit_satoshis = if local { self.holder_dust_limit_satoshis } else { self.counterparty_dust_limit_satoshis };
891 let mut remote_htlc_total_msat = 0;
892 let mut local_htlc_total_msat = 0;
893 let mut value_to_self_msat_offset = 0;
895 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound()), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
897 macro_rules! get_htlc_in_commitment {
898 ($htlc: expr, $offered: expr) => {
899 HTLCOutputInCommitment {
901 amount_msat: $htlc.amount_msat,
902 cltv_expiry: $htlc.cltv_expiry,
903 payment_hash: $htlc.payment_hash,
904 transaction_output_index: None
909 macro_rules! add_htlc_output {
910 ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
911 if $outbound == local { // "offered HTLC output"
912 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
913 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
914 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);
915 included_non_dust_htlcs.push((htlc_in_tx, $source));
917 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);
918 included_dust_htlcs.push((htlc_in_tx, $source));
921 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
922 if $htlc.amount_msat / 1000 >= broadcaster_dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
923 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);
924 included_non_dust_htlcs.push((htlc_in_tx, $source));
926 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);
927 included_dust_htlcs.push((htlc_in_tx, $source));
933 for ref htlc in self.pending_inbound_htlcs.iter() {
934 let (include, state_name) = match htlc.state {
935 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
936 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
937 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
938 InboundHTLCState::Committed => (true, "Committed"),
939 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
943 add_htlc_output!(htlc, false, None, state_name);
944 remote_htlc_total_msat += htlc.amount_msat;
946 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);
948 &InboundHTLCState::LocalRemoved(ref reason) => {
949 if generated_by_local {
950 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
951 value_to_self_msat_offset += htlc.amount_msat as i64;
960 for ref htlc in self.pending_outbound_htlcs.iter() {
961 let (include, state_name) = match htlc.state {
962 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
963 OutboundHTLCState::Committed => (true, "Committed"),
964 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
965 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
966 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
970 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
971 local_htlc_total_msat += htlc.amount_msat;
973 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);
975 OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
976 value_to_self_msat_offset -= htlc.amount_msat as i64;
978 OutboundHTLCState::RemoteRemoved(None) => {
979 if !generated_by_local {
980 value_to_self_msat_offset -= htlc.amount_msat as i64;
988 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
989 assert!(value_to_self_msat >= 0);
990 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
991 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
992 // "violate" their reserve value by couting those against it. Thus, we have to convert
993 // everything to i64 before subtracting as otherwise we can overflow.
994 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;
995 assert!(value_to_remote_msat >= 0);
997 #[cfg(debug_assertions)]
999 // Make sure that the to_self/to_remote is always either past the appropriate
1000 // channel_reserve *or* it is making progress towards it.
1001 let mut broadcaster_max_commitment_tx_output = if generated_by_local {
1002 self.holder_max_commitment_tx_output.lock().unwrap()
1004 self.counterparty_max_commitment_tx_output.lock().unwrap()
1006 debug_assert!(broadcaster_max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.counterparty_selected_channel_reserve_satoshis as i64);
1007 broadcaster_max_commitment_tx_output.0 = cmp::max(broadcaster_max_commitment_tx_output.0, value_to_self_msat as u64);
1008 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);
1009 broadcaster_max_commitment_tx_output.1 = cmp::max(broadcaster_max_commitment_tx_output.1, value_to_remote_msat as u64);
1012 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;
1013 let (value_to_self, value_to_remote) = if self.is_outbound() {
1014 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
1016 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
1019 let mut value_to_a = if local { value_to_self } else { value_to_remote };
1020 let mut value_to_b = if local { value_to_remote } else { value_to_self };
1022 if value_to_a >= (broadcaster_dust_limit_satoshis as i64) {
1023 log_trace!(logger, " ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
1028 if value_to_b >= (broadcaster_dust_limit_satoshis as i64) {
1029 log_trace!(logger, " ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1034 let num_nondust_htlcs = included_non_dust_htlcs.len();
1036 let channel_parameters =
1037 if local { self.channel_transaction_parameters.as_holder_broadcastable() }
1038 else { self.channel_transaction_parameters.as_counterparty_broadcastable() };
1039 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(commitment_number,
1044 &mut included_non_dust_htlcs,
1047 let mut htlcs_included = included_non_dust_htlcs;
1048 // The unwrap is safe, because all non-dust HTLCs have been assigned an output index
1049 htlcs_included.sort_unstable_by_key(|h| h.0.transaction_output_index.unwrap());
1050 htlcs_included.append(&mut included_dust_htlcs);
1052 (tx, num_nondust_htlcs, htlcs_included)
1056 fn get_closing_scriptpubkey(&self) -> Script {
1057 let channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1058 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_close_key_hash[..]).into_script()
1062 fn get_closing_transaction_weight(&self, a_scriptpubkey: Option<&Script>, b_scriptpubkey: Option<&Script>) -> u64 {
1067 1 + // script length (0)
1071 )*4 + // * 4 for non-witness parts
1072 2 + // witness marker and flag
1073 1 + // witness element count
1074 4 + // 4 element lengths (2 sigs, multisig dummy, and witness script)
1075 self.get_funding_redeemscript().len() as u64 + // funding witness script
1076 2*(1 + 71); // two signatures + sighash type flags
1077 if let Some(spk) = a_scriptpubkey {
1078 ret += ((8+1) + // output values and script length
1079 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1081 if let Some(spk) = b_scriptpubkey {
1082 ret += ((8+1) + // output values and script length
1083 spk.len() as u64) * 4; // scriptpubkey and witness multiplier
1089 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1091 let mut ins: Vec<TxIn> = Vec::new();
1093 previous_output: self.funding_outpoint().into_bitcoin_outpoint(),
1094 script_sig: Script::new(),
1095 sequence: 0xffffffff,
1096 witness: Vec::new(),
1101 assert!(self.pending_inbound_htlcs.is_empty());
1102 assert!(self.pending_outbound_htlcs.is_empty());
1103 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1105 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1106 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.is_outbound() { total_fee_satoshis as i64 } else { 0 };
1107 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 };
1109 if value_to_self < 0 {
1110 assert!(self.is_outbound());
1111 total_fee_satoshis += (-value_to_self) as u64;
1112 } else if value_to_remote < 0 {
1113 assert!(!self.is_outbound());
1114 total_fee_satoshis += (-value_to_remote) as u64;
1117 if !skip_remote_output && value_to_remote as u64 > self.holder_dust_limit_satoshis {
1118 txouts.push((TxOut {
1119 script_pubkey: self.counterparty_shutdown_scriptpubkey.clone().unwrap(),
1120 value: value_to_remote as u64
1124 if value_to_self as u64 > self.holder_dust_limit_satoshis {
1125 txouts.push((TxOut {
1126 script_pubkey: self.get_closing_scriptpubkey(),
1127 value: value_to_self as u64
1131 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1133 let mut outputs: Vec<TxOut> = Vec::new();
1134 for out in txouts.drain(..) {
1135 outputs.push(out.0);
1143 }, total_fee_satoshis)
1146 fn funding_outpoint(&self) -> OutPoint {
1147 self.channel_transaction_parameters.funding_outpoint.unwrap()
1151 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1152 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1153 /// our counterparty!)
1154 /// The result is a transaction which we can revoke broadcastership of (ie a "local" transaction)
1155 /// TODO Some magic rust shit to compile-time check this?
1156 fn build_holder_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1157 let per_commitment_point = self.holder_signer.get_per_commitment_point(commitment_number, &self.secp_ctx);
1158 let delayed_payment_base = &self.get_holder_pubkeys().delayed_payment_basepoint;
1159 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1160 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1162 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()))
1166 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1167 /// will sign and send to our counterparty.
1168 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1169 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1170 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1171 //may see payments to it!
1172 let revocation_basepoint = &self.get_holder_pubkeys().revocation_basepoint;
1173 let htlc_basepoint = &self.get_holder_pubkeys().htlc_basepoint;
1174 let counterparty_pubkeys = self.get_counterparty_pubkeys();
1176 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()))
1179 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1180 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1181 /// Panics if called before accept_channel/new_from_req
1182 pub fn get_funding_redeemscript(&self) -> Script {
1183 make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
1186 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1187 /// @local is used only to convert relevant internal structures which refer to remote vs local
1188 /// to decide value of outputs and direction of HTLCs.
1189 fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u32) -> Transaction {
1190 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.get_counterparty_selected_contest_delay() } else { self.get_holder_selected_contest_delay() }, htlc, &keys.broadcaster_delayed_payment_key, &keys.revocation_key)
1193 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1194 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1195 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1197 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1198 /// but then have a reorg which settles on an HTLC-failure on chain.
1199 fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1200 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1201 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1202 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1204 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1205 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1207 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1209 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1211 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1212 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1213 // these, but for now we just have to treat them as normal.
1215 let mut pending_idx = std::usize::MAX;
1216 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1217 if htlc.htlc_id == htlc_id_arg {
1218 assert_eq!(htlc.payment_hash, payment_hash_calc);
1220 InboundHTLCState::Committed => {},
1221 InboundHTLCState::LocalRemoved(ref reason) => {
1222 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1224 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()));
1226 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1227 return Ok((None, None));
1230 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1231 // Don't return in release mode here so that we can update channel_monitor
1238 if pending_idx == std::usize::MAX {
1239 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1242 // Now update local state:
1244 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1245 // can claim it even if the channel hits the chain before we see their next commitment.
1246 self.latest_monitor_update_id += 1;
1247 let monitor_update = ChannelMonitorUpdate {
1248 update_id: self.latest_monitor_update_id,
1249 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1250 payment_preimage: payment_preimage_arg.clone(),
1254 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1255 for pending_update in self.holding_cell_htlc_updates.iter() {
1256 match pending_update {
1257 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1258 if htlc_id_arg == htlc_id {
1259 // Make sure we don't leave latest_monitor_update_id incremented here:
1260 self.latest_monitor_update_id -= 1;
1261 debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1262 return Ok((None, None));
1265 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1266 if htlc_id_arg == htlc_id {
1267 log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1268 // TODO: We may actually be able to switch to a fulfill here, though its
1269 // rare enough it may not be worth the complexity burden.
1270 debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1271 return Ok((None, Some(monitor_update)));
1277 log_trace!(logger, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1278 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1279 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1281 return Ok((None, Some(monitor_update)));
1285 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1286 if let InboundHTLCState::Committed = htlc.state {
1288 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1289 return Ok((None, Some(monitor_update)));
1291 log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1292 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1295 Ok((Some(msgs::UpdateFulfillHTLC {
1296 channel_id: self.channel_id(),
1297 htlc_id: htlc_id_arg,
1298 payment_preimage: payment_preimage_arg,
1299 }), Some(monitor_update)))
1302 pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1303 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger)? {
1304 (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1305 let (commitment, mut additional_update) = self.send_commitment_no_status_check(logger)?;
1306 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1307 // strictly increasing by one, so decrement it here.
1308 self.latest_monitor_update_id = monitor_update.update_id;
1309 monitor_update.updates.append(&mut additional_update.updates);
1310 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1312 (Some(update_fulfill_htlc), None) => {
1313 let (commitment, monitor_update) = self.send_commitment_no_status_check(logger)?;
1314 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1316 (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1317 (None, None) => Ok((None, None))
1321 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1322 /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1323 /// return Ok(_) if debug assertions are turned on or preconditions are met.
1325 /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1326 /// but then have a reorg which settles on an HTLC-failure on chain.
1327 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1328 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1329 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1331 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1333 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1334 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1335 // these, but for now we just have to treat them as normal.
1337 let mut pending_idx = std::usize::MAX;
1338 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1339 if htlc.htlc_id == htlc_id_arg {
1341 InboundHTLCState::Committed => {},
1342 InboundHTLCState::LocalRemoved(_) => {
1343 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1347 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1348 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1354 if pending_idx == std::usize::MAX {
1355 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1358 // Now update local state:
1359 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1360 for pending_update in self.holding_cell_htlc_updates.iter() {
1361 match pending_update {
1362 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1363 if htlc_id_arg == htlc_id {
1364 debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1365 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1368 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1369 if htlc_id_arg == htlc_id {
1370 debug_assert!(false, "Tried to fail an HTLC that was already failed");
1371 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1377 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1378 htlc_id: htlc_id_arg,
1385 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1386 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1389 Ok(Some(msgs::UpdateFailHTLC {
1390 channel_id: self.channel_id(),
1391 htlc_id: htlc_id_arg,
1396 // Message handlers:
1398 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1399 // Check sanity of message fields:
1400 if !self.is_outbound() {
1401 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1403 if self.channel_state != ChannelState::OurInitSent as u32 {
1404 return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1406 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1407 return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1409 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1410 return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1412 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1413 return Err(ChannelError::Close(format!("Bogus channel_reserve ({}) and dust_limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
1415 if msg.channel_reserve_satoshis < self.holder_dust_limit_satoshis {
1416 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)));
1418 let remote_reserve = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
1419 if msg.dust_limit_satoshis > remote_reserve {
1420 return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1422 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1423 if msg.htlc_minimum_msat >= full_channel_value_msat {
1424 return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1426 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1427 if msg.to_self_delay > max_delay_acceptable {
1428 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)));
1430 if msg.max_accepted_htlcs < 1 {
1431 return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1433 if msg.max_accepted_htlcs > MAX_HTLCS {
1434 return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than {}", msg.max_accepted_htlcs, MAX_HTLCS)));
1437 // Now check against optional parameters as set by config...
1438 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1439 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)));
1441 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1442 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)));
1444 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1445 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)));
1447 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1448 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)));
1450 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1451 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.min_dust_limit_satoshis)));
1453 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1454 return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.max_dust_limit_satoshis)));
1456 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1457 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)));
1460 let counterparty_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1461 match &msg.shutdown_scriptpubkey {
1462 &OptionalField::Present(ref script) => {
1463 // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1464 if script.len() == 0 {
1466 // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1467 } else if is_unsupported_shutdown_script(&their_features, script) {
1468 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
1470 Some(script.clone())
1473 // 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
1474 &OptionalField::Absent => {
1475 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()));
1480 self.counterparty_dust_limit_satoshis = msg.dust_limit_satoshis;
1481 self.counterparty_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1482 self.counterparty_selected_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1483 self.counterparty_htlc_minimum_msat = msg.htlc_minimum_msat;
1484 self.counterparty_max_accepted_htlcs = msg.max_accepted_htlcs;
1485 self.minimum_depth = msg.minimum_depth;
1487 let counterparty_pubkeys = ChannelPublicKeys {
1488 funding_pubkey: msg.funding_pubkey,
1489 revocation_basepoint: msg.revocation_basepoint,
1490 payment_point: msg.payment_point,
1491 delayed_payment_basepoint: msg.delayed_payment_basepoint,
1492 htlc_basepoint: msg.htlc_basepoint
1495 self.channel_transaction_parameters.counterparty_parameters = Some(CounterpartyChannelTransactionParameters {
1496 selected_contest_delay: msg.to_self_delay,
1497 pubkeys: counterparty_pubkeys,
1500 self.counterparty_cur_commitment_point = Some(msg.first_per_commitment_point);
1501 self.counterparty_shutdown_scriptpubkey = counterparty_shutdown_scriptpubkey;
1503 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1508 fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Txid, CommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1509 let funding_script = self.get_funding_redeemscript();
1511 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1512 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, self.feerate_per_kw, logger).0;
1514 let trusted_tx = initial_commitment_tx.trust();
1515 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1516 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1517 // They sign the holder commitment transaction...
1518 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&initial_commitment_bitcoin_tx.transaction), log_bytes!(sighash[..]), encode::serialize_hex(&funding_script));
1519 secp_check!(self.secp_ctx.verify(&sighash, &sig, self.counterparty_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1522 let counterparty_keys = self.build_remote_transaction_keys()?;
1523 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;
1525 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1526 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1527 log_trace!(logger, "Initial counterparty ID {} tx {}", counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1529 let counterparty_signature = self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
1530 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1532 // We sign "counterparty" commitment transaction, allowing them to broadcast the tx if they wish.
1533 Ok((counterparty_initial_bitcoin_tx.txid, initial_commitment_tx, counterparty_signature))
1536 fn counterparty_funding_pubkey(&self) -> &PublicKey {
1537 &self.get_counterparty_pubkeys().funding_pubkey
1540 pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, last_block_hash: BlockHash, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError> where L::Target: Logger {
1541 if self.is_outbound() {
1542 return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1544 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1545 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1546 // remember the channel, so it's safe to just send an error_message here and drop the
1548 return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1550 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1551 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1552 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1553 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1556 let funding_txo = OutPoint { txid: msg.funding_txid, index: msg.funding_output_index };
1557 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
1558 // This is an externally observable change before we finish all our checks. In particular
1559 // funding_created_signature may fail.
1560 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
1562 let (counterparty_initial_commitment_txid, initial_commitment_tx, signature) = match self.funding_created_signature(&msg.signature, logger) {
1564 Err(ChannelError::Close(e)) => {
1565 self.channel_transaction_parameters.funding_outpoint = None;
1566 return Err(ChannelError::Close(e));
1569 // The only error we know how to handle is ChannelError::Close, so we fall over here
1570 // to make sure we don't continue with an inconsistent state.
1571 panic!("unexpected error type from funding_created_signature {:?}", e);
1575 let holder_commitment_tx = HolderCommitmentTransaction::new(
1576 initial_commitment_tx,
1579 &self.get_holder_pubkeys().funding_pubkey,
1580 self.counterparty_funding_pubkey()
1583 // Now that we're past error-generating stuff, update our local state:
1585 let funding_redeemscript = self.get_funding_redeemscript();
1586 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1587 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1588 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1589 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1590 &self.destination_script, (funding_txo, funding_txo_script.clone()),
1591 &self.channel_transaction_parameters,
1592 funding_redeemscript.clone(), self.channel_value_satoshis,
1594 holder_commitment_tx, last_block_hash);
1596 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);
1598 self.channel_state = ChannelState::FundingSent as u32;
1599 self.channel_id = funding_txo.to_channel_id();
1600 self.cur_counterparty_commitment_transaction_number -= 1;
1601 self.cur_holder_commitment_transaction_number -= 1;
1603 Ok((msgs::FundingSigned {
1604 channel_id: self.channel_id,
1606 }, channel_monitor))
1609 /// Handles a funding_signed message from the remote end.
1610 /// If this call is successful, broadcast the funding transaction (and not before!)
1611 pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, last_block_hash: BlockHash, logger: &L) -> Result<ChannelMonitor<Signer>, ChannelError> where L::Target: Logger {
1612 if !self.is_outbound() {
1613 return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1615 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1616 return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1618 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1619 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1620 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1621 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1624 let funding_script = self.get_funding_redeemscript();
1626 let counterparty_keys = self.build_remote_transaction_keys()?;
1627 let counterparty_initial_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, false, self.feerate_per_kw, logger).0;
1628 let counterparty_trusted_tx = counterparty_initial_commitment_tx.trust();
1629 let counterparty_initial_bitcoin_tx = counterparty_trusted_tx.built_transaction();
1631 log_trace!(logger, "Initial counterparty ID {} tx {}", counterparty_initial_bitcoin_tx.txid, encode::serialize_hex(&counterparty_initial_bitcoin_tx.transaction));
1633 let holder_signer = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number)?;
1634 let initial_commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &holder_signer, true, false, self.feerate_per_kw, logger).0;
1636 let trusted_tx = initial_commitment_tx.trust();
1637 let initial_commitment_bitcoin_tx = trusted_tx.built_transaction();
1638 let sighash = initial_commitment_bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
1639 // They sign our commitment transaction, allowing us to broadcast the tx if we wish.
1640 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
1641 return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1645 let holder_commitment_tx = HolderCommitmentTransaction::new(
1646 initial_commitment_tx,
1649 &self.get_holder_pubkeys().funding_pubkey,
1650 self.counterparty_funding_pubkey()
1654 let funding_redeemscript = self.get_funding_redeemscript();
1655 let funding_txo = self.get_funding_txo().unwrap();
1656 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1657 let obscure_factor = get_commitment_transaction_number_obscure_factor(&self.get_holder_pubkeys().payment_point, &self.get_counterparty_pubkeys().payment_point, self.is_outbound());
1658 let channel_monitor = ChannelMonitor::new(self.secp_ctx.clone(), self.holder_signer.clone(),
1659 &self.shutdown_pubkey, self.get_holder_selected_contest_delay(),
1660 &self.destination_script, (funding_txo, funding_txo_script),
1661 &self.channel_transaction_parameters,
1662 funding_redeemscript.clone(), self.channel_value_satoshis,
1664 holder_commitment_tx, last_block_hash);
1666 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);
1668 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1669 self.channel_state = ChannelState::FundingSent as u32;
1670 self.cur_holder_commitment_transaction_number -= 1;
1671 self.cur_counterparty_commitment_transaction_number -= 1;
1676 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1677 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1678 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish".to_owned()));
1681 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1683 if non_shutdown_state == ChannelState::FundingSent as u32 {
1684 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1685 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1686 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1687 self.update_time_counter += 1;
1688 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1689 // Note that funding_signed/funding_created will have decremented both by 1!
1690 self.cur_holder_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1691 self.cur_counterparty_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1692 // If we reconnected before sending our funding locked they may still resend theirs:
1693 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1694 (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1695 if self.counterparty_cur_commitment_point != Some(msg.next_per_commitment_point) {
1696 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1698 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1701 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1704 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
1705 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
1709 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1710 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1711 let mut htlc_inbound_value_msat = 0;
1712 for ref htlc in self.pending_inbound_htlcs.iter() {
1713 htlc_inbound_value_msat += htlc.amount_msat;
1715 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1718 /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1720 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1721 let mut htlc_outbound_value_msat = 0;
1722 for ref htlc in self.pending_outbound_htlcs.iter() {
1723 htlc_outbound_value_msat += htlc.amount_msat;
1726 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1727 for update in self.holding_cell_htlc_updates.iter() {
1728 if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1729 htlc_outbound_count += 1;
1730 htlc_outbound_value_msat += amount_msat;
1734 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1737 /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1738 /// Doesn't bother handling the
1739 /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1740 /// corner case properly.
1741 pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1742 // Note that we have to handle overflow due to the above case.
1743 (cmp::max(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1744 cmp::max(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1747 // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1748 // Note that num_htlcs should not include dust HTLCs.
1749 fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1750 // Note that we need to divide before multiplying to round properly,
1751 // since the lowest denomination of bitcoin on-chain is the satoshi.
1752 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1755 // Get the commitment tx fee for the local's (i.e. our) next commitment transaction based on the
1756 // number of pending HTLCs that are on track to be in our next commitment tx, plus an additional
1757 // HTLC if `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs
1759 fn next_local_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1760 assert!(self.is_outbound());
1762 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1763 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.holder_dust_limit_satoshis;
1765 let mut addl_htlcs = 0;
1766 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1768 HTLCInitiator::LocalOffered => {
1769 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1773 HTLCInitiator::RemoteOffered => {
1774 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1780 let mut included_htlcs = 0;
1781 for ref htlc in self.pending_inbound_htlcs.iter() {
1782 if htlc.amount_msat / 1000 < real_dust_limit_success_sat {
1785 // We include LocalRemoved HTLCs here because we may still need to broadcast a commitment
1786 // transaction including this HTLC if it times out before they RAA.
1787 included_htlcs += 1;
1790 for ref htlc in self.pending_outbound_htlcs.iter() {
1791 if htlc.amount_msat / 1000 < real_dust_limit_timeout_sat {
1795 OutboundHTLCState::LocalAnnounced {..} => included_htlcs += 1,
1796 OutboundHTLCState::Committed => included_htlcs += 1,
1797 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1798 // We don't include AwaitingRemoteRevokeToRemove HTLCs because our next commitment
1799 // transaction won't be generated until they send us their next RAA, which will mean
1800 // dropping any HTLCs in this state.
1805 for htlc in self.holding_cell_htlc_updates.iter() {
1807 &HTLCUpdateAwaitingACK::AddHTLC { amount_msat, .. } => {
1808 if amount_msat / 1000 < real_dust_limit_timeout_sat {
1813 _ => {}, // Don't include claims/fails that are awaiting ack, because once we get the
1814 // ack we're guaranteed to never include them in commitment txs anymore.
1818 let num_htlcs = included_htlcs + addl_htlcs;
1819 let res = self.commit_tx_fee_msat(num_htlcs);
1820 #[cfg(any(test, feature = "fuzztarget"))]
1823 if fee_spike_buffer_htlc.is_some() {
1824 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1826 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
1827 + self.holding_cell_htlc_updates.len();
1828 let commitment_tx_info = CommitmentTxInfoCached {
1830 total_pending_htlcs,
1831 next_holder_htlc_id: match htlc.origin {
1832 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1833 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1835 next_counterparty_htlc_id: match htlc.origin {
1836 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1837 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1839 feerate: self.feerate_per_kw,
1841 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1846 // Get the commitment tx fee for the remote's next commitment transaction based on the number of
1847 // pending HTLCs that are on track to be in their next commitment tx, plus an additional HTLC if
1848 // `fee_spike_buffer_htlc` is Some, plus a new HTLC given by `new_htlc_amount`. Dust HTLCs are
1850 fn next_remote_commit_tx_fee_msat(&self, htlc: HTLCCandidate, fee_spike_buffer_htlc: Option<()>) -> u64 {
1851 assert!(!self.is_outbound());
1853 let real_dust_limit_success_sat = (self.feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1854 let real_dust_limit_timeout_sat = (self.feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + self.counterparty_dust_limit_satoshis;
1856 let mut addl_htlcs = 0;
1857 if fee_spike_buffer_htlc.is_some() { addl_htlcs += 1; }
1859 HTLCInitiator::LocalOffered => {
1860 if htlc.amount_msat / 1000 >= real_dust_limit_success_sat {
1864 HTLCInitiator::RemoteOffered => {
1865 if htlc.amount_msat / 1000 >= real_dust_limit_timeout_sat {
1871 // When calculating the set of HTLCs which will be included in their next commitment_signed, all
1872 // non-dust inbound HTLCs are included (as all states imply it will be included) and only
1873 // committed outbound HTLCs, see below.
1874 let mut included_htlcs = 0;
1875 for ref htlc in self.pending_inbound_htlcs.iter() {
1876 if htlc.amount_msat / 1000 <= real_dust_limit_timeout_sat {
1879 included_htlcs += 1;
1882 for ref htlc in self.pending_outbound_htlcs.iter() {
1883 if htlc.amount_msat / 1000 <= real_dust_limit_success_sat {
1886 // We only include outbound HTLCs if it will not be included in their next commitment_signed,
1887 // i.e. if they've responded to us with an RAA after announcement.
1889 OutboundHTLCState::Committed => included_htlcs += 1,
1890 OutboundHTLCState::RemoteRemoved {..} => included_htlcs += 1,
1891 OutboundHTLCState::LocalAnnounced { .. } => included_htlcs += 1,
1896 let num_htlcs = included_htlcs + addl_htlcs;
1897 let res = self.commit_tx_fee_msat(num_htlcs);
1898 #[cfg(any(test, feature = "fuzztarget"))]
1901 if fee_spike_buffer_htlc.is_some() {
1902 fee = self.commit_tx_fee_msat(num_htlcs - 1);
1904 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
1905 let commitment_tx_info = CommitmentTxInfoCached {
1907 total_pending_htlcs,
1908 next_holder_htlc_id: match htlc.origin {
1909 HTLCInitiator::LocalOffered => self.next_holder_htlc_id + 1,
1910 HTLCInitiator::RemoteOffered => self.next_holder_htlc_id,
1912 next_counterparty_htlc_id: match htlc.origin {
1913 HTLCInitiator::LocalOffered => self.next_counterparty_htlc_id,
1914 HTLCInitiator::RemoteOffered => self.next_counterparty_htlc_id + 1,
1916 feerate: self.feerate_per_kw,
1918 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = Some(commitment_tx_info);
1923 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>
1924 where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
1925 // We can't accept HTLCs sent after we've sent a shutdown.
1926 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1927 if local_sent_shutdown {
1928 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
1930 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
1931 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1932 if remote_sent_shutdown {
1933 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
1935 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1936 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
1938 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1939 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
1941 if msg.amount_msat == 0 {
1942 return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
1944 if msg.amount_msat < self.holder_htlc_minimum_msat {
1945 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)));
1948 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1949 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1950 return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
1952 let holder_max_htlc_value_in_flight_msat = Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
1953 if htlc_inbound_value_msat + msg.amount_msat > holder_max_htlc_value_in_flight_msat {
1954 return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", holder_max_htlc_value_in_flight_msat)));
1956 // Check holder_selected_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1957 // the reserve_satoshis we told them to always have as direct payment so that they lose
1958 // something if we punish them for broadcasting an old state).
1959 // Note that we don't really care about having a small/no to_remote output in our local
1960 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1961 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1962 // present in the next commitment transaction we send them (at least for fulfilled ones,
1963 // failed ones won't modify value_to_self).
1964 // Note that we will send HTLCs which another instance of rust-lightning would think
1965 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1966 // Channel state once they will not be present in the next received commitment
1968 let mut removed_outbound_total_msat = 0;
1969 for ref htlc in self.pending_outbound_htlcs.iter() {
1970 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1971 removed_outbound_total_msat += htlc.amount_msat;
1972 } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1973 removed_outbound_total_msat += htlc.amount_msat;
1977 let pending_value_to_self_msat =
1978 self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
1979 let pending_remote_value_msat =
1980 self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
1981 if pending_remote_value_msat < msg.amount_msat {
1982 return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
1985 // Check that the remote can afford to pay for this HTLC on-chain at the current
1986 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
1987 let remote_commit_tx_fee_msat = if self.is_outbound() { 0 } else {
1988 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
1989 self.next_remote_commit_tx_fee_msat(htlc_candidate, None) // Don't include the extra fee spike buffer HTLC in calculations
1991 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
1992 return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
1995 let chan_reserve_msat =
1996 Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
1997 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
1998 return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
2001 if !self.is_outbound() {
2002 // `2 *` and `Some(())` is for the fee spike buffer we keep for the remote. This deviates from
2003 // the spec because in the spec, the fee spike buffer requirement doesn't exist on the
2004 // receiver's side, only on the sender's.
2005 // Note that when we eventually remove support for fee updates and switch to anchor output
2006 // fees, we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep
2007 // the extra htlc when calculating the next remote commitment transaction fee as we should
2008 // still be able to afford adding this HTLC plus one more future HTLC, regardless of being
2009 // sensitive to fee spikes.
2010 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2011 let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(htlc_candidate, Some(()));
2012 if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
2013 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
2014 // the HTLC, i.e. its status is already set to failing.
2015 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation");
2016 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
2019 // Check that they won't violate our local required channel reserve by adding this HTLC.
2020 let htlc_candidate = HTLCCandidate::new(msg.amount_msat, HTLCInitiator::RemoteOffered);
2021 let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(htlc_candidate, None);
2022 if self.value_to_self_msat < self.counterparty_selected_channel_reserve_satoshis * 1000 + local_commit_tx_fee_msat {
2023 return Err(ChannelError::Close("Cannot accept HTLC that would put our balance under counterparty-announced channel reserve value".to_owned()));
2026 if self.next_counterparty_htlc_id != msg.htlc_id {
2027 return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_counterparty_htlc_id)));
2029 if msg.cltv_expiry >= 500000000 {
2030 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
2033 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
2034 if let PendingHTLCStatus::Forward(_) = pending_forward_status {
2035 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
2039 // Now update local state:
2040 self.next_counterparty_htlc_id += 1;
2041 self.pending_inbound_htlcs.push(InboundHTLCOutput {
2042 htlc_id: msg.htlc_id,
2043 amount_msat: msg.amount_msat,
2044 payment_hash: msg.payment_hash,
2045 cltv_expiry: msg.cltv_expiry,
2046 state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
2051 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
2053 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
2054 for htlc in self.pending_outbound_htlcs.iter_mut() {
2055 if htlc.htlc_id == htlc_id {
2056 match check_preimage {
2058 Some(payment_hash) =>
2059 if payment_hash != htlc.payment_hash {
2060 return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
2064 OutboundHTLCState::LocalAnnounced(_) =>
2065 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
2066 OutboundHTLCState::Committed => {
2067 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
2069 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
2070 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
2072 return Ok(&htlc.source);
2075 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
2078 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
2079 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2080 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
2082 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2083 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
2086 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
2087 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
2090 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2091 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2092 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
2094 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2095 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
2098 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2102 pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
2103 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2104 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
2106 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2107 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
2110 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
2114 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)>
2115 where F::Target: FeeEstimator,
2118 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2119 return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
2121 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2122 return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
2124 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2125 return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
2128 let funding_script = self.get_funding_redeemscript();
2130 let keys = self.build_holder_transaction_keys(self.cur_holder_commitment_transaction_number).map_err(|e| (None, e))?;
2132 let mut update_fee = false;
2133 let feerate_per_kw = if !self.is_outbound() && self.pending_update_fee.is_some() {
2135 self.pending_update_fee.unwrap()
2140 let (num_htlcs, mut htlcs_cloned, commitment_tx, commitment_txid) = {
2141 let commitment_tx = self.build_commitment_transaction(self.cur_holder_commitment_transaction_number, &keys, true, false, feerate_per_kw, logger);
2142 let commitment_txid = {
2143 let trusted_tx = commitment_tx.0.trust();
2144 let bitcoin_tx = trusted_tx.built_transaction();
2145 let sighash = bitcoin_tx.get_sighash_all(&funding_script, self.channel_value_satoshis);
2147 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.counterparty_funding_pubkey().serialize()), encode::serialize_hex(&bitcoin_tx.transaction), log_bytes!(sighash[..]), encode::serialize_hex(&funding_script));
2148 if let Err(_) = self.secp_ctx.verify(&sighash, &msg.signature, &self.counterparty_funding_pubkey()) {
2149 return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
2153 let htlcs_cloned: Vec<_> = commitment_tx.2.iter().map(|htlc| (htlc.0.clone(), htlc.1.map(|h| h.clone()))).collect();
2154 (commitment_tx.1, htlcs_cloned, commitment_tx.0, commitment_txid)
2157 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
2158 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
2160 let counterparty_reserve_we_require = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
2161 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + counterparty_reserve_we_require {
2162 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
2165 #[cfg(any(test, feature = "fuzztarget"))]
2167 if self.is_outbound() {
2168 let projected_commit_tx_info = self.next_local_commitment_tx_fee_info_cached.lock().unwrap().take();
2169 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2170 if let Some(info) = projected_commit_tx_info {
2171 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len()
2172 + self.holding_cell_htlc_updates.len();
2173 if info.total_pending_htlcs == total_pending_htlcs
2174 && info.next_holder_htlc_id == self.next_holder_htlc_id
2175 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
2176 && info.feerate == self.feerate_per_kw {
2177 assert_eq!(total_fee, info.fee / 1000);
2183 if msg.htlc_signatures.len() != num_htlcs {
2184 return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), num_htlcs))));
2187 // TODO: Sadly, we pass HTLCs twice to ChannelMonitor: once via the HolderCommitmentTransaction and once via the update
2188 let mut htlcs_and_sigs = Vec::with_capacity(htlcs_cloned.len());
2189 for (idx, (htlc, source)) in htlcs_cloned.drain(..).enumerate() {
2190 if let Some(_) = htlc.transaction_output_index {
2191 let htlc_tx = self.build_htlc_transaction(&commitment_txid, &htlc, true, &keys, feerate_per_kw);
2192 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
2193 let htlc_sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]);
2194 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(keys.countersignatory_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript));
2195 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &keys.countersignatory_htlc_key) {
2196 return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2198 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2200 htlcs_and_sigs.push((htlc, None, source));
2204 let holder_commitment_tx = HolderCommitmentTransaction::new(
2207 msg.htlc_signatures.clone(),
2208 &self.get_holder_pubkeys().funding_pubkey,
2209 self.counterparty_funding_pubkey()
2212 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number - 1, &self.secp_ctx);
2213 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 1);
2215 // Update state now that we've passed all the can-fail calls...
2216 let mut need_commitment = false;
2217 if !self.is_outbound() {
2218 if let Some(fee_update) = self.pending_update_fee {
2219 self.feerate_per_kw = fee_update;
2220 // We later use the presence of pending_update_fee to indicate we should generate a
2221 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2222 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2223 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2224 need_commitment = true;
2225 self.pending_update_fee = None;
2230 self.latest_monitor_update_id += 1;
2231 let mut monitor_update = ChannelMonitorUpdate {
2232 update_id: self.latest_monitor_update_id,
2233 updates: vec![ChannelMonitorUpdateStep::LatestHolderCommitmentTXInfo {
2234 commitment_tx: holder_commitment_tx,
2235 htlc_outputs: htlcs_and_sigs
2239 for htlc in self.pending_inbound_htlcs.iter_mut() {
2240 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2241 Some(forward_info.clone())
2243 if let Some(forward_info) = new_forward {
2244 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2245 need_commitment = true;
2248 for htlc in self.pending_outbound_htlcs.iter_mut() {
2249 if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2250 Some(fail_reason.take())
2252 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2253 need_commitment = true;
2257 self.cur_holder_commitment_transaction_number -= 1;
2258 // Note that if we need_commitment & !AwaitingRemoteRevoke we'll call
2259 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2260 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2262 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2263 // In case we initially failed monitor updating without requiring a response, we need
2264 // to make sure the RAA gets sent first.
2265 self.monitor_pending_revoke_and_ack = true;
2266 if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2267 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2268 // the corresponding HTLC status updates so that get_last_commitment_update
2269 // includes the right HTLCs.
2270 self.monitor_pending_commitment_signed = true;
2271 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2272 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2273 // strictly increasing by one, so decrement it here.
2274 self.latest_monitor_update_id = monitor_update.update_id;
2275 monitor_update.updates.append(&mut additional_update.updates);
2277 // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2278 // re-send the message on restoration)
2279 return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2282 let (commitment_signed, closing_signed) = if need_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2283 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2284 // we'll send one right away when we get the revoke_and_ack when we
2285 // free_holding_cell_htlcs().
2286 let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2287 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2288 // strictly increasing by one, so decrement it here.
2289 self.latest_monitor_update_id = monitor_update.update_id;
2290 monitor_update.updates.append(&mut additional_update.updates);
2292 } else if !need_commitment {
2293 (None, self.maybe_propose_first_closing_signed(fee_estimator))
2294 } else { (None, None) };
2296 Ok((msgs::RevokeAndACK {
2297 channel_id: self.channel_id,
2298 per_commitment_secret,
2299 next_per_commitment_point,
2300 }, commitment_signed, closing_signed, monitor_update))
2303 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2304 /// fulfilling or failing the last pending HTLC)
2305 fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2306 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2307 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2308 log_trace!(logger, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
2310 let mut monitor_update = ChannelMonitorUpdate {
2311 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2312 updates: Vec::new(),
2315 let mut htlc_updates = Vec::new();
2316 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2317 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2318 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2319 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2320 let mut htlcs_to_fail = Vec::new();
2321 for htlc_update in htlc_updates.drain(..) {
2322 // Note that this *can* fail, though it should be due to rather-rare conditions on
2323 // fee races with adding too many outputs which push our total payments just over
2324 // the limit. In case it's less rare than I anticipate, we may want to revisit
2325 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2326 // to rebalance channels.
2327 match &htlc_update {
2328 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2329 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2330 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2333 ChannelError::Ignore(ref msg) => {
2334 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2335 // If we fail to send here, then this HTLC should
2336 // be failed backwards. Failing to send here
2337 // indicates that this HTLC may keep being put back
2338 // into the holding cell without ever being
2339 // successfully forwarded/failed/fulfilled, causing
2340 // our counterparty to eventually close on us.
2341 htlcs_to_fail.push((source.clone(), *payment_hash));
2344 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2350 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2351 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2352 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2353 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2354 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2355 monitor_update.updates.append(&mut additional_monitor_update.updates);
2359 if let ChannelError::Ignore(_) = e {}
2361 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2366 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2367 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2368 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2370 if let ChannelError::Ignore(_) = e {}
2372 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2379 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2380 return Ok((None, htlcs_to_fail));
2382 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2383 self.pending_update_fee = self.holding_cell_update_fee.take();
2384 Some(msgs::UpdateFee {
2385 channel_id: self.channel_id,
2386 feerate_per_kw: feerate as u32,
2392 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2393 // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2394 // but we want them to be strictly increasing by one, so reset it here.
2395 self.latest_monitor_update_id = monitor_update.update_id;
2396 monitor_update.updates.append(&mut additional_update.updates);
2398 Ok((Some((msgs::CommitmentUpdate {
2400 update_fulfill_htlcs,
2402 update_fail_malformed_htlcs: Vec::new(),
2405 }, monitor_update)), htlcs_to_fail))
2407 Ok((None, Vec::new()))
2411 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2412 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2413 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2414 /// generating an appropriate error *after* the channel state has been updated based on the
2415 /// revoke_and_ack message.
2416 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>
2417 where F::Target: FeeEstimator,
2420 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2421 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2423 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2424 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2426 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2427 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2430 if let Some(counterparty_prev_commitment_point) = self.counterparty_prev_commitment_point {
2431 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 {
2432 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2436 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2437 // Our counterparty seems to have burned their coins to us (by revoking a state when we
2438 // haven't given them a new commitment transaction to broadcast). We should probably
2439 // take advantage of this by updating our channel monitor, sending them an error, and
2440 // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2441 // lot of work, and there's some chance this is all a misunderstanding anyway.
2442 // We have to do *something*, though, since our signer may get mad at us for otherwise
2443 // jumping a remote commitment number, so best to just force-close and move on.
2444 return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2447 #[cfg(any(test, feature = "fuzztarget"))]
2449 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
2450 *self.next_remote_commitment_tx_fee_info_cached.lock().unwrap() = None;
2453 self.commitment_secrets.provide_secret(self.cur_counterparty_commitment_transaction_number + 1, msg.per_commitment_secret)
2454 .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2455 self.latest_monitor_update_id += 1;
2456 let mut monitor_update = ChannelMonitorUpdate {
2457 update_id: self.latest_monitor_update_id,
2458 updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2459 idx: self.cur_counterparty_commitment_transaction_number + 1,
2460 secret: msg.per_commitment_secret,
2464 // Update state now that we've passed all the can-fail calls...
2465 // (note that we may still fail to generate the new commitment_signed message, but that's
2466 // OK, we step the channel here and *then* if the new generation fails we can fail the
2467 // channel based on that, but stepping stuff here should be safe either way.
2468 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2469 self.counterparty_prev_commitment_point = self.counterparty_cur_commitment_point;
2470 self.counterparty_cur_commitment_point = Some(msg.next_per_commitment_point);
2471 self.cur_counterparty_commitment_transaction_number -= 1;
2473 log_trace!(logger, "Updating HTLCs on receipt of RAA...");
2474 let mut to_forward_infos = Vec::new();
2475 let mut revoked_htlcs = Vec::new();
2476 let mut update_fail_htlcs = Vec::new();
2477 let mut update_fail_malformed_htlcs = Vec::new();
2478 let mut require_commitment = false;
2479 let mut value_to_self_msat_diff: i64 = 0;
2482 // Take references explicitly so that we can hold multiple references to self.
2483 let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2484 let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2486 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2487 pending_inbound_htlcs.retain(|htlc| {
2488 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2489 log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2490 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2491 value_to_self_msat_diff += htlc.amount_msat as i64;
2496 pending_outbound_htlcs.retain(|htlc| {
2497 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2498 log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2499 if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2500 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2502 // They fulfilled, so we sent them money
2503 value_to_self_msat_diff -= htlc.amount_msat as i64;
2508 for htlc in pending_inbound_htlcs.iter_mut() {
2509 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2510 log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2512 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2513 log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2517 let mut state = InboundHTLCState::Committed;
2518 mem::swap(&mut state, &mut htlc.state);
2520 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2521 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2522 require_commitment = true;
2523 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2524 match forward_info {
2525 PendingHTLCStatus::Fail(fail_msg) => {
2526 require_commitment = true;
2528 HTLCFailureMsg::Relay(msg) => {
2529 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2530 update_fail_htlcs.push(msg)
2532 HTLCFailureMsg::Malformed(msg) => {
2533 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2534 update_fail_malformed_htlcs.push(msg)
2538 PendingHTLCStatus::Forward(forward_info) => {
2539 to_forward_infos.push((forward_info, htlc.htlc_id));
2540 htlc.state = InboundHTLCState::Committed;
2546 for htlc in pending_outbound_htlcs.iter_mut() {
2547 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2548 log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2549 htlc.state = OutboundHTLCState::Committed;
2551 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2552 Some(fail_reason.take())
2554 log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2555 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2556 require_commitment = true;
2560 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2562 if self.is_outbound() {
2563 if let Some(feerate) = self.pending_update_fee.take() {
2564 self.feerate_per_kw = feerate;
2567 if let Some(feerate) = self.pending_update_fee {
2568 // Because a node cannot send two commitment_signeds in a row without getting a
2569 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2570 // it should use to create keys with) and because a node can't send a
2571 // commitment_signed without changes, checking if the feerate is equal to the
2572 // pending feerate update is sufficient to detect require_commitment.
2573 if feerate == self.feerate_per_kw {
2574 require_commitment = true;
2575 self.pending_update_fee = None;
2580 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2581 // We can't actually generate a new commitment transaction (incl by freeing holding
2582 // cells) while we can't update the monitor, so we just return what we have.
2583 if require_commitment {
2584 self.monitor_pending_commitment_signed = true;
2585 // When the monitor updating is restored we'll call get_last_commitment_update(),
2586 // which does not update state, but we're definitely now awaiting a remote revoke
2587 // before we can step forward any more, so set it here.
2588 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2589 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2590 // strictly increasing by one, so decrement it here.
2591 self.latest_monitor_update_id = monitor_update.update_id;
2592 monitor_update.updates.append(&mut additional_update.updates);
2594 self.monitor_pending_forwards.append(&mut to_forward_infos);
2595 self.monitor_pending_failures.append(&mut revoked_htlcs);
2596 return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2599 match self.free_holding_cell_htlcs(logger)? {
2600 (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2601 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2602 for fail_msg in update_fail_htlcs.drain(..) {
2603 commitment_update.update_fail_htlcs.push(fail_msg);
2605 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2606 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2607 commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2610 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2611 // strictly increasing by one, so decrement it here.
2612 self.latest_monitor_update_id = monitor_update.update_id;
2613 monitor_update.updates.append(&mut additional_update.updates);
2615 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2617 (None, htlcs_to_fail) => {
2618 if require_commitment {
2619 let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2621 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2622 // strictly increasing by one, so decrement it here.
2623 self.latest_monitor_update_id = monitor_update.update_id;
2624 monitor_update.updates.append(&mut additional_update.updates);
2626 Ok((Some(msgs::CommitmentUpdate {
2627 update_add_htlcs: Vec::new(),
2628 update_fulfill_htlcs: Vec::new(),
2630 update_fail_malformed_htlcs,
2633 }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2635 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2642 /// Adds a pending update to this channel. See the doc for send_htlc for
2643 /// further details on the optionness of the return value.
2644 /// You MUST call send_commitment prior to any other calls on this Channel
2645 fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2646 if !self.is_outbound() {
2647 panic!("Cannot send fee from inbound channel");
2649 if !self.is_usable() {
2650 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2652 if !self.is_live() {
2653 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2656 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2657 self.holding_cell_update_fee = Some(feerate_per_kw);
2661 debug_assert!(self.pending_update_fee.is_none());
2662 self.pending_update_fee = Some(feerate_per_kw);
2664 Some(msgs::UpdateFee {
2665 channel_id: self.channel_id,
2670 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 {
2671 match self.send_update_fee(feerate_per_kw) {
2672 Some(update_fee) => {
2673 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2674 Ok(Some((update_fee, commitment_signed, monitor_update)))
2680 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2681 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2682 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2683 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2684 /// No further message handling calls may be made until a channel_reestablish dance has
2686 pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Vec<(HTLCSource, PaymentHash)> where L::Target: Logger {
2687 let mut outbound_drops = Vec::new();
2689 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2690 if self.channel_state < ChannelState::FundingSent as u32 {
2691 self.channel_state = ChannelState::ShutdownComplete as u32;
2692 return outbound_drops;
2694 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2695 // will be retransmitted.
2696 self.last_sent_closing_fee = None;
2698 let mut inbound_drop_count = 0;
2699 self.pending_inbound_htlcs.retain(|htlc| {
2701 InboundHTLCState::RemoteAnnounced(_) => {
2702 // They sent us an update_add_htlc but we never got the commitment_signed.
2703 // We'll tell them what commitment_signed we're expecting next and they'll drop
2704 // this HTLC accordingly
2705 inbound_drop_count += 1;
2708 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2709 // We received a commitment_signed updating this HTLC and (at least hopefully)
2710 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2711 // in response to it yet, so don't touch it.
2714 InboundHTLCState::Committed => true,
2715 InboundHTLCState::LocalRemoved(_) => {
2716 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2717 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2718 // (that we missed). Keep this around for now and if they tell us they missed
2719 // the commitment_signed we can re-transmit the update then.
2724 self.next_counterparty_htlc_id -= inbound_drop_count;
2726 for htlc in self.pending_outbound_htlcs.iter_mut() {
2727 if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2728 // They sent us an update to remove this but haven't yet sent the corresponding
2729 // commitment_signed, we need to move it back to Committed and they can re-send
2730 // the update upon reconnection.
2731 htlc.state = OutboundHTLCState::Committed;
2735 self.holding_cell_htlc_updates.retain(|htlc_update| {
2737 // Note that currently on channel reestablish we assert that there are
2738 // no holding cell HTLC update_adds, so if in the future we stop
2739 // dropping added HTLCs here and failing them backwards, then there will
2740 // need to be corresponding changes made in the Channel's re-establish
2742 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2743 outbound_drops.push((source.clone(), payment_hash.clone()));
2746 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2749 self.channel_state |= ChannelState::PeerDisconnected as u32;
2750 log_debug!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2754 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2755 /// updates are partially paused.
2756 /// This must be called immediately after the call which generated the ChannelMonitor update
2757 /// which failed. The messages which were generated from that call which generated the
2758 /// monitor update failure must *not* have been sent to the remote end, and must instead
2759 /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2760 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)>) {
2761 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2762 self.monitor_pending_revoke_and_ack = resend_raa;
2763 self.monitor_pending_commitment_signed = resend_commitment;
2764 assert!(self.monitor_pending_forwards.is_empty());
2765 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2766 assert!(self.monitor_pending_failures.is_empty());
2767 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2768 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2771 /// Indicates that the latest ChannelMonitor update has been committed by the client
2772 /// successfully and we should restore normal operation. Returns messages which should be sent
2773 /// to the remote side.
2774 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)>, bool, Option<msgs::FundingLocked>) where L::Target: Logger {
2775 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2776 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2778 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.is_outbound();
2780 // Because we will never generate a FundingBroadcastSafe event when we're in
2781 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2782 // they received the FundingBroadcastSafe event, we can only ever hit
2783 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2784 // monitor on funding_created, and we even got the funding transaction confirmed before the
2785 // monitor was persisted.
2786 let funding_locked = if self.monitor_pending_funding_locked {
2787 assert!(!self.is_outbound(), "Funding transaction broadcast without FundingBroadcastSafe!");
2788 self.monitor_pending_funding_locked = false;
2789 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2790 Some(msgs::FundingLocked {
2791 channel_id: self.channel_id(),
2792 next_per_commitment_point,
2796 let mut forwards = Vec::new();
2797 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2798 let mut failures = Vec::new();
2799 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2801 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2802 self.monitor_pending_revoke_and_ack = false;
2803 self.monitor_pending_commitment_signed = false;
2804 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2807 let raa = if self.monitor_pending_revoke_and_ack {
2808 Some(self.get_last_revoke_and_ack())
2810 let commitment_update = if self.monitor_pending_commitment_signed {
2811 Some(self.get_last_commitment_update(logger))
2814 self.monitor_pending_revoke_and_ack = false;
2815 self.monitor_pending_commitment_signed = false;
2816 let order = self.resend_order.clone();
2817 log_trace!(logger, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2818 if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2819 if commitment_update.is_some() { "a" } else { "no" },
2820 if raa.is_some() { "an" } else { "no" },
2821 match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2822 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2825 pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2826 where F::Target: FeeEstimator
2828 if self.is_outbound() {
2829 return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2831 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2832 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2834 Channel::<Signer>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2835 self.pending_update_fee = Some(msg.feerate_per_kw);
2836 self.update_time_counter += 1;
2840 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2841 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2842 let per_commitment_secret = self.holder_signer.release_commitment_secret(self.cur_holder_commitment_transaction_number + 2);
2843 msgs::RevokeAndACK {
2844 channel_id: self.channel_id,
2845 per_commitment_secret,
2846 next_per_commitment_point,
2850 fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2851 let mut update_add_htlcs = Vec::new();
2852 let mut update_fulfill_htlcs = Vec::new();
2853 let mut update_fail_htlcs = Vec::new();
2854 let mut update_fail_malformed_htlcs = Vec::new();
2856 for htlc in self.pending_outbound_htlcs.iter() {
2857 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2858 update_add_htlcs.push(msgs::UpdateAddHTLC {
2859 channel_id: self.channel_id(),
2860 htlc_id: htlc.htlc_id,
2861 amount_msat: htlc.amount_msat,
2862 payment_hash: htlc.payment_hash,
2863 cltv_expiry: htlc.cltv_expiry,
2864 onion_routing_packet: (**onion_packet).clone(),
2869 for htlc in self.pending_inbound_htlcs.iter() {
2870 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2872 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2873 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2874 channel_id: self.channel_id(),
2875 htlc_id: htlc.htlc_id,
2876 reason: err_packet.clone()
2879 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2880 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2881 channel_id: self.channel_id(),
2882 htlc_id: htlc.htlc_id,
2883 sha256_of_onion: sha256_of_onion.clone(),
2884 failure_code: failure_code.clone(),
2887 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2888 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2889 channel_id: self.channel_id(),
2890 htlc_id: htlc.htlc_id,
2891 payment_preimage: payment_preimage.clone(),
2898 log_trace!(logger, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2899 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2900 msgs::CommitmentUpdate {
2901 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2903 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,
2907 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2908 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2909 pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
2910 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2911 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2912 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2913 // just close here instead of trying to recover.
2914 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
2917 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2918 msg.next_local_commitment_number == 0 {
2919 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
2922 if msg.next_remote_commitment_number > 0 {
2923 match msg.data_loss_protect {
2924 OptionalField::Present(ref data_loss) => {
2925 let expected_point = self.holder_signer.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
2926 let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
2927 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
2928 if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
2929 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
2931 if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
2932 return Err(ChannelError::CloseDelayBroadcast(
2933 "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()
2937 OptionalField::Absent => {}
2941 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2942 // remaining cases either succeed or ErrorMessage-fail).
2943 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2945 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2946 Some(msgs::Shutdown {
2947 channel_id: self.channel_id,
2948 scriptpubkey: self.get_closing_scriptpubkey(),
2952 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2953 // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2954 if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2955 self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2956 if msg.next_remote_commitment_number != 0 {
2957 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
2959 // Short circuit the whole handler as there is nothing we can resend them
2960 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2963 // We have OurFundingLocked set!
2964 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2965 return Ok((Some(msgs::FundingLocked {
2966 channel_id: self.channel_id(),
2967 next_per_commitment_point,
2968 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2971 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number {
2972 // Remote isn't waiting on any RevokeAndACK from us!
2973 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2975 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_holder_commitment_transaction_number {
2976 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2977 self.monitor_pending_revoke_and_ack = true;
2980 Some(self.get_last_revoke_and_ack())
2983 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
2986 // We increment cur_counterparty_commitment_transaction_number only upon receipt of
2987 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2988 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2989 // the corresponding revoke_and_ack back yet.
2990 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 };
2992 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number == 1 {
2993 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2994 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
2995 Some(msgs::FundingLocked {
2996 channel_id: self.channel_id(),
2997 next_per_commitment_point,
3001 if msg.next_local_commitment_number == next_counterparty_commitment_number {
3002 if required_revoke.is_some() {
3003 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
3005 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
3008 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
3009 // Note that if in the future we no longer drop holding cell update_adds on peer
3010 // disconnect, this logic will need to be updated.
3011 for htlc_update in self.holding_cell_htlc_updates.iter() {
3012 if let &HTLCUpdateAwaitingACK::AddHTLC { .. } = htlc_update {
3013 debug_assert!(false, "There shouldn't be any add-HTLCs in the holding cell now because they should have been dropped on peer disconnect. Panic here because said HTLCs won't be handled correctly.");
3017 // We're up-to-date and not waiting on a remote revoke (if we are our
3018 // channel_reestablish should result in them sending a revoke_and_ack), but we may
3019 // have received some updates while we were disconnected. Free the holding cell
3021 match self.free_holding_cell_htlcs(logger) {
3022 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
3023 Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
3024 Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
3025 // If in the future we no longer drop holding cell update_adds on peer
3026 // disconnect, we may be handed some HTLCs to fail backwards here.
3027 assert!(htlcs_to_fail.is_empty());
3028 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg));
3030 Ok((None, htlcs_to_fail)) => {
3031 // If in the future we no longer drop holding cell update_adds on peer
3032 // disconnect, we may be handed some HTLCs to fail backwards here.
3033 assert!(htlcs_to_fail.is_empty());
3034 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
3038 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
3040 } else if msg.next_local_commitment_number == next_counterparty_commitment_number - 1 {
3041 if required_revoke.is_some() {
3042 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
3044 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
3047 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
3048 self.monitor_pending_commitment_signed = true;
3049 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
3052 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), shutdown_msg));
3054 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
3058 fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
3059 where F::Target: FeeEstimator
3061 if !self.is_outbound() || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
3062 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
3063 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
3067 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3068 if self.feerate_per_kw > proposed_feerate {
3069 proposed_feerate = self.feerate_per_kw;
3071 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3072 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
3074 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
3075 let sig = self.holder_signer
3076 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3078 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3079 if sig.is_none() { return None; }
3081 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, sig.clone().unwrap()));
3082 Some(msgs::ClosingSigned {
3083 channel_id: self.channel_id,
3084 fee_satoshis: total_fee_satoshis,
3085 signature: sig.unwrap(),
3089 pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
3090 where F::Target: FeeEstimator
3092 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3093 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
3095 if self.channel_state < ChannelState::FundingSent as u32 {
3096 // Spec says we should fail the connection, not the channel, but that's nonsense, there
3097 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
3098 // can do that via error message without getting a connection fail anyway...
3099 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
3101 for htlc in self.pending_inbound_htlcs.iter() {
3102 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3103 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
3106 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3108 if is_unsupported_shutdown_script(&their_features, &msg.scriptpubkey) {
3109 return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
3112 if self.counterparty_shutdown_scriptpubkey.is_some() {
3113 if Some(&msg.scriptpubkey) != self.counterparty_shutdown_scriptpubkey.as_ref() {
3114 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
3117 self.counterparty_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
3120 // From here on out, we may not fail!
3122 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
3123 self.update_time_counter += 1;
3125 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
3126 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
3127 // cell HTLCs and return them to fail the payment.
3128 self.holding_cell_update_fee = None;
3129 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3130 self.holding_cell_htlc_updates.retain(|htlc_update| {
3132 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3133 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3139 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
3140 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
3141 // any further commitment updates after we set LocalShutdownSent.
3143 let shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3146 Some(msgs::Shutdown {
3147 channel_id: self.channel_id,
3148 scriptpubkey: self.get_closing_scriptpubkey(),
3152 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3153 self.update_time_counter += 1;
3155 Ok((shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
3158 fn build_signed_closing_transaction(&self, tx: &mut Transaction, counterparty_sig: &Signature, sig: &Signature) {
3159 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
3160 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
3161 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
3163 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
3165 let funding_key = self.get_holder_pubkeys().funding_pubkey.serialize();
3166 let counterparty_funding_key = self.counterparty_funding_pubkey().serialize();
3167 if funding_key[..] < counterparty_funding_key[..] {
3168 tx.input[0].witness.push(sig.serialize_der().to_vec());
3169 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3171 tx.input[0].witness.push(counterparty_sig.serialize_der().to_vec());
3172 tx.input[0].witness.push(sig.serialize_der().to_vec());
3174 tx.input[0].witness[1].push(SigHashType::All as u8);
3175 tx.input[0].witness[2].push(SigHashType::All as u8);
3177 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
3180 pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
3181 where F::Target: FeeEstimator
3183 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3184 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3186 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3187 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3189 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3190 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3192 if msg.fee_satoshis > 21_000_000 * 1_0000_0000 { //this is required to stop potential overflow in build_closing_transaction
3193 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3196 let funding_redeemscript = self.get_funding_redeemscript();
3197 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3198 if used_total_fee != msg.fee_satoshis {
3199 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)));
3201 let mut sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3203 match self.secp_ctx.verify(&sighash, &msg.signature, &self.get_counterparty_pubkeys().funding_pubkey) {
3206 // The remote end may have decided to revoke their output due to inconsistent dust
3207 // limits, so check for that case by re-checking the signature here.
3208 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3209 sighash = hash_to_message!(&bip143::SigHashCache::new(&closing_tx).signature_hash(0, &funding_redeemscript, self.channel_value_satoshis, SigHashType::All)[..]);
3210 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.counterparty_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3214 let closing_tx_max_weight = self.get_closing_transaction_weight(
3215 if let Some(oup) = closing_tx.output.get(0) { Some(&oup.script_pubkey) } else { None },
3216 if let Some(oup) = closing_tx.output.get(1) { Some(&oup.script_pubkey) } else { None });
3217 if let Some((_, last_fee, sig)) = self.last_sent_closing_fee {
3218 if last_fee == msg.fee_satoshis {
3219 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3220 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3221 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3222 self.channel_state = ChannelState::ShutdownComplete as u32;
3223 self.update_time_counter += 1;
3224 return Ok((None, Some(closing_tx)));
3228 macro_rules! propose_new_feerate {
3229 ($new_feerate: expr) => {
3230 let tx_weight = self.get_closing_transaction_weight(Some(&self.get_closing_scriptpubkey()), Some(self.counterparty_shutdown_scriptpubkey.as_ref().unwrap()));
3231 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * tx_weight / 1000, false);
3232 let sig = self.holder_signer
3233 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3234 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3235 assert!(closing_tx.get_weight() as u64 <= tx_weight);
3236 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, sig.clone()));
3237 return Ok((Some(msgs::ClosingSigned {
3238 channel_id: self.channel_id,
3239 fee_satoshis: used_total_fee,
3245 let mut min_feerate = 253;
3246 if self.is_outbound() {
3247 let max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3248 if (msg.fee_satoshis as u64) > max_feerate as u64 * closing_tx_max_weight / 1000 {
3249 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3250 if max_feerate <= last_feerate {
3251 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)));
3254 propose_new_feerate!(max_feerate);
3257 min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3259 if (msg.fee_satoshis as u64) < min_feerate as u64 * closing_tx_max_weight / 1000 {
3260 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3261 if min_feerate >= last_feerate {
3262 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)));
3265 propose_new_feerate!(min_feerate);
3268 let sig = self.holder_signer
3269 .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3270 .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3271 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &sig);
3272 assert!(closing_tx.get_weight() as u64 <= closing_tx_max_weight);
3273 debug_assert!(closing_tx.get_weight() as u64 >= closing_tx_max_weight - 2);
3275 self.channel_state = ChannelState::ShutdownComplete as u32;
3276 self.update_time_counter += 1;
3278 Ok((Some(msgs::ClosingSigned {
3279 channel_id: self.channel_id,
3280 fee_satoshis: msg.fee_satoshis,
3282 }), Some(closing_tx)))
3285 // Public utilities:
3287 pub fn channel_id(&self) -> [u8; 32] {
3291 /// Gets the "user_id" value passed into the construction of this channel. It has no special
3292 /// meaning and exists only to allow users to have a persistent identifier of a channel.
3293 pub fn get_user_id(&self) -> u64 {
3297 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3298 /// is_usable() returns true).
3299 /// Allowed in any state (including after shutdown)
3300 pub fn get_short_channel_id(&self) -> Option<u64> {
3301 self.short_channel_id
3304 /// Returns the funding_txo we either got from our peer, or were given by
3305 /// get_outbound_funding_created.
3306 pub fn get_funding_txo(&self) -> Option<OutPoint> {
3307 self.channel_transaction_parameters.funding_outpoint
3310 fn get_holder_selected_contest_delay(&self) -> u16 {
3311 self.channel_transaction_parameters.holder_selected_contest_delay
3314 fn get_holder_pubkeys(&self) -> &ChannelPublicKeys {
3315 &self.channel_transaction_parameters.holder_pubkeys
3318 fn get_counterparty_selected_contest_delay(&self) -> u16 {
3319 self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().selected_contest_delay
3322 fn get_counterparty_pubkeys(&self) -> &ChannelPublicKeys {
3323 &self.channel_transaction_parameters.counterparty_parameters.as_ref().unwrap().pubkeys
3326 /// Allowed in any state (including after shutdown)
3327 pub fn get_counterparty_node_id(&self) -> PublicKey {
3328 self.counterparty_node_id
3331 /// Allowed in any state (including after shutdown)
3333 pub fn get_holder_htlc_minimum_msat(&self) -> u64 {
3334 self.holder_htlc_minimum_msat
3337 /// Allowed in any state (including after shutdown)
3338 pub fn get_announced_htlc_max_msat(&self) -> u64 {
3340 // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3341 // to use full capacity. This is an effort to reduce routing failures, because in many cases
3342 // channel might have been used to route very small values (either by honest users or as DoS).
3343 self.channel_value_satoshis * 1000 * 9 / 10,
3345 Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3349 /// Allowed in any state (including after shutdown)
3350 pub fn get_counterparty_htlc_minimum_msat(&self) -> u64 {
3351 self.counterparty_htlc_minimum_msat
3354 pub fn get_value_satoshis(&self) -> u64 {
3355 self.channel_value_satoshis
3358 pub fn get_fee_proportional_millionths(&self) -> u32 {
3359 self.config.fee_proportional_millionths
3362 pub fn get_cltv_expiry_delta(&self) -> u16 {
3363 cmp::max(self.config.cltv_expiry_delta, MIN_CLTV_EXPIRY_DELTA)
3367 pub fn get_feerate(&self) -> u32 {
3371 pub fn get_cur_holder_commitment_transaction_number(&self) -> u64 {
3372 self.cur_holder_commitment_transaction_number + 1
3375 pub fn get_cur_counterparty_commitment_transaction_number(&self) -> u64 {
3376 self.cur_counterparty_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3379 pub fn get_revoked_counterparty_commitment_transaction_number(&self) -> u64 {
3380 self.cur_counterparty_commitment_transaction_number + 2
3384 pub fn get_signer(&self) -> &Signer {
3389 pub fn get_value_stat(&self) -> ChannelValueStat {
3391 value_to_self_msat: self.value_to_self_msat,
3392 channel_value_msat: self.channel_value_satoshis * 1000,
3393 channel_reserve_msat: self.counterparty_selected_channel_reserve_satoshis * 1000,
3394 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3395 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3396 holding_cell_outbound_amount_msat: {
3398 for h in self.holding_cell_htlc_updates.iter() {
3400 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3408 counterparty_max_htlc_value_in_flight_msat: self.counterparty_max_htlc_value_in_flight_msat,
3409 counterparty_dust_limit_msat: self.counterparty_dust_limit_satoshis * 1000,
3413 /// Allowed in any state (including after shutdown)
3414 pub fn get_update_time_counter(&self) -> u32 {
3415 self.update_time_counter
3418 pub fn get_latest_monitor_update_id(&self) -> u64 {
3419 self.latest_monitor_update_id
3422 pub fn should_announce(&self) -> bool {
3423 self.config.announced_channel
3426 pub fn is_outbound(&self) -> bool {
3427 self.channel_transaction_parameters.is_outbound_from_holder
3430 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3431 /// Allowed in any state (including after shutdown)
3432 pub fn get_holder_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3433 where F::Target: FeeEstimator
3435 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3436 // output value back into a transaction with the regular channel output:
3438 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3439 let mut res = self.feerate_per_kw as u64 * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3441 if self.is_outbound() {
3442 // + the marginal fee increase cost to us in the commitment transaction:
3443 res += self.feerate_per_kw as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3446 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3447 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as u64 * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3452 /// Returns true if we've ever received a message from the remote end for this Channel
3453 pub fn have_received_message(&self) -> bool {
3454 self.channel_state > (ChannelState::OurInitSent as u32)
3457 /// Returns true if this channel is fully established and not known to be closing.
3458 /// Allowed in any state (including after shutdown)
3459 pub fn is_usable(&self) -> bool {
3460 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3461 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3464 /// Returns true if this channel is currently available for use. This is a superset of
3465 /// is_usable() and considers things like the channel being temporarily disabled.
3466 /// Allowed in any state (including after shutdown)
3467 pub fn is_live(&self) -> bool {
3468 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3471 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3472 /// Allowed in any state (including after shutdown)
3473 pub fn is_awaiting_monitor_update(&self) -> bool {
3474 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3477 /// Returns true if funding_created was sent/received.
3478 pub fn is_funding_initiated(&self) -> bool {
3479 self.channel_state >= ChannelState::FundingSent as u32
3482 /// Returns true if this channel is fully shut down. True here implies that no further actions
3483 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3484 /// will be handled appropriately by the chain monitor.
3485 pub fn is_shutdown(&self) -> bool {
3486 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
3487 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3492 pub fn to_disabled_staged(&mut self) {
3493 self.network_sync = UpdateStatus::DisabledStaged;
3496 pub fn to_disabled_marked(&mut self) {
3497 self.network_sync = UpdateStatus::DisabledMarked;
3500 pub fn to_fresh(&mut self) {
3501 self.network_sync = UpdateStatus::Fresh;
3504 pub fn is_disabled_staged(&self) -> bool {
3505 self.network_sync == UpdateStatus::DisabledStaged
3508 pub fn is_disabled_marked(&self) -> bool {
3509 self.network_sync == UpdateStatus::DisabledMarked
3512 /// When we receive a new block, we (a) check whether the block contains the funding
3513 /// transaction (which would start us counting blocks until we send the funding_signed), and
3514 /// (b) check the height of the block against outbound holding cell HTLCs in case we need to
3515 /// give up on them prematurely and time them out. Everything else (e.g. commitment
3516 /// transaction broadcasts, channel closure detection, HTLC transaction broadcasting, etc) is
3517 /// handled by the ChannelMonitor.
3519 /// If we return Err, the channel may have been closed, at which point the standard
3520 /// requirements apply - no calls may be made except those explicitly stated to be allowed
3522 /// Only returns an ErrorAction of DisconnectPeer, if Err.
3524 /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3526 pub fn block_connected(&mut self, header: &BlockHeader, txdata: &TransactionData, height: u32) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
3527 let mut timed_out_htlcs = Vec::new();
3528 self.holding_cell_htlc_updates.retain(|htlc_update| {
3530 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3531 if *cltv_expiry <= height + HTLC_FAIL_BACK_BUFFER {
3532 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3540 if self.funding_tx_confirmations > 0 {
3541 self.funding_tx_confirmations += 1;
3544 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3545 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3546 for &(index_in_block, tx) in txdata.iter() {
3547 let funding_txo = self.get_funding_txo().unwrap();
3548 if tx.txid() == funding_txo.txid {
3549 let txo_idx = funding_txo.index as usize;
3550 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3551 tx.output[txo_idx].value != self.channel_value_satoshis {
3552 if self.is_outbound() {
3553 // If we generated the funding transaction and it doesn't match what it
3554 // should, the client is really broken and we should just panic and
3555 // tell them off. That said, because hash collisions happen with high
3556 // probability in fuzztarget mode, if we're fuzzing we just close the
3557 // channel and move on.
3558 #[cfg(not(feature = "fuzztarget"))]
3559 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3561 self.channel_state = ChannelState::ShutdownComplete as u32;
3562 self.update_time_counter += 1;
3563 return Err(msgs::ErrorMessage {
3564 channel_id: self.channel_id(),
3565 data: "funding tx had wrong script/value".to_owned()
3568 if self.is_outbound() {
3569 for input in tx.input.iter() {
3570 if input.witness.is_empty() {
3571 // We generated a malleable funding transaction, implying we've
3572 // just exposed ourselves to funds loss to our counterparty.
3573 #[cfg(not(feature = "fuzztarget"))]
3574 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3578 self.funding_tx_confirmations = 1;
3579 self.short_channel_id = match scid_from_parts(height as u64, index_in_block as u64, txo_idx as u64) {
3580 Ok(scid) => Some(scid),
3581 Err(_) => panic!("Block was bogus - either height was > 16 million, had > 16 million transactions, or had > 65k outputs"),
3588 self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3589 if self.funding_tx_confirmations > 0 {
3590 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3591 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3592 self.channel_state |= ChannelState::OurFundingLocked as u32;
3594 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3595 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3596 self.update_time_counter += 1;
3598 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3599 // We got a reorg but not enough to trigger a force close, just update
3600 // funding_tx_confirmed_in and return.
3602 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3603 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3605 // We got a reorg but not enough to trigger a force close, just update
3606 // funding_tx_confirmed_in and return.
3609 self.funding_tx_confirmed_in = Some(header.block_hash());
3611 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3612 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3613 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3614 //a protocol oversight, but I assume I'm just missing something.
3615 if need_commitment_update {
3616 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3617 let next_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3618 return Ok((Some(msgs::FundingLocked {
3619 channel_id: self.channel_id,
3620 next_per_commitment_point,
3621 }), timed_out_htlcs));
3623 self.monitor_pending_funding_locked = true;
3624 return Ok((None, timed_out_htlcs));
3629 Ok((None, timed_out_htlcs))
3632 /// Called by channelmanager based on chain blocks being disconnected.
3633 /// Returns true if we need to close the channel now due to funding transaction
3634 /// unconfirmation/reorg.
3635 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3636 if self.funding_tx_confirmations > 0 {
3637 self.funding_tx_confirmations -= 1;
3638 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3642 if Some(header.block_hash()) == self.funding_tx_confirmed_in {
3643 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3648 // Methods to get unprompted messages to send to the remote end (or where we already returned
3649 // something in the handler for the message that prompted this message):
3651 pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3652 if !self.is_outbound() {
3653 panic!("Tried to open a channel for an inbound channel?");
3655 if self.channel_state != ChannelState::OurInitSent as u32 {
3656 panic!("Cannot generate an open_channel after we've moved forward");
3659 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3660 panic!("Tried to send an open_channel for a channel that has already advanced");
3663 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3664 let keys = self.get_holder_pubkeys();
3668 temporary_channel_id: self.channel_id,
3669 funding_satoshis: self.channel_value_satoshis,
3670 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3671 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3672 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3673 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3674 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3675 feerate_per_kw: self.feerate_per_kw as u32,
3676 to_self_delay: self.get_holder_selected_contest_delay(),
3677 max_accepted_htlcs: OUR_MAX_HTLCS,
3678 funding_pubkey: keys.funding_pubkey,
3679 revocation_basepoint: keys.revocation_basepoint,
3680 payment_point: keys.payment_point,
3681 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3682 htlc_basepoint: keys.htlc_basepoint,
3683 first_per_commitment_point,
3684 channel_flags: if self.config.announced_channel {1} else {0},
3685 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3689 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3690 if self.is_outbound() {
3691 panic!("Tried to send accept_channel for an outbound channel?");
3693 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3694 panic!("Tried to send accept_channel after channel had moved forward");
3696 if self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3697 panic!("Tried to send an accept_channel for a channel that has already advanced");
3700 let first_per_commitment_point = self.holder_signer.get_per_commitment_point(self.cur_holder_commitment_transaction_number, &self.secp_ctx);
3701 let keys = self.get_holder_pubkeys();
3703 msgs::AcceptChannel {
3704 temporary_channel_id: self.channel_id,
3705 dust_limit_satoshis: self.holder_dust_limit_satoshis,
3706 max_htlc_value_in_flight_msat: Channel::<Signer>::get_holder_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3707 channel_reserve_satoshis: Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis),
3708 htlc_minimum_msat: self.holder_htlc_minimum_msat,
3709 minimum_depth: self.minimum_depth,
3710 to_self_delay: self.get_holder_selected_contest_delay(),
3711 max_accepted_htlcs: OUR_MAX_HTLCS,
3712 funding_pubkey: keys.funding_pubkey,
3713 revocation_basepoint: keys.revocation_basepoint,
3714 payment_point: keys.payment_point,
3715 delayed_payment_basepoint: keys.delayed_payment_basepoint,
3716 htlc_basepoint: keys.htlc_basepoint,
3717 first_per_commitment_point,
3718 shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3722 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3723 fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3724 let counterparty_keys = self.build_remote_transaction_keys()?;
3725 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;
3726 Ok(self.holder_signer.sign_counterparty_commitment(&counterparty_initial_commitment_tx, &self.secp_ctx)
3727 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3730 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3731 /// a funding_created message for the remote peer.
3732 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3733 /// or if called on an inbound channel.
3734 /// Note that channel_id changes during this call!
3735 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3736 /// If an Err is returned, it is a ChannelError::Close.
3737 pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
3738 if !self.is_outbound() {
3739 panic!("Tried to create outbound funding_created message on an inbound channel!");
3741 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3742 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)");
3744 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3745 self.cur_counterparty_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3746 self.cur_holder_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3747 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3750 self.channel_transaction_parameters.funding_outpoint = Some(funding_txo);
3751 self.holder_signer.ready_channel(&self.channel_transaction_parameters);
3753 let signature = match self.get_outbound_funding_created_signature(logger) {
3756 log_error!(logger, "Got bad signatures: {:?}!", e);
3757 self.channel_transaction_parameters.funding_outpoint = None;
3762 let temporary_channel_id = self.channel_id;
3764 // Now that we're past error-generating stuff, update our local state:
3766 self.channel_state = ChannelState::FundingCreated as u32;
3767 self.channel_id = funding_txo.to_channel_id();
3769 Ok(msgs::FundingCreated {
3770 temporary_channel_id,
3771 funding_txid: funding_txo.txid,
3772 funding_output_index: funding_txo.index,
3777 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3778 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3779 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3780 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3781 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3783 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3784 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3785 pub fn get_channel_announcement(&self, node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3786 if !self.config.announced_channel {
3787 return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3789 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3790 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3792 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3793 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3796 let were_node_one = node_id.serialize()[..] < self.counterparty_node_id.serialize()[..];
3798 let msg = msgs::UnsignedChannelAnnouncement {
3799 features: ChannelFeatures::known(),
3801 short_channel_id: self.get_short_channel_id().unwrap(),
3802 node_id_1: if were_node_one { node_id } else { self.get_counterparty_node_id() },
3803 node_id_2: if were_node_one { self.get_counterparty_node_id() } else { node_id },
3804 bitcoin_key_1: if were_node_one { self.get_holder_pubkeys().funding_pubkey } else { self.counterparty_funding_pubkey().clone() },
3805 bitcoin_key_2: if were_node_one { self.counterparty_funding_pubkey().clone() } else { self.get_holder_pubkeys().funding_pubkey },
3806 excess_data: Vec::new(),
3809 let sig = self.holder_signer.sign_channel_announcement(&msg, &self.secp_ctx)
3810 .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
3815 /// May panic if called on a channel that wasn't immediately-previously
3816 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3817 pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3818 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3819 assert_ne!(self.cur_counterparty_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3820 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3821 // current to_remote balances. However, it no longer has any use, and thus is now simply
3822 // set to a dummy (but valid, as required by the spec) public key.
3823 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3824 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3825 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3826 let mut pk = [2; 33]; pk[1] = 0xff;
3827 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3828 let data_loss_protect = if self.cur_counterparty_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3829 let remote_last_secret = self.commitment_secrets.get_secret(self.cur_counterparty_commitment_transaction_number + 2).unwrap();
3830 log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3831 OptionalField::Present(DataLossProtect {
3832 your_last_per_commitment_secret: remote_last_secret,
3833 my_current_per_commitment_point: dummy_pubkey
3836 log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3837 OptionalField::Present(DataLossProtect {
3838 your_last_per_commitment_secret: [0;32],
3839 my_current_per_commitment_point: dummy_pubkey,
3842 msgs::ChannelReestablish {
3843 channel_id: self.channel_id(),
3844 // The protocol has two different commitment number concepts - the "commitment
3845 // transaction number", which starts from 0 and counts up, and the "revocation key
3846 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3847 // commitment transaction numbers by the index which will be used to reveal the
3848 // revocation key for that commitment transaction, which means we have to convert them
3849 // to protocol-level commitment numbers here...
3851 // next_local_commitment_number is the next commitment_signed number we expect to
3852 // receive (indicating if they need to resend one that we missed).
3853 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_holder_commitment_transaction_number,
3854 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3855 // receive, however we track it by the next commitment number for a remote transaction
3856 // (which is one further, as they always revoke previous commitment transaction, not
3857 // the one we send) so we have to decrement by 1. Note that if
3858 // cur_counterparty_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3859 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3861 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_counterparty_commitment_transaction_number - 1,
3867 // Send stuff to our remote peers:
3869 /// Adds a pending outbound HTLC to this channel, note that you probably want
3870 /// send_htlc_and_commit instead cause you'll want both messages at once.
3871 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3872 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3873 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3874 /// You MUST call send_commitment prior to any other calls on this Channel
3875 /// If an Err is returned, it's a ChannelError::Ignore!
3876 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> {
3877 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3878 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
3880 let channel_total_msat = self.channel_value_satoshis * 1000;
3881 if amount_msat > channel_total_msat {
3882 return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
3885 if amount_msat == 0 {
3886 return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
3889 if amount_msat < self.counterparty_htlc_minimum_msat {
3890 return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.counterparty_htlc_minimum_msat)));
3893 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3894 // Note that this should never really happen, if we're !is_live() on receipt of an
3895 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3896 // the user to send directly into a !is_live() channel. However, if we
3897 // disconnected during the time the previous hop was doing the commitment dance we may
3898 // end up getting here after the forwarding delay. In any case, returning an
3899 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3900 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update".to_owned()));
3903 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3904 if outbound_htlc_count + 1 > self.counterparty_max_accepted_htlcs as u32 {
3905 return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.counterparty_max_accepted_htlcs)));
3907 // Check their_max_htlc_value_in_flight_msat
3908 if htlc_outbound_value_msat + amount_msat > self.counterparty_max_htlc_value_in_flight_msat {
3909 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)));
3912 if !self.is_outbound() {
3913 // Check that we won't violate the remote channel reserve by adding this HTLC.
3914 let counterparty_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
3915 let holder_selected_chan_reserve_msat = Channel::<Signer>::get_holder_selected_channel_reserve_satoshis(self.channel_value_satoshis);
3916 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
3917 let counterparty_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(htlc_candidate, None);
3918 if counterparty_balance_msat < holder_selected_chan_reserve_msat + counterparty_commit_tx_fee_msat {
3919 return Err(ChannelError::Ignore("Cannot send value that would put counterparty balance under holder-announced channel reserve value".to_owned()));
3923 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
3924 if pending_value_to_self_msat < amount_msat {
3925 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)));
3928 // `2 *` and extra HTLC are for the fee spike buffer.
3929 let commit_tx_fee_msat = if self.is_outbound() {
3930 let htlc_candidate = HTLCCandidate::new(amount_msat, HTLCInitiator::LocalOffered);
3931 2 * self.next_local_commit_tx_fee_msat(htlc_candidate, Some(()))
3933 if pending_value_to_self_msat - amount_msat < commit_tx_fee_msat {
3934 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)));
3937 // Check self.counterparty_selected_channel_reserve_satoshis (the amount we must keep as
3938 // reserve for the remote to have something to claim if we misbehave)
3939 let chan_reserve_msat = self.counterparty_selected_channel_reserve_satoshis * 1000;
3940 if pending_value_to_self_msat - amount_msat - commit_tx_fee_msat < chan_reserve_msat {
3941 return Err(ChannelError::Ignore(format!("Cannot send value that would put our balance under counterparty-announced channel reserve value ({})", chan_reserve_msat)));
3944 // Now update local state:
3945 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3946 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3951 onion_routing_packet,
3956 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3957 htlc_id: self.next_holder_htlc_id,
3959 payment_hash: payment_hash.clone(),
3961 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3965 let res = msgs::UpdateAddHTLC {
3966 channel_id: self.channel_id,
3967 htlc_id: self.next_holder_htlc_id,
3971 onion_routing_packet,
3973 self.next_holder_htlc_id += 1;
3978 /// Creates a signed commitment transaction to send to the remote peer.
3979 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3980 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3981 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3982 pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3983 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3984 panic!("Cannot create commitment tx until channel is fully established");
3986 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3987 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3989 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3990 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3992 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3993 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");
3995 let mut have_updates = self.pending_update_fee.is_some();
3996 for htlc in self.pending_outbound_htlcs.iter() {
3997 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3998 have_updates = true;
4000 if have_updates { break; }
4002 for htlc in self.pending_inbound_htlcs.iter() {
4003 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
4004 have_updates = true;
4006 if have_updates { break; }
4009 panic!("Cannot create commitment tx until we have some updates to send");
4011 self.send_commitment_no_status_check(logger)
4013 /// Only fails in case of bad keys
4014 fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
4015 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
4016 // fail to generate this, we still are at least at a position where upgrading their status
4018 for htlc in self.pending_inbound_htlcs.iter_mut() {
4019 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
4020 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
4022 if let Some(state) = new_state {
4026 for htlc in self.pending_outbound_htlcs.iter_mut() {
4027 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
4028 Some(fail_reason.take())
4030 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
4033 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
4035 let (res, counterparty_commitment_txid, htlcs) = match self.send_commitment_no_state_update(logger) {
4036 Ok((res, (counterparty_commitment_tx, mut htlcs))) => {
4037 // Update state now that we've passed all the can-fail calls...
4038 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
4039 htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
4040 (res, counterparty_commitment_tx, htlcs_no_ref)
4042 Err(e) => return Err(e),
4045 self.latest_monitor_update_id += 1;
4046 let monitor_update = ChannelMonitorUpdate {
4047 update_id: self.latest_monitor_update_id,
4048 updates: vec![ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTXInfo {
4049 commitment_txid: counterparty_commitment_txid,
4050 htlc_outputs: htlcs.clone(),
4051 commitment_number: self.cur_counterparty_commitment_transaction_number,
4052 their_revocation_point: self.counterparty_cur_commitment_point.unwrap()
4055 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
4056 Ok((res, monitor_update))
4059 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
4060 /// when we shouldn't change HTLC/channel state.
4061 fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Txid, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
4062 let mut feerate_per_kw = self.feerate_per_kw;
4063 if let Some(feerate) = self.pending_update_fee {
4064 if self.is_outbound() {
4065 feerate_per_kw = feerate;
4069 let counterparty_keys = self.build_remote_transaction_keys()?;
4070 let counterparty_commitment_tx = self.build_commitment_transaction(self.cur_counterparty_commitment_transaction_number, &counterparty_keys, false, true, feerate_per_kw, logger);
4071 let counterparty_commitment_txid = counterparty_commitment_tx.0.trust().txid();
4072 let (signature, htlc_signatures);
4074 #[cfg(any(test, feature = "fuzztarget"))]
4076 if !self.is_outbound() {
4077 let projected_commit_tx_info = self.next_remote_commitment_tx_fee_info_cached.lock().unwrap().take();
4078 *self.next_local_commitment_tx_fee_info_cached.lock().unwrap() = None;
4079 if let Some(info) = projected_commit_tx_info {
4080 let total_pending_htlcs = self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len();
4081 if info.total_pending_htlcs == total_pending_htlcs
4082 && info.next_holder_htlc_id == self.next_holder_htlc_id
4083 && info.next_counterparty_htlc_id == self.next_counterparty_htlc_id
4084 && info.feerate == self.feerate_per_kw {
4085 let actual_fee = self.commit_tx_fee_msat(counterparty_commitment_tx.1);
4086 assert_eq!(actual_fee, info.fee);
4093 let mut htlcs = Vec::with_capacity(counterparty_commitment_tx.2.len());
4094 for &(ref htlc, _) in counterparty_commitment_tx.2.iter() {
4098 let res = self.holder_signer.sign_counterparty_commitment(&counterparty_commitment_tx.0, &self.secp_ctx)
4099 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
4101 htlc_signatures = res.1;
4103 log_trace!(logger, "Signed remote commitment tx {} (txid {}) with redeemscript {} -> {}",
4104 encode::serialize_hex(&counterparty_commitment_tx.0.trust().built_transaction().transaction),
4105 &counterparty_commitment_txid,
4106 encode::serialize_hex(&self.get_funding_redeemscript()),
4107 log_bytes!(signature.serialize_compact()[..]));
4109 for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
4110 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
4111 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)),
4112 encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &counterparty_keys)),
4113 log_bytes!(counterparty_keys.broadcaster_htlc_key.serialize()),
4114 log_bytes!(htlc_sig.serialize_compact()[..]));
4118 Ok((msgs::CommitmentSigned {
4119 channel_id: self.channel_id,
4122 }, (counterparty_commitment_txid, counterparty_commitment_tx.2)))
4125 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
4126 /// to send to the remote peer in one go.
4127 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
4129 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 {
4130 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
4131 Some(update_add_htlc) => {
4132 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
4133 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
4139 /// Get forwarding information for the counterparty.
4140 pub fn counterparty_forwarding_info(&self) -> Option<CounterpartyForwardingInfo> {
4141 self.counterparty_forwarding_info.clone()
4144 pub fn channel_update(&mut self, msg: &msgs::ChannelUpdate) -> Result<(), ChannelError> {
4145 let usable_channel_value_msat = (self.channel_value_satoshis - self.counterparty_selected_channel_reserve_satoshis) * 1000;
4146 if msg.contents.htlc_minimum_msat >= usable_channel_value_msat {
4147 return Err(ChannelError::Close("Minimum htlc value is greater than channel value".to_string()));
4149 self.counterparty_forwarding_info = Some(CounterpartyForwardingInfo {
4150 fee_base_msat: msg.contents.fee_base_msat,
4151 fee_proportional_millionths: msg.contents.fee_proportional_millionths,
4152 cltv_expiry_delta: msg.contents.cltv_expiry_delta
4158 /// Begins the shutdown process, getting a message for the remote peer and returning all
4159 /// holding cell HTLCs for payment failure.
4160 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
4161 for htlc in self.pending_outbound_htlcs.iter() {
4162 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
4163 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
4166 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
4167 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
4168 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
4170 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
4171 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
4174 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
4175 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
4176 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()});
4179 let closing_script = self.get_closing_scriptpubkey();
4181 // From here on out, we may not fail!
4182 if self.channel_state < ChannelState::FundingSent as u32 {
4183 self.channel_state = ChannelState::ShutdownComplete as u32;
4185 self.channel_state |= ChannelState::LocalShutdownSent as u32;
4187 self.update_time_counter += 1;
4189 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
4190 // our shutdown until we've committed all of the pending changes.
4191 self.holding_cell_update_fee = None;
4192 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4193 self.holding_cell_htlc_updates.retain(|htlc_update| {
4195 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
4196 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
4203 Ok((msgs::Shutdown {
4204 channel_id: self.channel_id,
4205 scriptpubkey: closing_script,
4206 }, dropped_outbound_htlcs))
4209 /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
4210 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
4211 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
4212 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
4213 /// immediately (others we will have to allow to time out).
4214 pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>) {
4215 // Note that we MUST only generate a monitor update that indicates force-closure - we're
4216 // called during initialization prior to the chain_monitor in the encompassing ChannelManager
4217 // being fully configured in some cases. Thus, its likely any monitor events we generate will
4218 // be delayed in being processed! See the docs for `ChannelManagerReadArgs` for more.
4219 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
4221 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
4222 // return them to fail the payment.
4223 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
4224 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
4226 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
4227 dropped_outbound_htlcs.push((source, payment_hash));
4232 let monitor_update = if let Some(funding_txo) = self.get_funding_txo() {
4233 // If we haven't yet exchanged funding signatures (ie channel_state < FundingSent),
4234 // returning a channel monitor update here would imply a channel monitor update before
4235 // we even registered the channel monitor to begin with, which is invalid.
4236 // Thus, if we aren't actually at a point where we could conceivably broadcast the
4237 // funding transaction, don't return a funding txo (which prevents providing the
4238 // monitor update to the user, even if we return one).
4239 // See test_duplicate_chan_id and test_pre_lockin_no_chan_closed_update for more.
4240 if self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::ChannelFunded as u32 | ChannelState::ShutdownComplete as u32) != 0 {
4241 self.latest_monitor_update_id += 1;
4242 Some((funding_txo, ChannelMonitorUpdate {
4243 update_id: self.latest_monitor_update_id,
4244 updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
4249 self.channel_state = ChannelState::ShutdownComplete as u32;
4250 self.update_time_counter += 1;
4251 (monitor_update, dropped_outbound_htlcs)
4255 fn is_unsupported_shutdown_script(their_features: &InitFeatures, script: &Script) -> bool {
4256 // We restrain shutdown scripts to standards forms to avoid transactions not propagating on the p2p tx-relay network
4258 // BOLT 2 says we must only send a scriptpubkey of certain standard forms,
4259 // which for a a BIP-141-compliant witness program is at max 42 bytes in length.
4260 // So don't let the remote peer feed us some super fee-heavy script.
4261 let is_script_too_long = script.len() > 42;
4262 if is_script_too_long {
4266 if their_features.supports_shutdown_anysegwit() && script.is_witness_program() && script.as_bytes()[0] != OP_PUSHBYTES_0.into_u8() {
4270 return !script.is_p2pkh() && !script.is_p2sh() && !script.is_v0_p2wpkh() && !script.is_v0_p2wsh()
4273 const SERIALIZATION_VERSION: u8 = 1;
4274 const MIN_SERIALIZATION_VERSION: u8 = 1;
4276 impl Writeable for InboundHTLCRemovalReason {
4277 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4279 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
4281 error_packet.write(writer)?;
4283 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
4285 onion_hash.write(writer)?;
4286 err_code.write(writer)?;
4288 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
4290 payment_preimage.write(writer)?;
4297 impl Readable for InboundHTLCRemovalReason {
4298 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4299 Ok(match <u8 as Readable>::read(reader)? {
4300 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
4301 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
4302 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
4303 _ => return Err(DecodeError::InvalidValue),
4308 impl<Signer: Sign> Writeable for Channel<Signer> {
4309 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4310 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4311 // called but include holding cell updates (and obviously we don't modify self).
4313 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4314 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4316 self.user_id.write(writer)?;
4317 self.config.write(writer)?;
4319 self.channel_id.write(writer)?;
4320 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4321 self.channel_value_satoshis.write(writer)?;
4323 self.latest_monitor_update_id.write(writer)?;
4325 let mut key_data = VecWriter(Vec::new());
4326 self.holder_signer.write(&mut key_data)?;
4327 assert!(key_data.0.len() < std::usize::MAX);
4328 assert!(key_data.0.len() < std::u32::MAX as usize);
4329 (key_data.0.len() as u32).write(writer)?;
4330 writer.write_all(&key_data.0[..])?;
4332 self.shutdown_pubkey.write(writer)?;
4333 self.destination_script.write(writer)?;
4335 self.cur_holder_commitment_transaction_number.write(writer)?;
4336 self.cur_counterparty_commitment_transaction_number.write(writer)?;
4337 self.value_to_self_msat.write(writer)?;
4339 let mut dropped_inbound_htlcs = 0;
4340 for htlc in self.pending_inbound_htlcs.iter() {
4341 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4342 dropped_inbound_htlcs += 1;
4345 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4346 for htlc in self.pending_inbound_htlcs.iter() {
4347 if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4350 htlc.htlc_id.write(writer)?;
4351 htlc.amount_msat.write(writer)?;
4352 htlc.cltv_expiry.write(writer)?;
4353 htlc.payment_hash.write(writer)?;
4355 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4356 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4358 htlc_state.write(writer)?;
4360 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4362 htlc_state.write(writer)?;
4364 &InboundHTLCState::Committed => {
4367 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4369 removal_reason.write(writer)?;
4374 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4375 for htlc in self.pending_outbound_htlcs.iter() {
4376 htlc.htlc_id.write(writer)?;
4377 htlc.amount_msat.write(writer)?;
4378 htlc.cltv_expiry.write(writer)?;
4379 htlc.payment_hash.write(writer)?;
4380 htlc.source.write(writer)?;
4382 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4384 onion_packet.write(writer)?;
4386 &OutboundHTLCState::Committed => {
4389 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
4391 fail_reason.write(writer)?;
4393 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4395 fail_reason.write(writer)?;
4397 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4399 fail_reason.write(writer)?;
4404 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4405 for update in self.holding_cell_htlc_updates.iter() {
4407 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4409 amount_msat.write(writer)?;
4410 cltv_expiry.write(writer)?;
4411 payment_hash.write(writer)?;
4412 source.write(writer)?;
4413 onion_routing_packet.write(writer)?;
4415 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4417 payment_preimage.write(writer)?;
4418 htlc_id.write(writer)?;
4420 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4422 htlc_id.write(writer)?;
4423 err_packet.write(writer)?;
4428 match self.resend_order {
4429 RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4430 RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4433 self.monitor_pending_funding_locked.write(writer)?;
4434 self.monitor_pending_revoke_and_ack.write(writer)?;
4435 self.monitor_pending_commitment_signed.write(writer)?;
4437 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4438 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4439 pending_forward.write(writer)?;
4440 htlc_id.write(writer)?;
4443 (self.monitor_pending_failures.len() as u64).write(writer)?;
4444 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4445 htlc_source.write(writer)?;
4446 payment_hash.write(writer)?;
4447 fail_reason.write(writer)?;
4450 self.pending_update_fee.write(writer)?;
4451 self.holding_cell_update_fee.write(writer)?;
4453 self.next_holder_htlc_id.write(writer)?;
4454 (self.next_counterparty_htlc_id - dropped_inbound_htlcs).write(writer)?;
4455 self.update_time_counter.write(writer)?;
4456 self.feerate_per_kw.write(writer)?;
4458 match self.last_sent_closing_fee {
4459 Some((feerate, fee, sig)) => {
4461 feerate.write(writer)?;
4465 None => 0u8.write(writer)?,
4468 self.funding_tx_confirmed_in.write(writer)?;
4469 self.short_channel_id.write(writer)?;
4470 self.funding_tx_confirmations.write(writer)?;
4472 self.counterparty_dust_limit_satoshis.write(writer)?;
4473 self.holder_dust_limit_satoshis.write(writer)?;
4474 self.counterparty_max_htlc_value_in_flight_msat.write(writer)?;
4475 self.counterparty_selected_channel_reserve_satoshis.write(writer)?;
4476 self.counterparty_htlc_minimum_msat.write(writer)?;
4477 self.holder_htlc_minimum_msat.write(writer)?;
4478 self.counterparty_max_accepted_htlcs.write(writer)?;
4479 self.minimum_depth.write(writer)?;
4481 match &self.counterparty_forwarding_info {
4484 info.fee_base_msat.write(writer)?;
4485 info.fee_proportional_millionths.write(writer)?;
4486 info.cltv_expiry_delta.write(writer)?;
4488 None => 0u8.write(writer)?
4491 self.channel_transaction_parameters.write(writer)?;
4492 self.counterparty_cur_commitment_point.write(writer)?;
4494 self.counterparty_prev_commitment_point.write(writer)?;
4495 self.counterparty_node_id.write(writer)?;
4497 self.counterparty_shutdown_scriptpubkey.write(writer)?;
4499 self.commitment_secrets.write(writer)?;
4504 const MAX_ALLOC_SIZE: usize = 64*1024;
4505 impl<'a, Signer: Sign, K: Deref> ReadableArgs<&'a K> for Channel<Signer>
4506 where K::Target: KeysInterface<Signer = Signer> {
4507 fn read<R : ::std::io::Read>(reader: &mut R, keys_source: &'a K) -> Result<Self, DecodeError> {
4508 let _ver: u8 = Readable::read(reader)?;
4509 let min_ver: u8 = Readable::read(reader)?;
4510 if min_ver > SERIALIZATION_VERSION {
4511 return Err(DecodeError::UnknownVersion);
4514 let user_id = Readable::read(reader)?;
4515 let config: ChannelConfig = Readable::read(reader)?;
4517 let channel_id = Readable::read(reader)?;
4518 let channel_state = Readable::read(reader)?;
4519 let channel_value_satoshis = Readable::read(reader)?;
4521 let latest_monitor_update_id = Readable::read(reader)?;
4523 let keys_len: u32 = Readable::read(reader)?;
4524 let mut keys_data = Vec::with_capacity(cmp::min(keys_len as usize, MAX_ALLOC_SIZE));
4525 while keys_data.len() != keys_len as usize {
4526 // Read 1KB at a time to avoid accidentally allocating 4GB on corrupted channel keys
4527 let mut data = [0; 1024];
4528 let read_slice = &mut data[0..cmp::min(1024, keys_len as usize - keys_data.len())];
4529 reader.read_exact(read_slice)?;
4530 keys_data.extend_from_slice(read_slice);
4532 let holder_signer = keys_source.read_chan_signer(&keys_data)?;
4534 let shutdown_pubkey = Readable::read(reader)?;
4535 let destination_script = Readable::read(reader)?;
4537 let cur_holder_commitment_transaction_number = Readable::read(reader)?;
4538 let cur_counterparty_commitment_transaction_number = Readable::read(reader)?;
4539 let value_to_self_msat = Readable::read(reader)?;
4541 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4542 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4543 for _ in 0..pending_inbound_htlc_count {
4544 pending_inbound_htlcs.push(InboundHTLCOutput {
4545 htlc_id: Readable::read(reader)?,
4546 amount_msat: Readable::read(reader)?,
4547 cltv_expiry: Readable::read(reader)?,
4548 payment_hash: Readable::read(reader)?,
4549 state: match <u8 as Readable>::read(reader)? {
4550 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4551 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4552 3 => InboundHTLCState::Committed,
4553 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4554 _ => return Err(DecodeError::InvalidValue),
4559 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4560 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4561 for _ in 0..pending_outbound_htlc_count {
4562 pending_outbound_htlcs.push(OutboundHTLCOutput {
4563 htlc_id: Readable::read(reader)?,
4564 amount_msat: Readable::read(reader)?,
4565 cltv_expiry: Readable::read(reader)?,
4566 payment_hash: Readable::read(reader)?,
4567 source: Readable::read(reader)?,
4568 state: match <u8 as Readable>::read(reader)? {
4569 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4570 1 => OutboundHTLCState::Committed,
4571 2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4572 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4573 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4574 _ => return Err(DecodeError::InvalidValue),
4579 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4580 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4581 for _ in 0..holding_cell_htlc_update_count {
4582 holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4583 0 => HTLCUpdateAwaitingACK::AddHTLC {
4584 amount_msat: Readable::read(reader)?,
4585 cltv_expiry: Readable::read(reader)?,
4586 payment_hash: Readable::read(reader)?,
4587 source: Readable::read(reader)?,
4588 onion_routing_packet: Readable::read(reader)?,
4590 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4591 payment_preimage: Readable::read(reader)?,
4592 htlc_id: Readable::read(reader)?,
4594 2 => HTLCUpdateAwaitingACK::FailHTLC {
4595 htlc_id: Readable::read(reader)?,
4596 err_packet: Readable::read(reader)?,
4598 _ => return Err(DecodeError::InvalidValue),
4602 let resend_order = match <u8 as Readable>::read(reader)? {
4603 0 => RAACommitmentOrder::CommitmentFirst,
4604 1 => RAACommitmentOrder::RevokeAndACKFirst,
4605 _ => return Err(DecodeError::InvalidValue),
4608 let monitor_pending_funding_locked = Readable::read(reader)?;
4609 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4610 let monitor_pending_commitment_signed = Readable::read(reader)?;
4612 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4613 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4614 for _ in 0..monitor_pending_forwards_count {
4615 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4618 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4619 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4620 for _ in 0..monitor_pending_failures_count {
4621 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4624 let pending_update_fee = Readable::read(reader)?;
4625 let holding_cell_update_fee = Readable::read(reader)?;
4627 let next_holder_htlc_id = Readable::read(reader)?;
4628 let next_counterparty_htlc_id = Readable::read(reader)?;
4629 let update_time_counter = Readable::read(reader)?;
4630 let feerate_per_kw = Readable::read(reader)?;
4632 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4634 1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4635 _ => return Err(DecodeError::InvalidValue),
4638 let funding_tx_confirmed_in = Readable::read(reader)?;
4639 let short_channel_id = Readable::read(reader)?;
4640 let funding_tx_confirmations = Readable::read(reader)?;
4642 let counterparty_dust_limit_satoshis = Readable::read(reader)?;
4643 let holder_dust_limit_satoshis = Readable::read(reader)?;
4644 let counterparty_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4645 let counterparty_selected_channel_reserve_satoshis = Readable::read(reader)?;
4646 let counterparty_htlc_minimum_msat = Readable::read(reader)?;
4647 let holder_htlc_minimum_msat = Readable::read(reader)?;
4648 let counterparty_max_accepted_htlcs = Readable::read(reader)?;
4649 let minimum_depth = Readable::read(reader)?;
4651 let counterparty_forwarding_info = match <u8 as Readable>::read(reader)? {
4653 1 => Some(CounterpartyForwardingInfo {
4654 fee_base_msat: Readable::read(reader)?,
4655 fee_proportional_millionths: Readable::read(reader)?,
4656 cltv_expiry_delta: Readable::read(reader)?,
4658 _ => return Err(DecodeError::InvalidValue),
4661 let channel_parameters = Readable::read(reader)?;
4662 let counterparty_cur_commitment_point = Readable::read(reader)?;
4664 let counterparty_prev_commitment_point = Readable::read(reader)?;
4665 let counterparty_node_id = Readable::read(reader)?;
4667 let counterparty_shutdown_scriptpubkey = Readable::read(reader)?;
4668 let commitment_secrets = Readable::read(reader)?;
4670 let mut secp_ctx = Secp256k1::new();
4671 secp_ctx.seeded_randomize(&keys_source.get_secure_random_bytes());
4680 channel_value_satoshis,
4682 latest_monitor_update_id,
4688 cur_holder_commitment_transaction_number,
4689 cur_counterparty_commitment_transaction_number,
4692 pending_inbound_htlcs,
4693 pending_outbound_htlcs,
4694 holding_cell_htlc_updates,
4698 monitor_pending_funding_locked,
4699 monitor_pending_revoke_and_ack,
4700 monitor_pending_commitment_signed,
4701 monitor_pending_forwards,
4702 monitor_pending_failures,
4705 holding_cell_update_fee,
4706 next_holder_htlc_id,
4707 next_counterparty_htlc_id,
4708 update_time_counter,
4711 #[cfg(debug_assertions)]
4712 holder_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4713 #[cfg(debug_assertions)]
4714 counterparty_max_commitment_tx_output: ::std::sync::Mutex::new((0, 0)),
4716 last_sent_closing_fee,
4718 funding_tx_confirmed_in,
4720 funding_tx_confirmations,
4722 counterparty_dust_limit_satoshis,
4723 holder_dust_limit_satoshis,
4724 counterparty_max_htlc_value_in_flight_msat,
4725 counterparty_selected_channel_reserve_satoshis,
4726 counterparty_htlc_minimum_msat,
4727 holder_htlc_minimum_msat,
4728 counterparty_max_accepted_htlcs,
4731 counterparty_forwarding_info,
4733 channel_transaction_parameters: channel_parameters,
4734 counterparty_cur_commitment_point,
4736 counterparty_prev_commitment_point,
4737 counterparty_node_id,
4739 counterparty_shutdown_scriptpubkey,
4743 network_sync: UpdateStatus::Fresh,
4745 #[cfg(any(test, feature = "fuzztarget"))]
4746 next_local_commitment_tx_fee_info_cached: Mutex::new(None),
4747 #[cfg(any(test, feature = "fuzztarget"))]
4748 next_remote_commitment_tx_fee_info_cached: Mutex::new(None),
4755 use bitcoin::util::bip143;
4756 use bitcoin::consensus::encode::serialize;
4757 use bitcoin::blockdata::script::{Script, Builder};
4758 use bitcoin::blockdata::transaction::{Transaction, TxOut, SigHashType};
4759 use bitcoin::blockdata::constants::genesis_block;
4760 use bitcoin::blockdata::opcodes;
4761 use bitcoin::network::constants::Network;
4762 use bitcoin::hashes::hex::FromHex;
4764 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4765 use ln::channel::{Channel,Sign,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,HTLCCandidate,HTLCInitiator,TxCreationKeys};
4766 use ln::channel::MAX_FUNDING_SATOSHIS;
4767 use ln::features::InitFeatures;
4768 use ln::msgs::{ChannelUpdate, DataLossProtect, DecodeError, OptionalField, UnsignedChannelUpdate};
4770 use ln::chan_utils::{ChannelPublicKeys, HolderCommitmentTransaction, CounterpartyChannelTransactionParameters, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT};
4771 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4772 use chain::keysinterface::{InMemorySigner, KeysInterface};
4773 use chain::transaction::OutPoint;
4774 use util::config::UserConfig;
4775 use util::enforcing_trait_impls::EnforcingSigner;
4776 use util::test_utils;
4777 use util::logger::Logger;
4778 use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4779 use bitcoin::secp256k1::ffi::Signature as FFISignature;
4780 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4781 use bitcoin::hashes::sha256::Hash as Sha256;
4782 use bitcoin::hashes::Hash;
4783 use bitcoin::hash_types::{Txid, WPubkeyHash};
4786 struct TestFeeEstimator {
4789 impl FeeEstimator for TestFeeEstimator {
4790 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
4796 fn test_max_funding_satoshis() {
4797 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4798 "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4802 signer: InMemorySigner,
4804 impl KeysInterface for Keys {
4805 type Signer = InMemorySigner;
4807 fn get_node_secret(&self) -> SecretKey { panic!(); }
4808 fn get_destination_script(&self) -> Script {
4809 let secp_ctx = Secp256k1::signing_only();
4810 let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4811 let channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4812 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&channel_monitor_claim_key_hash[..]).into_script()
4815 fn get_shutdown_pubkey(&self) -> PublicKey {
4816 let secp_ctx = Secp256k1::signing_only();
4817 let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4818 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4821 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemorySigner {
4824 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
4825 fn read_chan_signer(&self, _data: &[u8]) -> Result<Self::Signer, DecodeError> { panic!(); }
4828 fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4829 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4832 // Check that, during channel creation, we use the same feerate in the open channel message
4833 // as we do in the Channel object creation itself.
4835 fn test_open_channel_msg_fee() {
4836 let original_fee = 253;
4837 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
4838 let secp_ctx = Secp256k1::new();
4839 let seed = [42; 32];
4840 let network = Network::Testnet;
4841 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4843 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4844 let config = UserConfig::default();
4845 let node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4847 // Now change the fee so we can check that the fee in the open_channel message is the
4848 // same as the old fee.
4849 fee_est.fee_est = 500;
4850 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
4851 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
4855 fn test_holder_vs_counterparty_dust_limit() {
4856 // Test that when calculating the local and remote commitment transaction fees, the correct
4857 // dust limits are used.
4858 let feeest = TestFeeEstimator{fee_est: 15000};
4859 let secp_ctx = Secp256k1::new();
4860 let seed = [42; 32];
4861 let network = Network::Testnet;
4862 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4864 // Go through the flow of opening a channel between two nodes, making sure
4865 // they have different dust limits.
4867 // Create Node A's channel pointing to Node B's pubkey
4868 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4869 let config = UserConfig::default();
4870 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
4872 // Create Node B's channel by receiving Node A's open_channel message
4873 // Make sure A's dust limit is as we expect.
4874 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.block_hash());
4875 assert_eq!(open_channel_msg.dust_limit_satoshis, 1560);
4876 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4877 let node_b_chan = Channel::<EnforcingSigner>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
4879 // Node B --> Node A: accept channel, explicitly setting B's dust limit.
4880 let mut accept_channel_msg = node_b_chan.get_accept_channel();
4881 accept_channel_msg.dust_limit_satoshis = 546;
4882 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4884 // Put some inbound and outbound HTLCs in A's channel.
4885 let htlc_amount_msat = 11_092_000; // put an amount below A's effective dust limit but above B's.
4886 node_a_chan.pending_inbound_htlcs.push(InboundHTLCOutput {
4888 amount_msat: htlc_amount_msat,
4889 payment_hash: PaymentHash(Sha256::hash(&[42; 32]).into_inner()),
4890 cltv_expiry: 300000000,
4891 state: InboundHTLCState::Committed,
4894 node_a_chan.pending_outbound_htlcs.push(OutboundHTLCOutput {
4896 amount_msat: htlc_amount_msat, // put an amount below A's dust amount but above B's.
4897 payment_hash: PaymentHash(Sha256::hash(&[43; 32]).into_inner()),
4898 cltv_expiry: 200000000,
4899 state: OutboundHTLCState::Committed,
4900 source: HTLCSource::OutboundRoute {
4902 session_priv: SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4903 first_hop_htlc_msat: 548,
4907 // Make sure when Node A calculates their local commitment transaction, none of the HTLCs pass
4908 // the dust limit check.
4909 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
4910 let local_commit_tx_fee = node_a_chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
4911 let local_commit_fee_0_htlcs = node_a_chan.commit_tx_fee_msat(0);
4912 assert_eq!(local_commit_tx_fee, local_commit_fee_0_htlcs);
4914 // Finally, make sure that when Node A calculates the remote's commitment transaction fees, all
4915 // of the HTLCs are seen to be above the dust limit.
4916 node_a_chan.channel_transaction_parameters.is_outbound_from_holder = false;
4917 let remote_commit_fee_3_htlcs = node_a_chan.commit_tx_fee_msat(3);
4918 let htlc_candidate = HTLCCandidate::new(htlc_amount_msat, HTLCInitiator::LocalOffered);
4919 let remote_commit_tx_fee = node_a_chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4920 assert_eq!(remote_commit_tx_fee, remote_commit_fee_3_htlcs);
4924 fn test_timeout_vs_success_htlc_dust_limit() {
4925 // Make sure that when `next_remote_commit_tx_fee_msat` and `next_local_commit_tx_fee_msat`
4926 // calculate the real dust limits for HTLCs (i.e. the dust limit given by the counterparty
4927 // *plus* the fees paid for the HTLC) they don't swap `HTLC_SUCCESS_TX_WEIGHT` for
4928 // `HTLC_TIMEOUT_TX_WEIGHT`, and vice versa.
4929 let fee_est = TestFeeEstimator{fee_est: 253 };
4930 let secp_ctx = Secp256k1::new();
4931 let seed = [42; 32];
4932 let network = Network::Testnet;
4933 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4935 let node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4936 let config = UserConfig::default();
4937 let mut chan = Channel::<EnforcingSigner>::new_outbound(&&fee_est, &&keys_provider, node_id, 10000000, 100000, 42, &config).unwrap();
4939 let commitment_tx_fee_0_htlcs = chan.commit_tx_fee_msat(0);
4940 let commitment_tx_fee_1_htlc = chan.commit_tx_fee_msat(1);
4942 // If HTLC_SUCCESS_TX_WEIGHT and HTLC_TIMEOUT_TX_WEIGHT were swapped: then this HTLC would be
4943 // counted as dust when it shouldn't be.
4944 let htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis + 1) * 1000;
4945 let htlc_candidate = HTLCCandidate::new(htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
4946 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
4947 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
4949 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
4950 let dust_htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.holder_dust_limit_satoshis - 1) * 1000;
4951 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_below_success, HTLCInitiator::RemoteOffered);
4952 let commitment_tx_fee = chan.next_local_commit_tx_fee_msat(htlc_candidate, None);
4953 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
4955 chan.channel_transaction_parameters.is_outbound_from_holder = false;
4957 // If swapped: this HTLC would be counted as non-dust when it shouldn't be.
4958 let dust_htlc_amt_above_timeout = ((253 * HTLC_TIMEOUT_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis + 1) * 1000;
4959 let htlc_candidate = HTLCCandidate::new(dust_htlc_amt_above_timeout, HTLCInitiator::LocalOffered);
4960 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4961 assert_eq!(commitment_tx_fee, commitment_tx_fee_0_htlcs);
4963 // If swapped: this HTLC would be counted as dust when it shouldn't be.
4964 let htlc_amt_below_success = ((253 * HTLC_SUCCESS_TX_WEIGHT / 1000) + chan.counterparty_dust_limit_satoshis - 1) * 1000;
4965 let htlc_candidate = HTLCCandidate::new(htlc_amt_below_success, HTLCInitiator::RemoteOffered);
4966 let commitment_tx_fee = chan.next_remote_commit_tx_fee_msat(htlc_candidate, None);
4967 assert_eq!(commitment_tx_fee, commitment_tx_fee_1_htlc);
4971 fn channel_reestablish_no_updates() {
4972 let feeest = TestFeeEstimator{fee_est: 15000};
4973 let logger = test_utils::TestLogger::new();
4974 let secp_ctx = Secp256k1::new();
4975 let seed = [42; 32];
4976 let network = Network::Testnet;
4977 let chain_hash = genesis_block(network).header.block_hash();
4978 let last_block_hash = chain_hash;
4979 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4981 // Go through the flow of opening a channel between two nodes.
4983 // Create Node A's channel pointing to Node B's pubkey
4984 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4985 let config = UserConfig::default();
4986 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
4988 // Create Node B's channel by receiving Node A's open_channel message
4989 let open_channel_msg = node_a_chan.get_open_channel(chain_hash);
4990 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4991 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();
4993 // Node B --> Node A: accept channel
4994 let accept_channel_msg = node_b_chan.get_accept_channel();
4995 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4997 // Node A --> Node B: funding created
4998 let output_script = node_a_chan.get_funding_redeemscript();
4999 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5000 value: 10000000, script_pubkey: output_script.clone(),
5002 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
5003 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap();
5004 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, last_block_hash, &&logger).unwrap();
5006 // Node B --> Node A: funding signed
5007 let _ = node_a_chan.funding_signed(&funding_signed_msg, last_block_hash, &&logger);
5009 // Now disconnect the two nodes and check that the commitment point in
5010 // Node B's channel_reestablish message is sane.
5011 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5012 let msg = node_b_chan.get_channel_reestablish(&&logger);
5013 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5014 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5015 match msg.data_loss_protect {
5016 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5017 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5022 // Check that the commitment point in Node A's channel_reestablish message
5024 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
5025 let msg = node_a_chan.get_channel_reestablish(&&logger);
5026 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
5027 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
5028 match msg.data_loss_protect {
5029 OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
5030 assert_eq!(your_last_per_commitment_secret, [0; 32]);
5037 fn channel_update() {
5038 let feeest = TestFeeEstimator{fee_est: 15000};
5039 let secp_ctx = Secp256k1::new();
5040 let seed = [42; 32];
5041 let network = Network::Testnet;
5042 let chain_hash = genesis_block(network).header.block_hash();
5043 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
5045 // Create a channel.
5046 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5047 let config = UserConfig::default();
5048 let mut node_a_chan = Channel::<EnforcingSigner>::new_outbound(&&feeest, &&keys_provider, node_b_node_id, 10000000, 100000, 42, &config).unwrap();
5049 assert!(node_a_chan.counterparty_forwarding_info.is_none());
5050 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1); // the default
5051 assert!(node_a_chan.counterparty_forwarding_info().is_none());
5053 // Make sure that receiving a channel update will update the Channel as expected.
5054 let update = ChannelUpdate {
5055 contents: UnsignedChannelUpdate {
5057 short_channel_id: 0,
5060 cltv_expiry_delta: 100,
5061 htlc_minimum_msat: 5,
5062 htlc_maximum_msat: OptionalField::Absent,
5064 fee_proportional_millionths: 11,
5065 excess_data: Vec::new(),
5067 signature: Signature::from(unsafe { FFISignature::new() })
5069 node_a_chan.channel_update(&update).unwrap();
5071 // The counterparty can send an update with a higher minimum HTLC, but that shouldn't
5072 // change our official htlc_minimum_msat.
5073 assert_eq!(node_a_chan.holder_htlc_minimum_msat, 1);
5074 match node_a_chan.counterparty_forwarding_info() {
5076 assert_eq!(info.cltv_expiry_delta, 100);
5077 assert_eq!(info.fee_base_msat, 110);
5078 assert_eq!(info.fee_proportional_millionths, 11);
5080 None => panic!("expected counterparty forwarding info to be Some")
5085 fn outbound_commitment_test() {
5086 // Test vectors from BOLT 3 Appendix C:
5087 let feeest = TestFeeEstimator{fee_est: 15000};
5088 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
5089 let secp_ctx = Secp256k1::new();
5091 let mut signer = InMemorySigner::new(
5093 SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
5094 SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
5095 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5096 SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
5097 SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
5099 // These aren't set in the test vectors:
5100 [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],
5105 assert_eq!(signer.pubkeys().funding_pubkey.serialize()[..],
5106 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
5107 let keys_provider = Keys { signer: signer.clone() };
5109 let counterparty_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
5110 let mut config = UserConfig::default();
5111 config.channel_options.announced_channel = false;
5112 let mut chan = Channel::<InMemorySigner>::new_outbound(&&feeest, &&keys_provider, counterparty_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
5113 chan.holder_dust_limit_satoshis = 546;
5115 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
5117 let counterparty_pubkeys = ChannelPublicKeys {
5118 funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5119 revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
5120 payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
5121 delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
5122 htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
5124 chan.channel_transaction_parameters.counterparty_parameters = Some(
5125 CounterpartyChannelTransactionParameters {
5126 pubkeys: counterparty_pubkeys.clone(),
5127 selected_contest_delay: 144
5129 chan.channel_transaction_parameters.funding_outpoint = Some(funding_info);
5130 signer.ready_channel(&chan.channel_transaction_parameters);
5132 assert_eq!(counterparty_pubkeys.payment_point.serialize()[..],
5133 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5135 assert_eq!(counterparty_pubkeys.funding_pubkey.serialize()[..],
5136 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
5138 assert_eq!(counterparty_pubkeys.htlc_basepoint.serialize()[..],
5139 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
5141 // We can't just use build_holder_transaction_keys here as the per_commitment_secret is not
5142 // derived from a commitment_seed, so instead we copy it here and call
5143 // build_commitment_transaction.
5144 let delayed_payment_base = &chan.holder_signer.pubkeys().delayed_payment_basepoint;
5145 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5146 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5147 let htlc_basepoint = &chan.holder_signer.pubkeys().htlc_basepoint;
5148 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
5150 macro_rules! test_commitment {
5151 ( $counterparty_sig_hex: expr, $sig_hex: expr, $tx_hex: expr, {
5152 $( { $htlc_idx: expr, $counterparty_htlc_sig_hex: expr, $htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
5154 let (commitment_tx, htlcs): (_, Vec<HTLCOutputInCommitment>) = {
5155 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
5157 let htlcs = res.2.drain(..)
5158 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
5162 let trusted_tx = commitment_tx.trust();
5163 let unsigned_tx = trusted_tx.built_transaction();
5164 let redeemscript = chan.get_funding_redeemscript();
5165 let counterparty_signature = Signature::from_der(&hex::decode($counterparty_sig_hex).unwrap()[..]).unwrap();
5166 let sighash = unsigned_tx.get_sighash_all(&redeemscript, chan.channel_value_satoshis);
5167 secp_ctx.verify(&sighash, &counterparty_signature, chan.counterparty_funding_pubkey()).unwrap();
5169 let mut per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)> = Vec::new();
5170 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
5171 let mut counterparty_htlc_sigs = Vec::new();
5172 counterparty_htlc_sigs.clear(); // Don't warn about excess mut for no-HTLC calls
5174 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5175 per_htlc.push((htlcs[$htlc_idx].clone(), Some(remote_signature)));
5176 counterparty_htlc_sigs.push(remote_signature);
5178 assert_eq!(htlcs.len(), per_htlc.len());
5180 let holder_commitment_tx = HolderCommitmentTransaction::new(
5181 commitment_tx.clone(),
5182 counterparty_signature,
5183 counterparty_htlc_sigs,
5184 &chan.holder_signer.pubkeys().funding_pubkey,
5185 chan.counterparty_funding_pubkey()
5187 let (holder_sig, htlc_sigs) = signer.sign_holder_commitment_and_htlcs(&holder_commitment_tx, &secp_ctx).unwrap();
5188 assert_eq!(Signature::from_der(&hex::decode($sig_hex).unwrap()[..]).unwrap(), holder_sig, "holder_sig");
5190 let funding_redeemscript = chan.get_funding_redeemscript();
5191 let tx = holder_commitment_tx.add_holder_sig(&funding_redeemscript, holder_sig);
5192 assert_eq!(serialize(&tx)[..], hex::decode($tx_hex).unwrap()[..], "tx");
5194 // ((htlc, counterparty_sig), (index, holder_sig))
5195 let mut htlc_sig_iter = holder_commitment_tx.htlcs().iter().zip(&holder_commitment_tx.counterparty_htlc_sigs).zip(htlc_sigs.iter().enumerate());
5198 let remote_signature = Signature::from_der(&hex::decode($counterparty_htlc_sig_hex).unwrap()[..]).unwrap();
5200 let ref htlc = htlcs[$htlc_idx];
5201 let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.txid, &htlc, true, &keys, chan.feerate_per_kw);
5202 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
5203 let htlc_sighash = Message::from_slice(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, SigHashType::All)[..]).unwrap();
5204 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.countersignatory_htlc_key).unwrap();
5206 let mut preimage: Option<PaymentPreimage> = None;
5209 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
5210 if out == htlc.payment_hash {
5211 preimage = Some(PaymentPreimage([i; 32]));
5215 assert!(preimage.is_some());
5218 let htlc_sig = htlc_sig_iter.next().unwrap();
5219 assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx), "output index");
5221 let signature = Signature::from_der(&hex::decode($htlc_sig_hex).unwrap()[..]).unwrap();
5222 assert_eq!(signature, *(htlc_sig.1).1, "htlc sig");
5223 let index = (htlc_sig.1).0;
5224 let channel_parameters = chan.channel_transaction_parameters.as_holder_broadcastable();
5225 let trusted_tx = holder_commitment_tx.trust();
5226 assert_eq!(serialize(&trusted_tx.get_signed_htlc_tx(&channel_parameters, index, &(htlc_sig.0).1, (htlc_sig.1).1, &preimage))[..],
5227 hex::decode($htlc_tx_hex).unwrap()[..], "htlc tx");
5229 assert!(htlc_sig_iter.next().is_none());
5233 // simple commitment tx with no HTLCs
5234 chan.value_to_self_msat = 7000000000;
5236 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
5237 "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
5238 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5240 chan.pending_inbound_htlcs.push({
5241 let mut out = InboundHTLCOutput{
5243 amount_msat: 1000000,
5245 payment_hash: PaymentHash([0; 32]),
5246 state: InboundHTLCState::Committed,
5248 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
5251 chan.pending_inbound_htlcs.push({
5252 let mut out = InboundHTLCOutput{
5254 amount_msat: 2000000,
5256 payment_hash: PaymentHash([0; 32]),
5257 state: InboundHTLCState::Committed,
5259 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5262 chan.pending_outbound_htlcs.push({
5263 let mut out = OutboundHTLCOutput{
5265 amount_msat: 2000000,
5267 payment_hash: PaymentHash([0; 32]),
5268 state: OutboundHTLCState::Committed,
5269 source: HTLCSource::dummy(),
5271 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
5274 chan.pending_outbound_htlcs.push({
5275 let mut out = OutboundHTLCOutput{
5277 amount_msat: 3000000,
5279 payment_hash: PaymentHash([0; 32]),
5280 state: OutboundHTLCState::Committed,
5281 source: HTLCSource::dummy(),
5283 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
5286 chan.pending_inbound_htlcs.push({
5287 let mut out = InboundHTLCOutput{
5289 amount_msat: 4000000,
5291 payment_hash: PaymentHash([0; 32]),
5292 state: InboundHTLCState::Committed,
5294 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
5298 // commitment tx with all five HTLCs untrimmed (minimum feerate)
5299 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5300 chan.feerate_per_kw = 0;
5302 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
5303 "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
5304 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5307 "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
5308 "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
5309 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5312 "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
5313 "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
5314 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5317 "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
5318 "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
5319 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5322 "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
5323 "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
5324 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5327 "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
5328 "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
5329 "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5332 // commitment tx with seven outputs untrimmed (maximum feerate)
5333 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5334 chan.feerate_per_kw = 647;
5336 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
5337 "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
5338 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5341 "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
5342 "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
5343 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
5346 "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
5347 "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
5348 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5351 "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
5352 "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
5353 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5356 "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
5357 "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
5358 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5361 "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
5362 "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
5363 "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5366 // commitment tx with six outputs untrimmed (minimum feerate)
5367 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5368 chan.feerate_per_kw = 648;
5370 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
5371 "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
5372 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5375 "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
5376 "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
5377 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5380 "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
5381 "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
5382 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5385 "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
5386 "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
5387 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5390 "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
5391 "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
5392 "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5395 // commitment tx with six outputs untrimmed (maximum feerate)
5396 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5397 chan.feerate_per_kw = 2069;
5399 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
5400 "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
5401 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5404 "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
5405 "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
5406 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5409 "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
5410 "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
5411 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5414 "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
5415 "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
5416 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5419 "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
5420 "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
5421 "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5424 // commitment tx with five outputs untrimmed (minimum feerate)
5425 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5426 chan.feerate_per_kw = 2070;
5428 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
5429 "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
5430 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5433 "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
5434 "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
5435 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5438 "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
5439 "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
5440 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5443 "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
5444 "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
5445 "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5448 // commitment tx with five outputs untrimmed (maximum feerate)
5449 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5450 chan.feerate_per_kw = 2194;
5452 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
5453 "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
5454 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5457 "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
5458 "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
5459 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
5462 "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
5463 "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
5464 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5467 "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
5468 "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
5469 "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5472 // commitment tx with four outputs untrimmed (minimum feerate)
5473 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5474 chan.feerate_per_kw = 2195;
5476 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
5477 "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5478 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5481 "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5482 "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5483 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5486 "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5487 "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5488 "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5491 // commitment tx with four outputs untrimmed (maximum feerate)
5492 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5493 chan.feerate_per_kw = 3702;
5495 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5496 "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5497 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5500 "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5501 "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5502 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5505 "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5506 "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5507 "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5510 // commitment tx with three outputs untrimmed (minimum feerate)
5511 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5512 chan.feerate_per_kw = 3703;
5514 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5515 "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5516 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5519 "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5520 "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5521 "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5524 // commitment tx with three outputs untrimmed (maximum feerate)
5525 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5526 chan.feerate_per_kw = 4914;
5528 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5529 "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5530 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5533 "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5534 "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5535 "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5538 // commitment tx with two outputs untrimmed (minimum feerate)
5539 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5540 chan.feerate_per_kw = 4915;
5542 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5543 "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5544 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5546 // commitment tx with two outputs untrimmed (maximum feerate)
5547 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5548 chan.feerate_per_kw = 9651180;
5550 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5551 "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5552 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5554 // commitment tx with one output untrimmed (minimum feerate)
5555 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5556 chan.feerate_per_kw = 9651181;
5558 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5559 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5560 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5562 // commitment tx with fee greater than funder amount
5563 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5564 chan.feerate_per_kw = 9651936;
5566 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5567 "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5568 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5570 // commitment tx with 3 htlc outputs, 2 offered having the same amount and preimage
5571 chan.value_to_self_msat = 7_000_000_000 - 2_000_000;
5572 chan.feerate_per_kw = 253;
5573 chan.pending_inbound_htlcs.clear();
5574 chan.pending_inbound_htlcs.push({
5575 let mut out = InboundHTLCOutput{
5577 amount_msat: 2000000,
5579 payment_hash: PaymentHash([0; 32]),
5580 state: InboundHTLCState::Committed,
5582 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
5585 chan.pending_outbound_htlcs.clear();
5586 chan.pending_outbound_htlcs.push({
5587 let mut out = OutboundHTLCOutput{
5589 amount_msat: 5000000,
5591 payment_hash: PaymentHash([0; 32]),
5592 state: OutboundHTLCState::Committed,
5593 source: HTLCSource::dummy(),
5595 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5598 chan.pending_outbound_htlcs.push({
5599 let mut out = OutboundHTLCOutput{
5601 amount_msat: 5000000,
5603 payment_hash: PaymentHash([0; 32]),
5604 state: OutboundHTLCState::Committed,
5605 source: HTLCSource::dummy(),
5607 out.payment_hash.0 = Sha256::hash(&hex::decode("0505050505050505050505050505050505050505050505050505050505050505").unwrap()).into_inner();
5611 test_commitment!("30440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df9",
5612 "3045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f",
5613 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2d8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121b8813000000000000220020305c12e1a0bc21e283c131cea1c66d68857d28b7b2fce0a6fbc40c164852121bc0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484a79f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100c4f1d60b6fca9febc8b39de1a31e84c5f7c4b41c97239ef05f4350aa484c6b5e02200c5134ac8b20eb7a29d0dd4a501f6aa8fefb8489171f4cb408bd2a32324ab03f014730440220048705bec5288d28b3f29344b8d124853b1af423a568664d2c6f02c8ea886525022060f998a461052a2476b912db426ea2a06700953a241135c7957f2e79bc222df901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5616 "304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c6",
5617 "304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c",
5618 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc34000000000000000000011f070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050048304502210081cbb94121761d34c189cd4e6a281feea6f585060ad0ba2632e8d6b3c6bb8a6c02201007981bbd16539d63df2805b5568f1f5688cd2a885d04706f50db9b77ba13c60148304502210090ed76aeb21b53236a598968abc66e2024691d07b62f53ddbeca8f93144af9c602205f873af5a0c10e62690e9aba09740550f194a9dc455ba4c1c23f6cde7704674c012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
5620 "304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5",
5621 "30450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d39",
5622 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3401000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201d0f09d2bf7bc245a4f17980e1e9164290df16c70c6a2ff1592f5030d6108581022061e744a7dc151b36bf0aff7a4f1812ba90b8b03633bb979a270d19858fd960c5014830450221009aef000d2e843a4202c1b1a2bf554abc9a7902bf49b2cb0759bc507456b7ebad02204e7c3d193ede2fd2b4cd6b39f51a920e581e35575e357e44d7b699c40ce61d3901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868f9010000" },
5624 "30440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f",
5625 "30440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e511",
5626 "0200000000010189a326e23addc28323dbadcb4e71c2c17088b6e8fa184103e552f44075dddc3402000000000000000001e1120000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220010bf035d5823596e50dce2076a4d9f942d8d28031c9c428b901a02b6b8140de02203250e8e4a08bc5b4ecdca4d0eedf98223e02e3ac1c0206b3a7ffdb374aa21e5f014730440220073de0067b88e425b3018b30366bfeda0ccb703118ccd3d02ead08c0f53511d002203fac50ac0e4cf8a3af0b4b1b12e801650591f748f8ddf1e089c160f10b69e51101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9142002cc93ebefbb1b73f0af055dcc27a0b504ad7688ac6868fa010000" }
5631 fn test_per_commitment_secret_gen() {
5632 // Test vectors from BOLT 3 Appendix D:
5634 let mut seed = [0; 32];
5635 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5636 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5637 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5639 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5640 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5641 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5643 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5644 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5646 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5647 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5649 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5650 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5651 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5655 fn test_key_derivation() {
5656 // Test vectors from BOLT 3 Appendix E:
5657 let secp_ctx = Secp256k1::new();
5659 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5660 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5662 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5663 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5665 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5666 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5668 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5669 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5671 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5672 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
5674 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5675 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
5677 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
5678 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());