1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::script::{Script,Builder};
3 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
4 use bitcoin::blockdata::opcodes;
5 use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
6 use bitcoin::util::bip143;
7 use bitcoin::consensus::encode::{self, Encodable, Decodable};
9 use bitcoin_hashes::{Hash, HashEngine};
10 use bitcoin_hashes::sha256::Hash as Sha256;
11 use bitcoin_hashes::hash160::Hash as Hash160;
13 use secp256k1::key::{PublicKey,SecretKey};
14 use secp256k1::{Secp256k1,Message,Signature};
18 use ln::msgs::DecodeError;
19 use ln::channelmonitor::ChannelMonitor;
20 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingForwardHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash};
21 use ln::chan_utils::{TxCreationKeys,HTLCOutputInCommitment,HTLC_SUCCESS_TX_WEIGHT,HTLC_TIMEOUT_TX_WEIGHT};
23 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
24 use chain::transaction::OutPoint;
25 use chain::keysinterface::{ChannelKeys, KeysInterface};
26 use util::{transaction_utils,rng};
27 use util::ser::{Readable, ReadableArgs, Writeable, Writer, WriterWriteAdaptor};
28 use util::logger::Logger;
29 use util::errors::APIError;
30 use util::config::{UserConfig,ChannelConfig};
33 use std::default::Default;
35 use std::time::Instant;
39 pub struct ChannelValueStat {
40 pub value_to_self_msat: u64,
41 pub channel_value_msat: u64,
42 pub channel_reserve_msat: u64,
43 pub pending_outbound_htlcs_amount_msat: u64,
44 pub pending_inbound_htlcs_amount_msat: u64,
45 pub holding_cell_outbound_amount_msat: u64,
46 pub their_max_htlc_value_in_flight_msat: u64, // outgoing
49 enum InboundHTLCRemovalReason {
50 FailRelay(msgs::OnionErrorPacket),
51 FailMalformed(([u8; 32], u16)),
52 Fulfill(PaymentPreimage),
55 enum InboundHTLCState {
56 /// Added by remote, to be included in next local commitment tx.
57 RemoteAnnounced(PendingHTLCStatus),
58 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
59 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
60 /// accept this HTLC. Implies AwaitingRemoteRevoke.
61 /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
62 /// a remote revoke_and_ack on a previous state before we can do so.
63 AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
64 /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
65 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
66 /// accept this HTLC. Implies AwaitingRemoteRevoke.
67 /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
69 AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
71 /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
72 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
74 /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
75 /// commitment transaction without it as otherwise we'll have to force-close the channel to
76 /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
77 /// anyway). That said, ChannelMonitor does this for us (see
78 /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
79 /// local state before then, once we're sure that the next commitment_signed and
80 /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
81 LocalRemoved(InboundHTLCRemovalReason),
84 struct InboundHTLCOutput {
88 payment_hash: PaymentHash,
89 state: InboundHTLCState,
92 enum OutboundHTLCState {
93 /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
94 /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
95 /// we will promote to Committed (note that they may not accept it until the next time we
96 /// revoke, but we dont really care about that:
97 /// * they've revoked, so worst case we can announce an old state and get our (option on)
98 /// money back (though we wont), and,
99 /// * we'll send them a revoke when they send a commitment_signed, and since only they're
100 /// allowed to remove it, the "can only be removed once committed on both sides" requirement
101 /// doesn't matter to us and its up to them to enforce it, worst-case they jump ahead but
102 /// we'll never get out of sync).
103 /// Note that we Box the OnionPacket as its rather large and we don't want to blow up
104 /// OutboundHTLCOutput's size just for a temporary bit
105 LocalAnnounced(Box<msgs::OnionPacket>),
107 /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
108 /// the change (though they'll need to revoke before we fail the payment).
110 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
111 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
112 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
113 /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
114 /// remote revoke_and_ack on a previous state before we can do so.
115 AwaitingRemoteRevokeToRemove,
116 /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
117 /// the remote side hasn't yet revoked their previous state, which we need them to do before we
118 /// can do any backwards failing. Implies AwaitingRemoteRevoke.
119 /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
120 /// revoke_and_ack to drop completely.
121 AwaitingRemovedRemoteRevoke,
124 struct OutboundHTLCOutput {
128 payment_hash: PaymentHash,
129 state: OutboundHTLCState,
131 /// If we're in a removed state, set if they failed, otherwise None
132 fail_reason: Option<HTLCFailReason>,
135 /// See AwaitingRemoteRevoke ChannelState for more info
136 enum HTLCUpdateAwaitingACK {
141 payment_hash: PaymentHash,
143 onion_routing_packet: msgs::OnionPacket,
144 time_created: Instant, //TODO: Some kind of timeout thing-a-majig
147 payment_preimage: PaymentPreimage,
152 err_packet: msgs::OnionErrorPacket,
156 /// There are a few "states" and then a number of flags which can be applied:
157 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
158 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
159 /// move on to ChannelFunded.
160 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
161 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
162 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
164 /// Implies we have (or are prepared to) send our open_channel/accept_channel message
165 OurInitSent = (1 << 0),
166 /// Implies we have received their open_channel/accept_channel message
167 TheirInitSent = (1 << 1),
168 /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
169 /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
170 /// upon receipt of funding_created, so simply skip this state.
172 /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
173 /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
174 /// and our counterparty consider the funding transaction confirmed.
176 /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
177 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
178 TheirFundingLocked = (1 << 4),
179 /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
180 /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
181 OurFundingLocked = (1 << 5),
183 /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
184 /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
186 PeerDisconnected = (1 << 7),
187 /// Flag which is set on ChannelFunded and FundingSent indicating the user has told us they
188 /// failed to update our ChannelMonitor somewhere and we should pause sending any outbound
189 /// messages until they've managed to do so.
190 MonitorUpdateFailed = (1 << 8),
191 /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
192 /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
193 /// messages as then we will be unable to determine which HTLCs they included in their
194 /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
196 /// Flag is set on ChannelFunded.
197 AwaitingRemoteRevoke = (1 << 9),
198 /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
199 /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
200 /// to respond with our own shutdown message when possible.
201 RemoteShutdownSent = (1 << 10),
202 /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
203 /// point, we may not add any new HTLCs to the channel.
204 /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
205 /// us their shutdown.
206 LocalShutdownSent = (1 << 11),
207 /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
208 /// to drop us, but we store this anyway.
209 ShutdownComplete = 4096,
211 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
212 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
214 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
216 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
217 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
218 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
220 pub(super) struct Channel {
221 config: ChannelConfig,
225 channel_id: [u8; 32],
227 channel_outbound: bool,
228 secp_ctx: Secp256k1<secp256k1::All>,
229 channel_value_satoshis: u64,
231 local_keys: ChannelKeys,
232 shutdown_pubkey: PublicKey,
234 // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
235 // generation start at 0 and count up...this simplifies some parts of implementation at the
236 // cost of others, but should really just be changed.
238 cur_local_commitment_transaction_number: u64,
239 cur_remote_commitment_transaction_number: u64,
240 value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
241 /// Upon receipt of a channel_reestablish we have to figure out whether to send a
242 /// revoke_and_ack first or a commitment update first. Generally, we prefer to send
243 /// revoke_and_ack first, but if we had a pending commitment update of our own waiting on a
244 /// remote revoke when we received the latest commitment update from the remote we have to make
245 /// sure that commitment update gets resent first.
246 received_commitment_while_awaiting_raa: bool,
247 pending_inbound_htlcs: Vec<InboundHTLCOutput>,
248 pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
249 holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
251 monitor_pending_revoke_and_ack: bool,
252 monitor_pending_commitment_signed: bool,
253 monitor_pending_order: Option<RAACommitmentOrder>,
254 monitor_pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>,
255 monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
257 // pending_update_fee is filled when sending and receiving update_fee
258 // For outbound channel, feerate_per_kw is updated with the value from
259 // pending_update_fee when revoke_and_ack is received
261 // For inbound channel, feerate_per_kw is updated when it receives
262 // commitment_signed and revoke_and_ack is generated
263 // The pending value is kept when another pair of update_fee and commitment_signed
264 // is received during AwaitingRemoteRevoke and relieved when the expected
265 // revoke_and_ack is received and new commitment_signed is generated to be
266 // sent to the funder. Otherwise, the pending value is removed when receiving
267 // commitment_signed.
268 pending_update_fee: Option<u64>,
269 // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
270 // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
271 // is received. holding_cell_update_fee is updated when there are additional
272 // update_fee() during ChannelState::AwaitingRemoteRevoke.
273 holding_cell_update_fee: Option<u64>,
275 pub next_local_htlc_id: u64,
277 next_local_htlc_id: u64,
279 pub next_remote_htlc_id: u64,
281 next_remote_htlc_id: u64,
282 channel_update_count: u32,
285 #[cfg(debug_assertions)]
286 /// Max to_local and to_remote outputs in a locally-generated commitment transaction
287 max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
288 #[cfg(debug_assertions)]
289 /// Max to_local and to_remote outputs in a remote-generated commitment transaction
290 max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
293 // Used in ChannelManager's tests to send a revoked transaction
294 pub last_local_commitment_txn: Vec<Transaction>,
296 last_local_commitment_txn: Vec<Transaction>,
298 last_sent_closing_fee: Option<(u64, u64)>, // (feerate, fee)
300 /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
301 /// to detect unconfirmation after a serialize-unserialize roudtrip where we may not see a full
302 /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
303 /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
304 funding_tx_confirmed_in: Option<Sha256dHash>,
305 short_channel_id: Option<u64>,
306 /// Used to deduplicate block_connected callbacks, also used to verify consistency during
307 /// ChannelManager deserialization (hence pub(super))
308 pub(super) last_block_connected: Sha256dHash,
309 funding_tx_confirmations: u64,
311 their_dust_limit_satoshis: u64,
313 pub(super) our_dust_limit_satoshis: u64,
315 our_dust_limit_satoshis: u64,
317 pub(super) their_max_htlc_value_in_flight_msat: u64,
319 their_max_htlc_value_in_flight_msat: u64,
320 //get_our_max_htlc_value_in_flight_msat(): u64,
321 /// minimum channel reserve for **self** to maintain - set by them.
322 their_channel_reserve_satoshis: u64,
323 //get_our_channel_reserve_satoshis(): u64,
324 their_htlc_minimum_msat: u64,
325 our_htlc_minimum_msat: u64,
326 their_to_self_delay: u16,
327 //implied by BREAKDOWN_TIMEOUT: our_to_self_delay: u16,
329 pub their_max_accepted_htlcs: u16,
331 their_max_accepted_htlcs: u16,
332 //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
335 their_funding_pubkey: Option<PublicKey>,
336 their_revocation_basepoint: Option<PublicKey>,
337 their_payment_basepoint: Option<PublicKey>,
338 their_delayed_payment_basepoint: Option<PublicKey>,
339 their_htlc_basepoint: Option<PublicKey>,
340 their_cur_commitment_point: Option<PublicKey>,
342 their_prev_commitment_point: Option<PublicKey>,
343 their_node_id: PublicKey,
345 their_shutdown_scriptpubkey: Option<Script>,
347 channel_monitor: ChannelMonitor,
352 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
353 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
354 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
355 /// really allow for this, so instead we're stuck closing it out at that point.
356 const UNCONF_THRESHOLD: u32 = 6;
357 /// The amount of time we require our counterparty wait to claim their money (ie time between when
358 /// we, or our watchtower, must check for them having broadcast a theft transaction).
359 const BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7; //TODO?
360 /// The amount of time we're willing to wait to claim money back to us
361 const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 14;
362 /// Exposing these two constants for use in test in ChannelMonitor
363 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
364 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
365 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
366 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?)
367 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
369 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
372 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
374 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 139;
375 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
377 /// Used to return a simple Error back to ChannelManager. Will get converted to a
378 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
379 /// channel_id in ChannelManager.
381 pub(super) enum ChannelError {
382 Ignore(&'static str),
386 macro_rules! secp_check {
387 ($res: expr, $err: expr) => {
390 Err(_) => return Err(ChannelError::Close($err)),
396 // Convert constants + channel value to limits:
397 pub fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
398 channel_value_satoshis * 1000 / 10 //TODO
401 /// Returns a minimum channel reserve value **they** need to maintain
403 /// Guaranteed to return a value no larger than channel_value_satoshis
404 fn get_our_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
405 let (q, _) = channel_value_satoshis.overflowing_div(100);
406 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
409 fn derive_our_dust_limit_satoshis(at_open_background_feerate: u64) -> u64 {
410 cmp::max(at_open_background_feerate * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
413 fn derive_our_htlc_minimum_msat(_at_open_channel_feerate_per_kw: u64) -> u64 {
417 fn derive_minimum_depth(_channel_value_satoshis_msat: u64, _value_to_self_msat: u64) -> u32 {
418 // Note that in order to comply with BOLT 7 announcement_signatures requirements this must
420 const CONF_TARGET: u32 = 12; //TODO: Should be much higher
425 pub fn new_outbound(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, APIError> {
426 let chan_keys = keys_provider.get_channel_keys(false);
428 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
429 return Err(APIError::APIMisuseError{err: "funding value > 2^24"});
432 if push_msat > channel_value_satoshis * 1000 {
433 return Err(APIError::APIMisuseError{err: "push value > channel value"});
437 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
438 if Channel::get_our_channel_reserve_satoshis(channel_value_satoshis) < Channel::derive_our_dust_limit_satoshis(background_feerate) {
439 return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
442 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
444 let secp_ctx = Secp256k1::new();
445 let channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
446 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
447 keys_provider.get_destination_script(), logger.clone());
451 config: config.channel_options.clone(),
453 channel_id: rng::rand_u832(),
454 channel_state: ChannelState::OurInitSent as u32,
455 channel_outbound: true,
457 channel_value_satoshis: channel_value_satoshis,
459 local_keys: chan_keys,
460 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
461 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
462 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
463 value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
464 received_commitment_while_awaiting_raa: false,
466 pending_inbound_htlcs: Vec::new(),
467 pending_outbound_htlcs: Vec::new(),
468 holding_cell_htlc_updates: Vec::new(),
469 pending_update_fee: None,
470 holding_cell_update_fee: None,
471 next_local_htlc_id: 0,
472 next_remote_htlc_id: 0,
473 channel_update_count: 1,
475 monitor_pending_revoke_and_ack: false,
476 monitor_pending_commitment_signed: false,
477 monitor_pending_order: None,
478 monitor_pending_forwards: Vec::new(),
479 monitor_pending_failures: Vec::new(),
481 #[cfg(debug_assertions)]
482 max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
483 #[cfg(debug_assertions)]
484 max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
486 last_local_commitment_txn: Vec::new(),
488 last_sent_closing_fee: None,
490 funding_tx_confirmed_in: None,
491 short_channel_id: None,
492 last_block_connected: Default::default(),
493 funding_tx_confirmations: 0,
495 feerate_per_kw: feerate,
496 their_dust_limit_satoshis: 0,
497 our_dust_limit_satoshis: Channel::derive_our_dust_limit_satoshis(background_feerate),
498 their_max_htlc_value_in_flight_msat: 0,
499 their_channel_reserve_satoshis: 0,
500 their_htlc_minimum_msat: 0,
501 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(feerate),
502 their_to_self_delay: 0,
503 their_max_accepted_htlcs: 0,
504 minimum_depth: 0, // Filled in in accept_channel
506 their_funding_pubkey: None,
507 their_revocation_basepoint: None,
508 their_payment_basepoint: None,
509 their_delayed_payment_basepoint: None,
510 their_htlc_basepoint: None,
511 their_cur_commitment_point: None,
513 their_prev_commitment_point: None,
514 their_node_id: their_node_id,
516 their_shutdown_scriptpubkey: None,
518 channel_monitor: channel_monitor,
524 fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), ChannelError> {
525 if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) {
526 return Err(ChannelError::Close("Peer's feerate much too low"));
528 if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) * 2 {
529 return Err(ChannelError::Close("Peer's feerate much too high"));
534 /// Creates a new channel from a remote sides' request for one.
535 /// Assumes chain_hash has already been checked and corresponds with what we expect!
536 pub fn new_from_req(fee_estimator: &FeeEstimator, keys_provider: &Arc<KeysInterface>, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, logger: Arc<Logger>, config: &UserConfig) -> Result<Channel, ChannelError> {
537 let chan_keys = keys_provider.get_channel_keys(true);
538 let mut local_config = (*config).channel_options.clone();
540 // Check sanity of message fields:
541 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
542 return Err(ChannelError::Close("funding value > 2^24"));
544 if msg.channel_reserve_satoshis > msg.funding_satoshis {
545 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
547 if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
548 return Err(ChannelError::Close("push_msat larger than funding value"));
550 if msg.dust_limit_satoshis > msg.funding_satoshis {
551 return Err(ChannelError::Close("Peer never wants payout outputs?"));
553 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
554 return Err(ChannelError::Close("Bogus; channel reserve is less than dust limit"));
556 if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 {
557 return Err(ChannelError::Close("Miminum htlc value is full channel value"));
559 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
561 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
562 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
564 if msg.max_accepted_htlcs < 1 {
565 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
567 if msg.max_accepted_htlcs > 483 {
568 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
571 // Now check against optional parameters as set by config...
572 if msg.funding_satoshis < config.channel_limits.min_funding_satoshis {
573 return Err(ChannelError::Close("funding satoshis is less than the user specified limit"));
575 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
576 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
578 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
579 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
581 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
582 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
584 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
585 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
587 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
588 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
590 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
591 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
594 // Convert things into internal flags and prep our state:
596 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
597 if config.channel_limits.force_announced_channel_preference {
598 if local_config.announced_channel != their_announce {
599 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours"));
602 // we either accept their preference or the preferences match
603 local_config.announced_channel = their_announce;
605 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
607 let our_dust_limit_satoshis = Channel::derive_our_dust_limit_satoshis(background_feerate);
608 let our_channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(msg.funding_satoshis);
609 if our_channel_reserve_satoshis < our_dust_limit_satoshis {
610 return Err(ChannelError::Close("Suitable channel reserve not found. aborting"));
612 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
613 return Err(ChannelError::Close("channel_reserve_satoshis too small"));
615 if our_channel_reserve_satoshis < msg.dust_limit_satoshis {
616 return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
619 // check if the funder's amount for the initial commitment tx is sufficient
620 // for full fee payment
621 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
622 if funders_amount_msat < background_feerate * COMMITMENT_TX_BASE_WEIGHT {
623 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
626 let to_local_msat = msg.push_msat;
627 let to_remote_msat = funders_amount_msat - background_feerate * COMMITMENT_TX_BASE_WEIGHT;
628 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= our_channel_reserve_satoshis * 1000 {
629 return Err(ChannelError::Close("Insufficient funding amount for initial commitment"));
632 let secp_ctx = Secp256k1::new();
633 let mut channel_monitor = ChannelMonitor::new(&chan_keys.revocation_base_key, &chan_keys.delayed_payment_base_key,
634 &chan_keys.htlc_base_key, &chan_keys.payment_base_key, &keys_provider.get_shutdown_pubkey(), BREAKDOWN_TIMEOUT,
635 keys_provider.get_destination_script(), logger.clone());
636 channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
637 channel_monitor.set_their_to_self_delay(msg.to_self_delay);
639 let mut chan = Channel {
641 config: local_config,
643 channel_id: msg.temporary_channel_id,
644 channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
645 channel_outbound: false,
648 local_keys: chan_keys,
649 shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
650 cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
651 cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
652 value_to_self_msat: msg.push_msat,
653 received_commitment_while_awaiting_raa: false,
655 pending_inbound_htlcs: Vec::new(),
656 pending_outbound_htlcs: Vec::new(),
657 holding_cell_htlc_updates: Vec::new(),
658 pending_update_fee: None,
659 holding_cell_update_fee: None,
660 next_local_htlc_id: 0,
661 next_remote_htlc_id: 0,
662 channel_update_count: 1,
664 monitor_pending_revoke_and_ack: false,
665 monitor_pending_commitment_signed: false,
666 monitor_pending_order: None,
667 monitor_pending_forwards: Vec::new(),
668 monitor_pending_failures: Vec::new(),
670 #[cfg(debug_assertions)]
671 max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
672 #[cfg(debug_assertions)]
673 max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
675 last_local_commitment_txn: Vec::new(),
677 last_sent_closing_fee: None,
679 funding_tx_confirmed_in: None,
680 short_channel_id: None,
681 last_block_connected: Default::default(),
682 funding_tx_confirmations: 0,
684 feerate_per_kw: msg.feerate_per_kw as u64,
685 channel_value_satoshis: msg.funding_satoshis,
686 their_dust_limit_satoshis: msg.dust_limit_satoshis,
687 our_dust_limit_satoshis: our_dust_limit_satoshis,
688 their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
689 their_channel_reserve_satoshis: msg.channel_reserve_satoshis,
690 their_htlc_minimum_msat: msg.htlc_minimum_msat,
691 our_htlc_minimum_msat: Channel::derive_our_htlc_minimum_msat(msg.feerate_per_kw as u64),
692 their_to_self_delay: msg.to_self_delay,
693 their_max_accepted_htlcs: msg.max_accepted_htlcs,
694 minimum_depth: Channel::derive_minimum_depth(msg.funding_satoshis*1000, msg.push_msat),
696 their_funding_pubkey: Some(msg.funding_pubkey),
697 their_revocation_basepoint: Some(msg.revocation_basepoint),
698 their_payment_basepoint: Some(msg.payment_basepoint),
699 their_delayed_payment_basepoint: Some(msg.delayed_payment_basepoint),
700 their_htlc_basepoint: Some(msg.htlc_basepoint),
701 their_cur_commitment_point: Some(msg.first_per_commitment_point),
703 their_prev_commitment_point: None,
704 their_node_id: their_node_id,
706 their_shutdown_scriptpubkey: None,
708 channel_monitor: channel_monitor,
713 let obscure_factor = chan.get_commitment_transaction_number_obscure_factor();
714 chan.channel_monitor.set_commitment_obscure_factor(obscure_factor);
719 // Utilities to derive keys:
721 fn build_local_commitment_secret(&self, idx: u64) -> SecretKey {
722 let res = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, idx);
723 SecretKey::from_slice(&self.secp_ctx, &res).unwrap()
726 // Utilities to build transactions:
728 fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
729 let mut sha = Sha256::engine();
730 let our_payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
732 if self.channel_outbound {
733 sha.input(&our_payment_basepoint.serialize());
734 sha.input(&self.their_payment_basepoint.unwrap().serialize());
736 sha.input(&self.their_payment_basepoint.unwrap().serialize());
737 sha.input(&our_payment_basepoint.serialize());
739 let res = Sha256::from_engine(sha).into_inner();
741 ((res[26] as u64) << 5*8) |
742 ((res[27] as u64) << 4*8) |
743 ((res[28] as u64) << 3*8) |
744 ((res[29] as u64) << 2*8) |
745 ((res[30] as u64) << 1*8) |
746 ((res[31] as u64) << 0*8)
749 /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
750 /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
751 /// the transaction. Thus, b will generally be sending a signature over such a transaction to
752 /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
753 /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
755 /// @local is used only to convert relevant internal structures which refer to remote vs local
756 /// to decide value of outputs and direction of HTLCs.
757 /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
758 /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
759 /// have not yet committed it. Such HTLCs will only be included in transactions which are being
760 /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
761 /// which peer generated this transaction and "to whom" this transaction flows.
762 /// Returns (the transaction built, the number of HTLC outputs which were present in the
763 /// transaction, the list of HTLCs which were not ignored when building the transaction).
764 /// Note that below-dust HTLCs are included in the third return value, but not the second, and
765 /// sources are provided only for outbound HTLCs in the third return value.
767 fn build_commitment_transaction(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u64) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) {
768 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
771 let mut ins: Vec<TxIn> = Vec::new();
773 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
774 script_sig: Script::new(),
775 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
781 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
782 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
784 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
785 let mut remote_htlc_total_msat = 0;
786 let mut local_htlc_total_msat = 0;
787 let mut value_to_self_msat_offset = 0;
789 macro_rules! get_htlc_in_commitment {
790 ($htlc: expr, $offered: expr) => {
791 HTLCOutputInCommitment {
793 amount_msat: $htlc.amount_msat,
794 cltv_expiry: $htlc.cltv_expiry,
795 payment_hash: $htlc.payment_hash,
796 transaction_output_index: None
801 macro_rules! add_htlc_output {
802 ($htlc: expr, $outbound: expr, $source: expr) => {
803 if $outbound == local { // "offered HTLC output"
804 let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
805 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
807 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
808 value: $htlc.amount_msat / 1000
809 }, Some((htlc_in_tx, $source))));
811 included_dust_htlcs.push((htlc_in_tx, $source));
814 let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
815 if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000) {
816 txouts.push((TxOut { // "received HTLC output"
817 script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
818 value: $htlc.amount_msat / 1000
819 }, Some((htlc_in_tx, $source))));
821 included_dust_htlcs.push((htlc_in_tx, $source));
827 for ref htlc in self.pending_inbound_htlcs.iter() {
828 let include = match htlc.state {
829 InboundHTLCState::RemoteAnnounced(_) => !generated_by_local,
830 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => !generated_by_local,
831 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => true,
832 InboundHTLCState::Committed => true,
833 InboundHTLCState::LocalRemoved(_) => !generated_by_local,
837 add_htlc_output!(htlc, false, None);
838 remote_htlc_total_msat += htlc.amount_msat;
841 &InboundHTLCState::LocalRemoved(ref reason) => {
842 if generated_by_local {
843 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
844 value_to_self_msat_offset += htlc.amount_msat as i64;
853 for ref htlc in self.pending_outbound_htlcs.iter() {
854 let include = match htlc.state {
855 OutboundHTLCState::LocalAnnounced(_) => generated_by_local,
856 OutboundHTLCState::Committed => true,
857 OutboundHTLCState::RemoteRemoved => generated_by_local,
858 OutboundHTLCState::AwaitingRemoteRevokeToRemove => generated_by_local,
859 OutboundHTLCState::AwaitingRemovedRemoteRevoke => false,
863 add_htlc_output!(htlc, true, Some(&htlc.source));
864 local_htlc_total_msat += htlc.amount_msat;
867 OutboundHTLCState::AwaitingRemoteRevokeToRemove|OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
868 if htlc.fail_reason.is_none() {
869 value_to_self_msat_offset -= htlc.amount_msat as i64;
872 OutboundHTLCState::RemoteRemoved => {
873 if !generated_by_local && htlc.fail_reason.is_none() {
874 value_to_self_msat_offset -= htlc.amount_msat as i64;
883 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
884 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000 - self.value_to_self_msat - remote_htlc_total_msat) as i64 - value_to_self_msat_offset;
886 #[cfg(debug_assertions)]
888 // Make sure that the to_self/to_remote is always either past the appropriate
889 // channel_reserve *or* it is making progress towards it.
890 // TODO: This should happen after fee calculation, but we don't handle that correctly
892 let mut max_commitment_tx_output = if generated_by_local {
893 self.max_commitment_tx_output_local.lock().unwrap()
895 self.max_commitment_tx_output_remote.lock().unwrap()
897 debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.their_channel_reserve_satoshis as i64);
898 max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
899 debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
900 max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
903 let total_fee: u64 = feerate_per_kw * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
904 let (value_to_self, value_to_remote) = if self.channel_outbound {
905 (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
907 (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
910 let value_to_a = if local { value_to_self } else { value_to_remote };
911 let value_to_b = if local { value_to_remote } else { value_to_self };
913 if value_to_a >= (dust_limit_satoshis as i64) {
915 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
916 if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT },
917 &keys.a_delayed_payment_key).to_v0_p2wsh(),
918 value: value_to_a as u64
922 if value_to_b >= (dust_limit_satoshis as i64) {
924 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0)
925 .push_slice(&Hash160::hash(&keys.b_payment_key.serialize())[..])
927 value: value_to_b as u64
931 transaction_utils::sort_outputs(&mut txouts);
933 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
934 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
935 for (idx, mut out) in txouts.drain(..).enumerate() {
937 if let Some((mut htlc, source_option)) = out.1.take() {
938 htlc.transaction_output_index = Some(idx as u32);
939 htlcs_included.push((htlc, source_option));
942 let non_dust_htlc_count = htlcs_included.len();
943 htlcs_included.append(&mut included_dust_htlcs);
947 lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
950 }, non_dust_htlc_count, htlcs_included)
954 fn get_closing_scriptpubkey(&self) -> Script {
955 let our_channel_close_key_hash = Hash160::hash(&self.shutdown_pubkey.serialize());
956 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
960 fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
961 (4 + 1 + 36 + 4 + 1 + 1 + 2*(8+1) + 4 + a_scriptpubkey.len() as u64 + b_scriptpubkey.len() as u64)*4 + 2 + 1 + 1 + 2*(1 + 72)
965 fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
967 let mut ins: Vec<TxIn> = Vec::new();
969 previous_output: self.channel_monitor.get_funding_txo().unwrap().into_bitcoin_outpoint(),
970 script_sig: Script::new(),
971 sequence: 0xffffffff,
977 assert!(self.pending_inbound_htlcs.is_empty());
978 assert!(self.pending_outbound_htlcs.is_empty());
979 let mut txouts: Vec<(TxOut, ())> = Vec::new();
981 let mut total_fee_satoshis = proposed_total_fee_satoshis;
982 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
983 let value_to_remote: i64 = ((self.channel_value_satoshis * 1000 - self.value_to_self_msat) as i64 / 1000) - if self.channel_outbound { 0 } else { total_fee_satoshis as i64 };
985 if value_to_self < 0 {
986 assert!(self.channel_outbound);
987 total_fee_satoshis += (-value_to_self) as u64;
988 } else if value_to_remote < 0 {
989 assert!(!self.channel_outbound);
990 total_fee_satoshis += (-value_to_remote) as u64;
993 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
995 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
996 value: value_to_remote as u64
1000 if value_to_self as u64 > self.our_dust_limit_satoshis {
1001 txouts.push((TxOut {
1002 script_pubkey: self.get_closing_scriptpubkey(),
1003 value: value_to_self as u64
1007 transaction_utils::sort_outputs(&mut txouts);
1009 let mut outputs: Vec<TxOut> = Vec::new();
1010 for out in txouts.drain(..) {
1011 outputs.push(out.0);
1019 }, total_fee_satoshis)
1023 /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1024 /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1025 /// our counterparty!)
1026 /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1027 /// TODO Some magic rust shit to compile-time check this?
1028 fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1029 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(commitment_number));
1030 let delayed_payment_base = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key);
1031 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1033 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &self.their_revocation_basepoint.unwrap(), &self.their_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap()), "Local tx keys generation got bogus keys"))
1037 /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1038 /// will sign and send to our counterparty.
1039 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1040 fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1041 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1042 //may see payments to it!
1043 let payment_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key);
1044 let revocation_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key);
1045 let htlc_basepoint = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key);
1047 Ok(secp_check!(TxCreationKeys::new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &self.their_delayed_payment_basepoint.unwrap(), &self.their_htlc_basepoint.unwrap(), &revocation_basepoint, &payment_basepoint, &htlc_basepoint), "Remote tx keys generation got bogus keys"))
1050 /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1051 /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1052 /// Panics if called before accept_channel/new_from_req
1053 pub fn get_funding_redeemscript(&self) -> Script {
1054 let builder = Builder::new().push_opcode(opcodes::All::OP_PUSHNUM_2);
1055 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1056 let their_funding_key = self.their_funding_pubkey.expect("get_funding_redeemscript only allowed after accept_channel").serialize();
1057 if our_funding_key[..] < their_funding_key[..] {
1058 builder.push_slice(&our_funding_key)
1059 .push_slice(&their_funding_key)
1061 builder.push_slice(&their_funding_key)
1062 .push_slice(&our_funding_key)
1063 }.push_opcode(opcodes::All::OP_PUSHNUM_2).push_opcode(opcodes::All::OP_CHECKMULTISIG).into_script()
1066 fn sign_commitment_transaction(&self, tx: &mut Transaction, their_sig: &Signature) -> Signature {
1067 if tx.input.len() != 1 {
1068 panic!("Tried to sign commitment transaction that had input count != 1!");
1070 if tx.input[0].witness.len() != 0 {
1071 panic!("Tried to re-sign commitment transaction");
1074 let funding_redeemscript = self.get_funding_redeemscript();
1076 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
1077 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
1079 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1081 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key).serialize();
1082 let their_funding_key = self.their_funding_pubkey.unwrap().serialize();
1083 if our_funding_key[..] < their_funding_key[..] {
1084 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1085 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1087 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1088 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1090 tx.input[0].witness[1].push(SigHashType::All as u8);
1091 tx.input[0].witness[2].push(SigHashType::All as u8);
1093 tx.input[0].witness.push(funding_redeemscript.into_bytes());
1098 /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1099 /// @local is used only to convert relevant internal structures which refer to remote vs local
1100 /// to decide value of outputs and direction of HTLCs.
1101 fn build_htlc_transaction(&self, prev_hash: &Sha256dHash, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u64) -> Transaction {
1102 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { BREAKDOWN_TIMEOUT }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1105 fn create_htlc_tx_signature(&self, tx: &Transaction, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<(Script, Signature, bool), ChannelError> {
1106 if tx.input.len() != 1 {
1107 panic!("Tried to sign HTLC transaction that had input count != 1!");
1110 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
1112 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
1113 let sighash = Message::from_slice(&bip143::SighashComponents::new(&tx).sighash_all(&tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1114 let is_local_tx = PublicKey::from_secret_key(&self.secp_ctx, &our_htlc_key) == keys.a_htlc_key;
1115 Ok((htlc_redeemscript, self.secp_ctx.sign(&sighash, &our_htlc_key), is_local_tx))
1118 /// Signs a transaction created by build_htlc_transaction. If the transaction is an
1119 /// HTLC-Success transaction (ie htlc.offered is false), preimate must be set!
1120 fn sign_htlc_transaction(&self, tx: &mut Transaction, their_sig: &Signature, preimage: &Option<PaymentPreimage>, htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Result<Signature, ChannelError> {
1121 if tx.input.len() != 1 {
1122 panic!("Tried to sign HTLC transaction that had input count != 1!");
1124 if tx.input[0].witness.len() != 0 {
1125 panic!("Tried to re-sign HTLC transaction");
1128 let (htlc_redeemscript, our_sig, local_tx) = self.create_htlc_tx_signature(tx, htlc, keys)?;
1130 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
1132 if local_tx { // b, then a
1133 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1134 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1136 tx.input[0].witness.push(our_sig.serialize_der(&self.secp_ctx).to_vec());
1137 tx.input[0].witness.push(their_sig.serialize_der(&self.secp_ctx).to_vec());
1139 tx.input[0].witness[1].push(SigHashType::All as u8);
1140 tx.input[0].witness[2].push(SigHashType::All as u8);
1143 tx.input[0].witness.push(Vec::new());
1145 tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1148 tx.input[0].witness.push(htlc_redeemscript.into_bytes());
1153 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1154 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1155 /// Ok(_) if debug assertions are turned on and preconditions are met.
1156 fn get_update_fulfill_htlc(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitor>), ChannelError> {
1157 // Either ChannelFunded got set (which means it wont bet unset) or there is no way any
1158 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1159 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1161 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1162 panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1164 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1166 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1168 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1169 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1170 // these, but for now we just have to treat them as normal.
1172 let mut pending_idx = std::usize::MAX;
1173 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1174 if htlc.htlc_id == htlc_id_arg {
1175 assert_eq!(htlc.payment_hash, payment_hash_calc);
1177 InboundHTLCState::Committed => {},
1178 InboundHTLCState::LocalRemoved(ref reason) => {
1179 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1181 log_warn!(self, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1183 return Ok((None, None));
1186 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1187 // Don't return in release mode here so that we can update channel_monitor
1194 if pending_idx == std::usize::MAX {
1195 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1198 // Now update local state:
1200 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1201 // can claim it even if the channel hits the chain before we see their next commitment.
1202 self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg);
1204 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1205 for pending_update in self.holding_cell_htlc_updates.iter() {
1206 match pending_update {
1207 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1208 if htlc_id_arg == htlc_id {
1209 return Ok((None, None));
1212 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1213 if htlc_id_arg == htlc_id {
1214 log_warn!(self, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1215 // TODO: We may actually be able to switch to a fulfill here, though its
1216 // rare enough it may not be worth the complexity burden.
1217 return Ok((None, Some(self.channel_monitor.clone())));
1223 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1224 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1226 return Ok((None, Some(self.channel_monitor.clone())));
1230 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1231 if let InboundHTLCState::Committed = htlc.state {
1233 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1234 return Ok((None, Some(self.channel_monitor.clone())));
1236 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1239 Ok((Some(msgs::UpdateFulfillHTLC {
1240 channel_id: self.channel_id(),
1241 htlc_id: htlc_id_arg,
1242 payment_preimage: payment_preimage_arg,
1243 }), Some(self.channel_monitor.clone())))
1246 pub fn get_update_fulfill_htlc_and_commit(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitor>), ChannelError> {
1247 match self.get_update_fulfill_htlc(htlc_id, payment_preimage)? {
1248 (Some(update_fulfill_htlc), _) => {
1249 let (commitment, monitor_update) = self.send_commitment_no_status_check()?;
1250 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1252 (None, Some(channel_monitor)) => Ok((None, Some(channel_monitor))),
1253 (None, None) => Ok((None, None))
1257 /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1258 /// In such cases we debug_assert!(false) and return an IgnoreError. Thus, will always return
1259 /// Ok(_) if debug assertions are turned on and preconditions are met.
1260 pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1261 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1262 panic!("Was asked to fail an HTLC when channel was not in an operational state");
1264 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1266 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1267 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1268 // these, but for now we just have to treat them as normal.
1270 let mut pending_idx = std::usize::MAX;
1271 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1272 if htlc.htlc_id == htlc_id_arg {
1274 InboundHTLCState::Committed => {},
1275 InboundHTLCState::LocalRemoved(_) => {
1279 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1280 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matchd the given HTLC ID"));
1286 if pending_idx == std::usize::MAX {
1287 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1290 // Now update local state:
1291 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1292 for pending_update in self.holding_cell_htlc_updates.iter() {
1293 match pending_update {
1294 &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1295 if htlc_id_arg == htlc_id {
1296 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1299 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1300 if htlc_id_arg == htlc_id {
1301 return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID"));
1307 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1308 htlc_id: htlc_id_arg,
1315 let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1316 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1319 Ok(Some(msgs::UpdateFailHTLC {
1320 channel_id: self.channel_id(),
1321 htlc_id: htlc_id_arg,
1326 // Message handlers:
1328 pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig) -> Result<(), ChannelError> {
1329 // Check sanity of message fields:
1330 if !self.channel_outbound {
1331 return Err(ChannelError::Close("Got an accept_channel message from an inbound peer"));
1333 if self.channel_state != ChannelState::OurInitSent as u32 {
1334 return Err(ChannelError::Close("Got an accept_channel message at a strange time"));
1336 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1337 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1339 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1340 return Err(ChannelError::Close("Bogus channel_reserve_satoshis"));
1342 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1343 return Err(ChannelError::Close("Bogus channel_reserve and dust_limit"));
1345 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1346 return Err(ChannelError::Close("Peer never wants payout outputs?"));
1348 if msg.dust_limit_satoshis > Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis) {
1349 return Err(ChannelError::Close("Dust limit is bigger than our channel reverse"));
1351 if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 {
1352 return Err(ChannelError::Close("Minimum htlc value is full channel value"));
1354 if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT {
1355 return Err(ChannelError::Close("They wanted our payments to be delayed by a needlessly long period"));
1357 if msg.max_accepted_htlcs < 1 {
1358 return Err(ChannelError::Close("0 max_accpted_htlcs makes for a useless channel"));
1360 if msg.max_accepted_htlcs > 483 {
1361 return Err(ChannelError::Close("max_accpted_htlcs > 483"));
1364 // Now check against optional parameters as set by config...
1365 if msg.htlc_minimum_msat > config.channel_limits.max_htlc_minimum_msat {
1366 return Err(ChannelError::Close("htlc minimum msat is higher than the user specified limit"));
1368 if msg.max_htlc_value_in_flight_msat < config.channel_limits.min_max_htlc_value_in_flight_msat {
1369 return Err(ChannelError::Close("max htlc value in flight msat is less than the user specified limit"));
1371 if msg.channel_reserve_satoshis > config.channel_limits.max_channel_reserve_satoshis {
1372 return Err(ChannelError::Close("channel reserve satoshis is higher than the user specified limit"));
1374 if msg.max_accepted_htlcs < config.channel_limits.min_max_accepted_htlcs {
1375 return Err(ChannelError::Close("max accepted htlcs is less than the user specified limit"));
1377 if msg.dust_limit_satoshis < config.channel_limits.min_dust_limit_satoshis {
1378 return Err(ChannelError::Close("dust limit satoshis is less than the user specified limit"));
1380 if msg.dust_limit_satoshis > config.channel_limits.max_dust_limit_satoshis {
1381 return Err(ChannelError::Close("dust limit satoshis is greater than the user specified limit"));
1383 if msg.minimum_depth > config.channel_limits.max_minimum_depth {
1384 return Err(ChannelError::Close("We consider the minimum depth to be unreasonably large"));
1387 self.channel_monitor.set_their_base_keys(&msg.htlc_basepoint, &msg.delayed_payment_basepoint);
1389 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1390 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1391 self.their_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1392 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1393 self.their_to_self_delay = msg.to_self_delay;
1394 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1395 self.minimum_depth = msg.minimum_depth;
1396 self.their_funding_pubkey = Some(msg.funding_pubkey);
1397 self.their_revocation_basepoint = Some(msg.revocation_basepoint);
1398 self.their_payment_basepoint = Some(msg.payment_basepoint);
1399 self.their_delayed_payment_basepoint = Some(msg.delayed_payment_basepoint);
1400 self.their_htlc_basepoint = Some(msg.htlc_basepoint);
1401 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1403 let obscure_factor = self.get_commitment_transaction_number_obscure_factor();
1404 self.channel_monitor.set_commitment_obscure_factor(obscure_factor);
1405 self.channel_monitor.set_their_to_self_delay(msg.to_self_delay);
1407 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1412 fn funding_created_signature(&mut self, sig: &Signature) -> Result<(Transaction, Transaction, Signature, TxCreationKeys), ChannelError> {
1413 let funding_script = self.get_funding_redeemscript();
1415 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1416 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1417 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1419 // They sign the "local" commitment transaction...
1420 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, &self.their_funding_pubkey.unwrap()), "Invalid funding_created signature from peer");
1422 // ...and we sign it, allowing us to broadcast the tx if we wish
1423 self.sign_commitment_transaction(&mut local_initial_commitment_tx, sig);
1425 let remote_keys = self.build_remote_transaction_keys()?;
1426 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
1427 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1429 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1430 Ok((remote_initial_commitment_tx, local_initial_commitment_tx, self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), local_keys))
1433 pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), ChannelError> {
1434 if self.channel_outbound {
1435 return Err(ChannelError::Close("Received funding_created for an outbound channel?"));
1437 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1438 // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1439 // remember the channel, so its safe to just send an error_message here and drop the
1441 return Err(ChannelError::Close("Received funding_created after we got the channel!"));
1443 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1444 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1445 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1446 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1449 let funding_txo = OutPoint::new(msg.funding_txid, msg.funding_output_index);
1450 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
1451 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
1453 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature, local_keys) = match self.funding_created_signature(&msg.signature) {
1456 self.channel_monitor.unset_funding_info();
1461 // Now that we're past error-generating stuff, update our local state:
1463 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_initial_commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
1464 self.last_local_commitment_txn = vec![local_initial_commitment_tx.clone()];
1465 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx, local_keys, self.feerate_per_kw, Vec::new());
1466 self.channel_state = ChannelState::FundingSent as u32;
1467 self.channel_id = funding_txo.to_channel_id();
1468 self.cur_remote_commitment_transaction_number -= 1;
1469 self.cur_local_commitment_transaction_number -= 1;
1471 Ok((msgs::FundingSigned {
1472 channel_id: self.channel_id,
1473 signature: our_signature
1474 }, self.channel_monitor.clone()))
1477 /// Handles a funding_signed message from the remote end.
1478 /// If this call is successful, broadcast the funding transaction (and not before!)
1479 pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result<ChannelMonitor, ChannelError> {
1480 if !self.channel_outbound {
1481 return Err(ChannelError::Close("Received funding_signed for an inbound channel?"));
1483 if self.channel_state != ChannelState::FundingCreated as u32 {
1484 return Err(ChannelError::Close("Received funding_signed in strange state!"));
1486 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
1487 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER - 1 ||
1488 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1489 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1492 let funding_script = self.get_funding_redeemscript();
1494 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1495 let mut local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw).0;
1496 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1498 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1499 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid funding_signed signature from peer");
1501 self.sign_commitment_transaction(&mut local_initial_commitment_tx, &msg.signature);
1502 self.channel_monitor.provide_latest_local_commitment_tx_info(local_initial_commitment_tx.clone(), local_keys, self.feerate_per_kw, Vec::new());
1503 self.last_local_commitment_txn = vec![local_initial_commitment_tx];
1504 self.channel_state = ChannelState::FundingSent as u32;
1505 self.cur_local_commitment_transaction_number -= 1;
1507 Ok(self.channel_monitor.clone())
1510 pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1511 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1512 return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish"));
1515 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1517 if non_shutdown_state == ChannelState::FundingSent as u32 {
1518 self.channel_state |= ChannelState::TheirFundingLocked as u32;
1519 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1520 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1521 self.channel_update_count += 1;
1522 } else if self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1523 // Note that funding_signed/funding_created will have decremented both by 1!
1524 self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1525 self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 {
1526 if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1527 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point"));
1529 // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1532 return Err(ChannelError::Close("Peer sent a funding_locked at a strange time"));
1535 self.their_prev_commitment_point = self.their_cur_commitment_point;
1536 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1540 /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1541 fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1542 let mut htlc_inbound_value_msat = 0;
1543 for ref htlc in self.pending_inbound_htlcs.iter() {
1544 htlc_inbound_value_msat += htlc.amount_msat;
1546 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1549 /// Returns (outbound_htlc_count, htlc_outbound_value_msat)
1550 fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1551 let mut htlc_outbound_value_msat = 0;
1552 for ref htlc in self.pending_outbound_htlcs.iter() {
1553 htlc_outbound_value_msat += htlc.amount_msat;
1556 (self.pending_outbound_htlcs.len() as u32, htlc_outbound_value_msat)
1559 pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingHTLCStatus) -> Result<(), ChannelError> {
1560 if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) {
1561 return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state"));
1563 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1564 return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish"));
1566 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1567 return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel"));
1569 if msg.amount_msat < self.our_htlc_minimum_msat {
1570 return Err(ChannelError::Close("Remote side tried to send less than our minimum HTLC value"));
1573 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1574 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1575 return Err(ChannelError::Close("Remote tried to push more than our max accepted HTLCs"));
1577 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
1578 // Check our_max_htlc_value_in_flight_msat
1579 if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) {
1580 return Err(ChannelError::Close("Remote HTLC add would put them over their max HTLC value in flight"));
1582 // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1583 // the reserve_satoshis we told them to always have as direct payment so that they lose
1584 // something if we punish them for broadcasting an old state).
1585 if htlc_inbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 {
1586 return Err(ChannelError::Close("Remote HTLC add would put them over their reserve value"));
1588 if self.next_remote_htlc_id != msg.htlc_id {
1589 return Err(ChannelError::Close("Remote skipped HTLC ID"));
1591 if msg.cltv_expiry >= 500000000 {
1592 return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height"));
1595 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1597 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1598 if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1599 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1603 // Now update local state:
1604 self.next_remote_htlc_id += 1;
1605 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1606 htlc_id: msg.htlc_id,
1607 amount_msat: msg.amount_msat,
1608 payment_hash: msg.payment_hash,
1609 cltv_expiry: msg.cltv_expiry,
1610 state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1616 /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1618 fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1619 for htlc in self.pending_outbound_htlcs.iter_mut() {
1620 if htlc.htlc_id == htlc_id {
1621 match check_preimage {
1623 Some(payment_hash) =>
1624 if payment_hash != htlc.payment_hash {
1625 return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1629 OutboundHTLCState::LocalAnnounced(_) =>
1630 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1631 OutboundHTLCState::Committed => {
1632 htlc.state = OutboundHTLCState::RemoteRemoved;
1633 htlc.fail_reason = fail_reason;
1635 OutboundHTLCState::AwaitingRemoteRevokeToRemove | OutboundHTLCState::AwaitingRemovedRemoteRevoke | OutboundHTLCState::RemoteRemoved =>
1636 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1638 return Ok(&htlc.source);
1641 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1644 pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1645 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1646 return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1648 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1649 return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1652 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1653 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1656 pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1657 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1658 return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1660 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1661 return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1664 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1668 pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1669 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1670 return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1672 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1673 return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1676 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1680 pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &FeeEstimator) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1681 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1682 return Err(ChannelError::Close("Got commitment signed message when channel was not in an operational state"));
1684 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1685 return Err(ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish"));
1687 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1688 return Err(ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds"));
1691 let funding_script = self.get_funding_redeemscript();
1693 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1695 let mut update_fee = false;
1696 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1698 self.pending_update_fee.unwrap()
1703 let mut local_commitment_tx = {
1704 let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1705 let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1706 (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1708 let local_commitment_txid = local_commitment_tx.0.txid();
1709 let local_sighash = Message::from_slice(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
1710 secp_check!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid commitment tx signature from peer");
1712 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1714 let num_htlcs = local_commitment_tx.1;
1715 let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1717 if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1718 return Err(ChannelError::Close("Funding remote cannot afford proposed new fee"));
1722 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1723 return Err(ChannelError::Close("Got wrong number of HTLC signatures from remote"));
1726 let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1 + 1);
1727 self.sign_commitment_transaction(&mut local_commitment_tx.0, &msg.signature);
1728 new_local_commitment_txn.push(local_commitment_tx.0.clone());
1730 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1731 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1732 if let Some(_) = htlc.transaction_output_index {
1733 let mut htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1734 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1735 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
1736 secp_check!(self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key), "Invalid HTLC tx signature from peer");
1737 let htlc_sig = if htlc.offered {
1738 let htlc_sig = self.sign_htlc_transaction(&mut htlc_tx, &msg.htlc_signatures[idx], &None, &htlc, &local_keys)?;
1739 new_local_commitment_txn.push(htlc_tx);
1742 self.create_htlc_tx_signature(&htlc_tx, &htlc, &local_keys)?.1
1744 htlcs_and_sigs.push((htlc, Some((msg.htlc_signatures[idx], htlc_sig)), source));
1746 htlcs_and_sigs.push((htlc, None, source));
1750 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1751 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 1);
1753 // Update state now that we've passed all the can-fail calls...
1754 let mut need_our_commitment = false;
1755 if !self.channel_outbound {
1756 if let Some(fee_update) = self.pending_update_fee {
1757 self.feerate_per_kw = fee_update;
1758 // We later use the presence of pending_update_fee to indicate we should generate a
1759 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1760 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1761 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1762 need_our_commitment = true;
1763 self.pending_update_fee = None;
1768 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1769 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1770 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1771 self.monitor_pending_order = None;
1774 self.channel_monitor.provide_latest_local_commitment_tx_info(local_commitment_tx.0, local_keys, self.feerate_per_kw, htlcs_and_sigs);
1776 for htlc in self.pending_inbound_htlcs.iter_mut() {
1777 let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1778 Some(forward_info.clone())
1780 if let Some(forward_info) = new_forward {
1781 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1782 need_our_commitment = true;
1785 for htlc in self.pending_outbound_htlcs.iter_mut() {
1786 if let OutboundHTLCState::RemoteRemoved = htlc.state {
1787 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove;
1788 need_our_commitment = true;
1792 self.cur_local_commitment_transaction_number -= 1;
1793 self.last_local_commitment_txn = new_local_commitment_txn;
1794 self.received_commitment_while_awaiting_raa = (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) != 0;
1796 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1797 self.monitor_pending_revoke_and_ack = true;
1798 self.monitor_pending_commitment_signed |= need_our_commitment;
1799 return Err(ChannelError::Ignore("Previous monitor update failure prevented generation of RAA"));
1802 let (our_commitment_signed, monitor_update, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1803 // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1804 // we'll send one right away when we get the revoke_and_ack when we
1805 // free_holding_cell_htlcs().
1806 let (msg, monitor) = self.send_commitment_no_status_check()?;
1807 (Some(msg), monitor, None)
1808 } else if !need_our_commitment {
1809 (None, self.channel_monitor.clone(), self.maybe_propose_first_closing_signed(fee_estimator))
1810 } else { (None, self.channel_monitor.clone(), None) };
1812 Ok((msgs::RevokeAndACK {
1813 channel_id: self.channel_id,
1814 per_commitment_secret: per_commitment_secret,
1815 next_per_commitment_point: next_per_commitment_point,
1816 }, our_commitment_signed, closing_signed, monitor_update))
1819 /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1820 /// fulfilling or failing the last pending HTLC)
1821 fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitor)>, ChannelError> {
1822 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1823 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1824 let mut htlc_updates = Vec::new();
1825 mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1826 let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1827 let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1828 let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1830 for htlc_update in htlc_updates.drain(..) {
1831 // Note that this *can* fail, though it should be due to rather-rare conditions on
1832 // fee races with adding too many outputs which push our total payments just over
1833 // the limit. In case its less rare than I anticipate, we may want to revisit
1834 // handling this case better and maybe fufilling some of the HTLCs while attempting
1835 // to rebalance channels.
1836 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
1837 self.holding_cell_htlc_updates.push(htlc_update);
1839 match &htlc_update {
1840 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
1841 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
1842 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
1848 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
1849 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
1850 Ok(update_fulfill_msg_option) => update_fulfill_htlcs.push(update_fulfill_msg_option.0.unwrap()),
1852 if let ChannelError::Ignore(_) = e {}
1854 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
1859 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
1860 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
1861 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
1863 if let ChannelError::Ignore(_) = e {}
1865 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
1872 self.holding_cell_htlc_updates.push(htlc_update);
1876 //TODO: Need to examine the type of err - if its a fee issue or similar we may want to
1877 //fail it back the route, if its a temporary issue we can ignore it...
1880 if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
1881 // This should never actually happen and indicates we got some Errs back
1882 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
1883 // case there is some strange way to hit duplicate HTLC removes.
1886 let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
1887 self.pending_update_fee = self.holding_cell_update_fee.take();
1888 Some(msgs::UpdateFee {
1889 channel_id: self.channel_id,
1890 feerate_per_kw: feerate as u32,
1895 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
1896 Ok(Some((msgs::CommitmentUpdate {
1898 update_fulfill_htlcs,
1900 update_fail_malformed_htlcs: Vec::new(),
1901 update_fee: update_fee,
1903 }, monitor_update)))
1912 /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
1913 /// commitment_signed message here in case we had pending outbound HTLCs to add which were
1914 /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
1915 /// generating an appropriate error *after* the channel state has been updated based on the
1916 /// revoke_and_ack message.
1917 pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &FeeEstimator) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitor), ChannelError> {
1918 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1919 return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
1921 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1922 return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
1924 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1925 return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
1928 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
1929 if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&self.secp_ctx, &msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")) != their_prev_commitment_point {
1930 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
1933 self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
1934 .map_err(|e| ChannelError::Close(e.0))?;
1936 // Update state now that we've passed all the can-fail calls...
1937 // (note that we may still fail to generate the new commitment_signed message, but that's
1938 // OK, we step the channel here and *then* if the new generation fails we can fail the
1939 // channel based on that, but stepping stuff here should be safe either way.
1940 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
1941 self.their_prev_commitment_point = self.their_cur_commitment_point;
1942 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1943 self.cur_remote_commitment_transaction_number -= 1;
1944 self.received_commitment_while_awaiting_raa = false;
1945 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
1946 // This is a response to our post-monitor-failed unfreeze messages, so we can clear the
1947 // monitor_pending_order requirement as we won't re-send the monitor_pending messages.
1948 self.monitor_pending_order = None;
1951 let mut to_forward_infos = Vec::new();
1952 let mut revoked_htlcs = Vec::new();
1953 let mut update_fail_htlcs = Vec::new();
1954 let mut update_fail_malformed_htlcs = Vec::new();
1955 let mut require_commitment = false;
1956 let mut value_to_self_msat_diff: i64 = 0;
1957 // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
1958 self.pending_inbound_htlcs.retain(|htlc| {
1959 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
1960 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1961 value_to_self_msat_diff += htlc.amount_msat as i64;
1966 self.pending_outbound_htlcs.retain(|htlc| {
1967 if let OutboundHTLCState::AwaitingRemovedRemoteRevoke = htlc.state {
1968 if let Some(reason) = htlc.fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
1969 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
1971 // They fulfilled, so we sent them money
1972 value_to_self_msat_diff -= htlc.amount_msat as i64;
1977 for htlc in self.pending_inbound_htlcs.iter_mut() {
1978 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
1980 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
1984 let mut state = InboundHTLCState::Committed;
1985 mem::swap(&mut state, &mut htlc.state);
1987 if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
1988 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
1989 require_commitment = true;
1990 } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
1991 match forward_info {
1992 PendingHTLCStatus::Fail(fail_msg) => {
1993 require_commitment = true;
1995 HTLCFailureMsg::Relay(msg) => {
1996 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
1997 update_fail_htlcs.push(msg)
1999 HTLCFailureMsg::Malformed(msg) => {
2000 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2001 update_fail_malformed_htlcs.push(msg)
2005 PendingHTLCStatus::Forward(forward_info) => {
2006 to_forward_infos.push((forward_info, htlc.htlc_id));
2007 htlc.state = InboundHTLCState::Committed;
2013 for htlc in self.pending_outbound_htlcs.iter_mut() {
2014 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2015 htlc.state = OutboundHTLCState::Committed;
2016 } else if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
2017 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
2018 require_commitment = true;
2021 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2023 if self.channel_outbound {
2024 if let Some(feerate) = self.pending_update_fee.take() {
2025 self.feerate_per_kw = feerate;
2028 if let Some(feerate) = self.pending_update_fee {
2029 // Because a node cannot send two commitment_signed's in a row without getting a
2030 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2031 // it should use to create keys with) and because a node can't send a
2032 // commitment_signed without changes, checking if the feerate is equal to the
2033 // pending feerate update is sufficient to detect require_commitment.
2034 if feerate == self.feerate_per_kw {
2035 require_commitment = true;
2036 self.pending_update_fee = None;
2041 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2042 // We can't actually generate a new commitment transaction (incl by freeing holding
2043 // cells) while we can't update the monitor, so we just return what we have.
2044 if require_commitment {
2045 self.monitor_pending_commitment_signed = true;
2047 self.monitor_pending_forwards.append(&mut to_forward_infos);
2048 self.monitor_pending_failures.append(&mut revoked_htlcs);
2049 return Ok((None, Vec::new(), Vec::new(), None, self.channel_monitor.clone()));
2052 match self.free_holding_cell_htlcs()? {
2053 Some(mut commitment_update) => {
2054 commitment_update.0.update_fail_htlcs.reserve(update_fail_htlcs.len());
2055 for fail_msg in update_fail_htlcs.drain(..) {
2056 commitment_update.0.update_fail_htlcs.push(fail_msg);
2058 commitment_update.0.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2059 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2060 commitment_update.0.update_fail_malformed_htlcs.push(fail_msg);
2062 Ok((Some(commitment_update.0), to_forward_infos, revoked_htlcs, None, commitment_update.1))
2065 if require_commitment {
2066 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2067 Ok((Some(msgs::CommitmentUpdate {
2068 update_add_htlcs: Vec::new(),
2069 update_fulfill_htlcs: Vec::new(),
2071 update_fail_malformed_htlcs,
2074 }), to_forward_infos, revoked_htlcs, None, monitor_update))
2076 Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), self.channel_monitor.clone()))
2083 /// Adds a pending update to this channel. See the doc for send_htlc for
2084 /// further details on the optionness of the return value.
2085 /// You MUST call send_commitment prior to any other calls on this Channel
2086 fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2087 if !self.channel_outbound {
2088 panic!("Cannot send fee from inbound channel");
2090 if !self.is_usable() {
2091 panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2093 if !self.is_live() {
2094 panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2097 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2098 self.holding_cell_update_fee = Some(feerate_per_kw);
2102 debug_assert!(self.pending_update_fee.is_none());
2103 self.pending_update_fee = Some(feerate_per_kw);
2105 Some(msgs::UpdateFee {
2106 channel_id: self.channel_id,
2107 feerate_per_kw: feerate_per_kw as u32,
2111 pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
2112 match self.send_update_fee(feerate_per_kw) {
2113 Some(update_fee) => {
2114 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2115 Ok(Some((update_fee, commitment_signed, monitor_update)))
2121 /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2122 /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2123 /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2124 /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2125 /// No further message handling calls may be made until a channel_reestablish dance has
2127 pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2128 let mut outbound_drops = Vec::new();
2130 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2131 if self.channel_state < ChannelState::FundingSent as u32 {
2132 self.channel_state = ChannelState::ShutdownComplete as u32;
2133 return outbound_drops;
2135 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2136 // will be retransmitted.
2137 self.last_sent_closing_fee = None;
2139 let mut inbound_drop_count = 0;
2140 self.pending_inbound_htlcs.retain(|htlc| {
2142 InboundHTLCState::RemoteAnnounced(_) => {
2143 // They sent us an update_add_htlc but we never got the commitment_signed.
2144 // We'll tell them what commitment_signed we're expecting next and they'll drop
2145 // this HTLC accordingly
2146 inbound_drop_count += 1;
2149 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2150 // We received a commitment_signed updating this HTLC and (at least hopefully)
2151 // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2152 // in response to it yet, so don't touch it.
2155 InboundHTLCState::Committed => true,
2156 InboundHTLCState::LocalRemoved(_) => {
2157 // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2158 // re-transmit if needed) and they may have even sent a revoke_and_ack back
2159 // (that we missed). Keep this around for now and if they tell us they missed
2160 // the commitment_signed we can re-transmit the update then.
2165 self.next_remote_htlc_id -= inbound_drop_count;
2167 for htlc in self.pending_outbound_htlcs.iter_mut() {
2168 if let OutboundHTLCState::RemoteRemoved = htlc.state {
2169 // They sent us an update to remove this but haven't yet sent the corresponding
2170 // commitment_signed, we need to move it back to Committed and they can re-send
2171 // the update upon reconnection.
2172 htlc.state = OutboundHTLCState::Committed;
2176 self.holding_cell_htlc_updates.retain(|htlc_update| {
2178 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2179 outbound_drops.push((source.clone(), payment_hash.clone()));
2182 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2185 self.channel_state |= ChannelState::PeerDisconnected as u32;
2186 log_debug!(self, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2190 /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2191 /// updates are partially paused.
2192 /// This must be called immediately after the call which generated the ChannelMonitor update
2193 /// which failed, with the order argument set to the type of call it represented (ie a
2194 /// commitment update or a revoke_and_ack generation). The messages which were generated from
2195 /// that original call must *not* have been sent to the remote end, and must instead have been
2196 /// dropped. They will be regenerated when monitor_updating_restored is called.
2197 pub fn monitor_update_failed(&mut self, order: RAACommitmentOrder, mut pending_forwards: Vec<(PendingForwardHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, raa_first_dropped_cs: bool) {
2198 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2200 RAACommitmentOrder::CommitmentFirst => {
2201 self.monitor_pending_revoke_and_ack = false;
2202 self.monitor_pending_commitment_signed = true;
2204 RAACommitmentOrder::RevokeAndACKFirst => {
2205 self.monitor_pending_revoke_and_ack = true;
2206 self.monitor_pending_commitment_signed = raa_first_dropped_cs;
2209 assert!(self.monitor_pending_forwards.is_empty());
2210 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2211 assert!(self.monitor_pending_failures.is_empty());
2212 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2213 self.monitor_pending_order = Some(order);
2214 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2217 /// Indicates that the latest ChannelMonitor update has been committed by the client
2218 /// successfully and we should restore normal operation. Returns messages which should be sent
2219 /// to the remote side.
2220 pub fn monitor_updating_restored(&mut self) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingForwardHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2221 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2222 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2224 let mut forwards = Vec::new();
2225 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2226 let mut failures = Vec::new();
2227 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2229 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2230 // Leave monitor_pending_order so we can order our channel_reestablish responses
2231 self.monitor_pending_revoke_and_ack = false;
2232 self.monitor_pending_commitment_signed = false;
2233 return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures);
2236 let raa = if self.monitor_pending_revoke_and_ack {
2237 Some(self.get_last_revoke_and_ack())
2239 let commitment_update = if self.monitor_pending_commitment_signed {
2240 Some(self.get_last_commitment_update())
2243 self.monitor_pending_revoke_and_ack = false;
2244 self.monitor_pending_commitment_signed = false;
2245 (raa, commitment_update, self.monitor_pending_order.clone().unwrap(), forwards, failures)
2248 pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), ChannelError> {
2249 if self.channel_outbound {
2250 return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2252 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2253 return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2255 Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2256 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2257 self.channel_update_count += 1;
2261 fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2262 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2263 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed, self.cur_local_commitment_transaction_number + 2);
2264 msgs::RevokeAndACK {
2265 channel_id: self.channel_id,
2266 per_commitment_secret,
2267 next_per_commitment_point,
2271 fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2272 let mut update_add_htlcs = Vec::new();
2273 let mut update_fulfill_htlcs = Vec::new();
2274 let mut update_fail_htlcs = Vec::new();
2275 let mut update_fail_malformed_htlcs = Vec::new();
2277 for htlc in self.pending_outbound_htlcs.iter() {
2278 if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2279 update_add_htlcs.push(msgs::UpdateAddHTLC {
2280 channel_id: self.channel_id(),
2281 htlc_id: htlc.htlc_id,
2282 amount_msat: htlc.amount_msat,
2283 payment_hash: htlc.payment_hash,
2284 cltv_expiry: htlc.cltv_expiry,
2285 onion_routing_packet: (**onion_packet).clone(),
2290 for htlc in self.pending_inbound_htlcs.iter() {
2291 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2293 &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2294 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2295 channel_id: self.channel_id(),
2296 htlc_id: htlc.htlc_id,
2297 reason: err_packet.clone()
2300 &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2301 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2302 channel_id: self.channel_id(),
2303 htlc_id: htlc.htlc_id,
2304 sha256_of_onion: sha256_of_onion.clone(),
2305 failure_code: failure_code.clone(),
2308 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2309 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2310 channel_id: self.channel_id(),
2311 htlc_id: htlc.htlc_id,
2312 payment_preimage: payment_preimage.clone(),
2319 msgs::CommitmentUpdate {
2320 update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2321 update_fee: None, //TODO: We need to support re-generating any update_fees in the last commitment_signed!
2322 commitment_signed: self.send_commitment_no_state_update().expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2326 /// May panic if some calls other than message-handling calls (which will all Err immediately)
2327 /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2328 pub fn channel_reestablish(&mut self, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitor>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> {
2329 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2330 // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2331 // almost certainly indicates we are going to end up out-of-sync in some way, so we
2332 // just close here instead of trying to recover.
2333 return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2336 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2337 msg.next_local_commitment_number == 0 {
2338 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2341 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2342 // remaining cases either succeed or ErrorMessage-fail).
2343 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2345 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2346 Some(msgs::Shutdown {
2347 channel_id: self.channel_id,
2348 scriptpubkey: self.get_closing_scriptpubkey(),
2352 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2353 if self.channel_state & ChannelState::OurFundingLocked as u32 == 0 {
2354 if msg.next_remote_commitment_number != 0 {
2355 return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2357 // Short circuit the whole handler as there is nothing we can resend them
2358 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2361 // We have OurFundingLocked set!
2362 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2363 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2364 return Ok((Some(msgs::FundingLocked {
2365 channel_id: self.channel_id(),
2366 next_per_commitment_point: next_per_commitment_point,
2367 }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2370 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2371 // Remote isn't waiting on any RevokeAndACK from us!
2372 // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2374 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2375 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2376 self.monitor_pending_revoke_and_ack = true;
2379 Some(self.get_last_revoke_and_ack())
2382 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2385 // We increment cur_remote_commitment_transaction_number only upon receipt of
2386 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2387 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2388 // the corresponding revoke_and_ack back yet.
2389 let our_next_remote_commitment_number = INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number + if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 };
2391 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2392 // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2393 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2394 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2395 Some(msgs::FundingLocked {
2396 channel_id: self.channel_id(),
2397 next_per_commitment_point: next_per_commitment_point,
2401 let order = self.monitor_pending_order.clone().unwrap_or(if self.received_commitment_while_awaiting_raa {
2402 RAACommitmentOrder::CommitmentFirst
2404 RAACommitmentOrder::RevokeAndACKFirst
2407 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2408 if required_revoke.is_some() {
2409 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2411 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2414 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 &&
2415 self.monitor_pending_order.is_none() { // monitor_pending_order indicates we're waiting on a response to a unfreeze
2416 // We're up-to-date and not waiting on a remote revoke (if we are our
2417 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2418 // have received some updates while we were disconnected. Free the holding cell
2420 match self.free_holding_cell_htlcs() {
2421 Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2422 Err(ChannelError::Ignore(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2423 Ok(Some((commitment_update, channel_monitor))) => return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(channel_monitor), order, shutdown_msg)),
2424 Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg)),
2427 return Ok((resend_funding_locked, required_revoke, None, None, order, shutdown_msg));
2429 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2430 if required_revoke.is_some() {
2431 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2433 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2436 // If monitor_pending_order is set, it must be CommitmentSigned if we have no RAA
2437 debug_assert!(self.monitor_pending_order != Some(RAACommitmentOrder::RevokeAndACKFirst) || required_revoke.is_some());
2439 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2440 self.monitor_pending_commitment_signed = true;
2441 return Ok((resend_funding_locked, None, None, None, order, shutdown_msg));
2444 return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, order, shutdown_msg));
2446 return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2450 fn maybe_propose_first_closing_signed(&mut self, fee_estimator: &FeeEstimator) -> Option<msgs::ClosingSigned> {
2451 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2452 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2453 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2457 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2458 if self.feerate_per_kw > proposed_feerate {
2459 proposed_feerate = self.feerate_per_kw;
2461 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2462 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2464 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2465 let funding_redeemscript = self.get_funding_redeemscript();
2466 let sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2468 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis));
2469 Some(msgs::ClosingSigned {
2470 channel_id: self.channel_id,
2471 fee_satoshis: total_fee_satoshis,
2472 signature: self.secp_ctx.sign(&sighash, &self.local_keys.funding_key),
2476 pub fn shutdown(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError> {
2477 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2478 return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2480 if self.channel_state < ChannelState::FundingSent as u32 {
2481 // Spec says we should fail the connection, not the channel, but that's nonsense, there
2482 // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2483 // can do that via error message without getting a connection fail anyway...
2484 return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2486 for htlc in self.pending_inbound_htlcs.iter() {
2487 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2488 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2491 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2493 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2494 // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script.
2495 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2496 return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2499 //Check shutdown_scriptpubkey form as BOLT says we must
2500 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2501 return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2504 if self.their_shutdown_scriptpubkey.is_some() {
2505 if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2506 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2509 self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2512 // From here on out, we may not fail!
2514 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2515 self.channel_update_count += 1;
2517 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2518 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2519 // cell HTLCs and return them to fail the payment.
2520 self.holding_cell_update_fee = None;
2521 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2522 self.holding_cell_htlc_updates.retain(|htlc_update| {
2524 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2525 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2531 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2532 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2533 // any further commitment updates after we set LocalShutdownSent.
2535 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2538 Some(msgs::Shutdown {
2539 channel_id: self.channel_id,
2540 scriptpubkey: self.get_closing_scriptpubkey(),
2544 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2545 self.channel_update_count += 1;
2546 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2549 pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError> {
2550 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2551 return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2553 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2554 return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2556 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2557 return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2559 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2560 return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2563 let funding_redeemscript = self.get_funding_redeemscript();
2564 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2565 if used_total_fee != msg.fee_satoshis {
2566 return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2568 let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2570 match self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()) {
2573 // The remote end may have decided to revoke their output due to inconsistent dust
2574 // limits, so check for that case by re-checking the signature here.
2575 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2576 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2577 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, &self.their_funding_pubkey.unwrap()), "Invalid closing tx signature from peer");
2581 if let Some((_, last_fee)) = self.last_sent_closing_fee {
2582 if last_fee == msg.fee_satoshis {
2583 self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2584 self.channel_state = ChannelState::ShutdownComplete as u32;
2585 self.channel_update_count += 1;
2586 return Ok((None, Some(closing_tx)));
2590 macro_rules! propose_new_feerate {
2591 ($new_feerate: expr) => {
2592 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2593 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2594 sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap();
2595 let our_sig = self.secp_ctx.sign(&sighash, &self.local_keys.funding_key);
2596 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee));
2597 return Ok((Some(msgs::ClosingSigned {
2598 channel_id: self.channel_id,
2599 fee_satoshis: used_total_fee,
2605 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight();
2606 if self.channel_outbound {
2607 let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2608 if proposed_sat_per_kw > our_max_feerate {
2609 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2610 if our_max_feerate <= last_feerate {
2611 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2614 propose_new_feerate!(our_max_feerate);
2617 let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2618 if proposed_sat_per_kw < our_min_feerate {
2619 if let Some((last_feerate, _)) = self.last_sent_closing_fee {
2620 if our_min_feerate >= last_feerate {
2621 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2624 propose_new_feerate!(our_min_feerate);
2628 let our_sig = self.sign_commitment_transaction(&mut closing_tx, &msg.signature);
2629 self.channel_state = ChannelState::ShutdownComplete as u32;
2630 self.channel_update_count += 1;
2632 Ok((Some(msgs::ClosingSigned {
2633 channel_id: self.channel_id,
2634 fee_satoshis: msg.fee_satoshis,
2636 }), Some(closing_tx)))
2639 // Public utilities:
2641 pub fn channel_id(&self) -> [u8; 32] {
2645 /// Gets the "user_id" value passed into the construction of this channel. It has no special
2646 /// meaning and exists only to allow users to have a persistent identifier of a channel.
2647 pub fn get_user_id(&self) -> u64 {
2651 /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2652 pub fn channel_monitor(&self) -> ChannelMonitor {
2653 if self.channel_state < ChannelState::FundingCreated as u32 {
2654 panic!("Can't get a channel monitor until funding has been created");
2656 self.channel_monitor.clone()
2659 /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2660 /// is_usable() returns true).
2661 /// Allowed in any state (including after shutdown)
2662 pub fn get_short_channel_id(&self) -> Option<u64> {
2663 self.short_channel_id
2666 /// Returns the funding_txo we either got from our peer, or were given by
2667 /// get_outbound_funding_created.
2668 pub fn get_funding_txo(&self) -> Option<OutPoint> {
2669 self.channel_monitor.get_funding_txo()
2672 /// Allowed in any state (including after shutdown)
2673 pub fn get_their_node_id(&self) -> PublicKey {
2677 /// Allowed in any state (including after shutdown)
2678 pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2679 self.our_htlc_minimum_msat
2682 /// Allowed in any state (including after shutdown)
2683 pub fn get_their_htlc_minimum_msat(&self) -> u64 {
2684 self.our_htlc_minimum_msat
2687 pub fn get_value_satoshis(&self) -> u64 {
2688 self.channel_value_satoshis
2691 pub fn get_fee_proportional_millionths(&self) -> u32 {
2692 self.config.fee_proportional_millionths
2696 pub fn get_feerate(&self) -> u64 {
2700 pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
2701 self.cur_local_commitment_transaction_number + 1
2704 pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
2705 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
2708 pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
2709 self.cur_remote_commitment_transaction_number + 2
2712 //TODO: Testing purpose only, should be changed in another way after #81
2714 pub fn get_local_keys(&self) -> &ChannelKeys {
2719 pub fn get_value_stat(&self) -> ChannelValueStat {
2721 value_to_self_msat: self.value_to_self_msat,
2722 channel_value_msat: self.channel_value_satoshis * 1000,
2723 channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
2724 pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2725 pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
2726 holding_cell_outbound_amount_msat: {
2728 for h in self.holding_cell_htlc_updates.iter() {
2730 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
2738 their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
2742 /// Allowed in any state (including after shutdown)
2743 pub fn get_channel_update_count(&self) -> u32 {
2744 self.channel_update_count
2747 pub fn should_announce(&self) -> bool {
2748 self.config.announced_channel
2751 pub fn is_outbound(&self) -> bool {
2752 self.channel_outbound
2755 /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
2756 /// Allowed in any state (including after shutdown)
2757 pub fn get_our_fee_base_msat(&self, fee_estimator: &FeeEstimator) -> u32 {
2758 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
2759 // output value back into a transaction with the regular channel output:
2761 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
2762 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
2764 if self.channel_outbound {
2765 // + the marginal fee increase cost to us in the commitment transaction:
2766 res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
2769 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
2770 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
2775 /// Returns true if we've ever received a message from the remote end for this Channel
2776 pub fn have_received_message(&self) -> bool {
2777 self.channel_state > (ChannelState::OurInitSent as u32)
2780 /// Returns true if this channel is fully established and not known to be closing.
2781 /// Allowed in any state (including after shutdown)
2782 pub fn is_usable(&self) -> bool {
2783 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
2784 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
2787 /// Returns true if this channel is currently available for use. This is a superset of
2788 /// is_usable() and considers things like the channel being temporarily disabled.
2789 /// Allowed in any state (including after shutdown)
2790 pub fn is_live(&self) -> bool {
2791 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
2794 /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
2795 /// Allowed in any state (including after shutdown)
2796 pub fn is_awaiting_monitor_update(&self) -> bool {
2797 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
2800 /// Returns true if funding_created was sent/received.
2801 pub fn is_funding_initiated(&self) -> bool {
2802 self.channel_state >= ChannelState::FundingCreated as u32
2805 /// Returns true if this channel is fully shut down. True here implies that no further actions
2806 /// may/will be taken on this channel, and thus this object should be freed. Any future changes
2807 /// will be handled appropriately by the chain monitor.
2808 pub fn is_shutdown(&self) -> bool {
2809 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32 {
2810 assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
2815 /// Called by channelmanager based on chain blocks being connected.
2816 /// Note that we only need to use this to detect funding_signed, anything else is handled by
2817 /// the channel_monitor.
2818 /// In case of Err, the channel may have been closed, at which point the standard requirements
2819 /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
2820 /// Only returns an ErrorAction of DisconnectPeer, if Err.
2821 pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
2822 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
2823 if header.bitcoin_hash() != self.last_block_connected {
2824 self.last_block_connected = header.bitcoin_hash();
2825 self.channel_monitor.last_block_hash = self.last_block_connected;
2826 if self.funding_tx_confirmations > 0 {
2827 self.funding_tx_confirmations += 1;
2828 if self.funding_tx_confirmations == self.minimum_depth as u64 {
2829 let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
2830 self.channel_state |= ChannelState::OurFundingLocked as u32;
2832 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
2833 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
2834 self.channel_update_count += 1;
2836 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
2837 // We got a reorg but not enough to trigger a force close, just update
2838 // funding_tx_confirmed_in and return.
2840 } else if self.channel_state < ChannelState::ChannelFunded as u32 {
2841 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
2843 // We got a reorg but not enough to trigger a force close, just update
2844 // funding_tx_confirmed_in and return.
2847 self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
2849 //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
2850 //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
2851 //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
2852 //a protocol oversight, but I assume I'm just missing something.
2853 if need_commitment_update {
2854 let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2855 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2856 return Ok(Some(msgs::FundingLocked {
2857 channel_id: self.channel_id,
2858 next_per_commitment_point: next_per_commitment_point,
2864 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
2865 for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
2866 if tx.txid() == self.channel_monitor.get_funding_txo().unwrap().txid {
2867 let txo_idx = self.channel_monitor.get_funding_txo().unwrap().index as usize;
2868 if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
2869 tx.output[txo_idx].value != self.channel_value_satoshis {
2870 if self.channel_outbound {
2871 // If we generated the funding transaction and it doesn't match what it
2872 // should, the client is really broken and we should just panic and
2873 // tell them off. That said, because hash collisions happen with high
2874 // probability in fuzztarget mode, if we're fuzzing we just close the
2875 // channel and move on.
2876 #[cfg(not(feature = "fuzztarget"))]
2877 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2879 self.channel_state = ChannelState::ShutdownComplete as u32;
2880 self.channel_update_count += 1;
2881 return Err(msgs::ErrorMessage {
2882 channel_id: self.channel_id(),
2883 data: "funding tx had wrong script/value".to_owned()
2886 if self.channel_outbound {
2887 for input in tx.input.iter() {
2888 if input.witness.is_empty() {
2889 // We generated a malleable funding transaction, implying we've
2890 // just exposed ourselves to funds loss to our counterparty.
2891 #[cfg(not(feature = "fuzztarget"))]
2892 panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
2896 self.funding_tx_confirmations = 1;
2897 self.short_channel_id = Some(((height as u64) << (5*8)) |
2898 ((*index_in_block as u64) << (2*8)) |
2899 ((txo_idx as u64) << (0*8)));
2907 /// Called by channelmanager based on chain blocks being disconnected.
2908 /// Returns true if we need to close the channel now due to funding transaction
2909 /// unconfirmation/reorg.
2910 pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
2911 if self.funding_tx_confirmations > 0 {
2912 self.funding_tx_confirmations -= 1;
2913 if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
2917 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
2918 self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
2920 self.last_block_connected = header.bitcoin_hash();
2921 self.channel_monitor.last_block_hash = self.last_block_connected;
2925 // Methods to get unprompted messages to send to the remote end (or where we already returned
2926 // something in the handler for the message that prompted this message):
2928 pub fn get_open_channel(&self, chain_hash: Sha256dHash, fee_estimator: &FeeEstimator) -> msgs::OpenChannel {
2929 if !self.channel_outbound {
2930 panic!("Tried to open a channel for an inbound channel?");
2932 if self.channel_state != ChannelState::OurInitSent as u32 {
2933 panic!("Cannot generate an open_channel after we've moved forward");
2936 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2937 panic!("Tried to send an open_channel for a channel that has already advanced");
2940 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2943 chain_hash: chain_hash,
2944 temporary_channel_id: self.channel_id,
2945 funding_satoshis: self.channel_value_satoshis,
2946 push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
2947 dust_limit_satoshis: self.our_dust_limit_satoshis,
2948 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2949 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2950 htlc_minimum_msat: self.our_htlc_minimum_msat,
2951 feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
2952 to_self_delay: BREAKDOWN_TIMEOUT,
2953 max_accepted_htlcs: OUR_MAX_HTLCS,
2954 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2955 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2956 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2957 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2958 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2959 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2960 channel_flags: if self.config.announced_channel {1} else {0},
2961 shutdown_scriptpubkey: None,
2965 pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
2966 if self.channel_outbound {
2967 panic!("Tried to send accept_channel for an outbound channel?");
2969 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
2970 panic!("Tried to send accept_channel after channel had moved forward");
2972 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
2973 panic!("Tried to send an accept_channel for a channel that has already advanced");
2976 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2978 msgs::AcceptChannel {
2979 temporary_channel_id: self.channel_id,
2980 dust_limit_satoshis: self.our_dust_limit_satoshis,
2981 max_htlc_value_in_flight_msat: Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
2982 channel_reserve_satoshis: Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
2983 htlc_minimum_msat: self.our_htlc_minimum_msat,
2984 minimum_depth: self.minimum_depth,
2985 to_self_delay: BREAKDOWN_TIMEOUT,
2986 max_accepted_htlcs: OUR_MAX_HTLCS,
2987 funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key),
2988 revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.revocation_base_key),
2989 payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.payment_base_key),
2990 delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.delayed_payment_base_key),
2991 htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.htlc_base_key),
2992 first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
2993 shutdown_scriptpubkey: None,
2997 /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
2998 fn get_outbound_funding_created_signature(&mut self) -> Result<(Signature, Transaction), ChannelError> {
2999 let funding_script = self.get_funding_redeemscript();
3001 let remote_keys = self.build_remote_transaction_keys()?;
3002 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3003 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_initial_commitment_tx).sighash_all(&remote_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
3005 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
3006 Ok((self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key), remote_initial_commitment_tx))
3009 /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3010 /// a funding_created message for the remote peer.
3011 /// Panics if called at some time other than immediately after initial handshake, if called twice,
3012 /// or if called on an inbound channel.
3013 /// Note that channel_id changes during this call!
3014 /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3015 /// If an Err is returned, it is a ChannelError::Close.
3016 pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<(msgs::FundingCreated, ChannelMonitor), ChannelError> {
3017 if !self.channel_outbound {
3018 panic!("Tried to create outbound funding_created message on an inbound channel!");
3020 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3021 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)");
3023 if self.channel_monitor.get_min_seen_secret() != (1 << 48) ||
3024 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3025 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3026 panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3029 let funding_txo_script = self.get_funding_redeemscript().to_v0_p2wsh();
3030 self.channel_monitor.set_funding_info((funding_txo, funding_txo_script));
3032 let (our_signature, commitment_tx) = match self.get_outbound_funding_created_signature() {
3035 log_error!(self, "Got bad signatures: {:?}!", e);
3036 self.channel_monitor.unset_funding_info();
3041 let temporary_channel_id = self.channel_id;
3043 // Now that we're past error-generating stuff, update our local state:
3044 self.channel_monitor.provide_latest_remote_commitment_tx_info(&commitment_tx, Vec::new(), self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3045 self.channel_state = ChannelState::FundingCreated as u32;
3046 self.channel_id = funding_txo.to_channel_id();
3047 self.cur_remote_commitment_transaction_number -= 1;
3049 Ok((msgs::FundingCreated {
3050 temporary_channel_id: temporary_channel_id,
3051 funding_txid: funding_txo.txid,
3052 funding_output_index: funding_txo.index,
3053 signature: our_signature
3054 }, self.channel_monitor.clone()))
3057 /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3058 /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3059 /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3060 /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3061 /// Will only fail if we're not in a state where channel_announcement may be sent (including
3063 /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3064 /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3065 pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3066 if !self.config.announced_channel {
3067 return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3069 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3070 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3072 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3073 return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3076 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3077 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, &self.local_keys.funding_key);
3079 let msg = msgs::UnsignedChannelAnnouncement {
3080 features: msgs::GlobalFeatures::new(),
3081 chain_hash: chain_hash,
3082 short_channel_id: self.get_short_channel_id().unwrap(),
3083 node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3084 node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3085 bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey.unwrap() },
3086 bitcoin_key_2: if were_node_one { self.their_funding_pubkey.unwrap() } else { our_bitcoin_key },
3087 excess_data: Vec::new(),
3090 let msghash = Message::from_slice(&Sha256dHash::from_data(&msg.encode()[..])[..]).unwrap();
3091 let sig = self.secp_ctx.sign(&msghash, &self.local_keys.funding_key);
3096 /// May panic if called on a channel that wasn't immediately-previously
3097 /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3098 pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3099 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3100 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3101 msgs::ChannelReestablish {
3102 channel_id: self.channel_id(),
3103 // The protocol has two different commitment number concepts - the "commitment
3104 // transaction number", which starts from 0 and counts up, and the "revocation key
3105 // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3106 // commitment transaction numbers by the index which will be used to reveal the
3107 // revocation key for that commitment transaction, which means we have to convert them
3108 // to protocol-level commitment numbers here...
3110 // next_local_commitment_number is the next commitment_signed number we expect to
3111 // receive (indicating if they need to resend one that we missed).
3112 next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3113 // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3114 // receive, however we track it by the next commitment number for a remote transaction
3115 // (which is one further, as they always revoke previous commitment transaction, not
3116 // the one we send) so we have to decrement by 1. Note that if
3117 // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3118 // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3120 next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3121 data_loss_protect: None,
3126 // Send stuff to our remote peers:
3128 /// Adds a pending outbound HTLC to this channel, note that you probably want
3129 /// send_htlc_and_commit instead cause you'll want both messages at once.
3130 /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3131 /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3132 /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3133 /// You MUST call send_commitment prior to any other calls on this Channel
3134 /// If an Err is returned, its a ChannelError::Ignore!
3135 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> {
3136 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3137 return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3140 if amount_msat > self.channel_value_satoshis * 1000 {
3141 return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3143 if amount_msat < self.their_htlc_minimum_msat {
3144 return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3147 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3148 // Note that this should never really happen, if we're !is_live() on receipt of an
3149 // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3150 // the user to send directly into a !is_live() channel. However, if we
3151 // disconnected during the time the previous hop was doing the commitment dance we may
3152 // end up getting here after the forwarding delay. In any case, returning an
3153 // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3154 return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3157 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3158 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3159 return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3161 //TODO: Spec is unclear if this is per-direction or in total (I assume per direction):
3162 // Check their_max_htlc_value_in_flight_msat
3163 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3164 return Err(ChannelError::Ignore("Cannot send value that would put us over our max HTLC value in flight"));
3167 let mut holding_cell_outbound_amount_msat = 0;
3168 for holding_htlc in self.holding_cell_htlc_updates.iter() {
3169 match holding_htlc {
3170 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } => {
3171 holding_cell_outbound_amount_msat += *amount_msat;
3177 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3178 // reserve for them to have something to claim if we misbehave)
3179 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + holding_cell_outbound_amount_msat + htlc_outbound_value_msat {
3180 return Err(ChannelError::Ignore("Cannot send value that would put us over our reserve value"));
3183 //TODO: Check cltv_expiry? Do this in channel manager?
3185 // Now update local state:
3186 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3187 //TODO: Check the limits *including* other pending holding cell HTLCs!
3188 self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3189 amount_msat: amount_msat,
3190 payment_hash: payment_hash,
3191 cltv_expiry: cltv_expiry,
3193 onion_routing_packet: onion_routing_packet,
3194 time_created: Instant::now(),
3199 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3200 htlc_id: self.next_local_htlc_id,
3201 amount_msat: amount_msat,
3202 payment_hash: payment_hash.clone(),
3203 cltv_expiry: cltv_expiry,
3204 state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3209 let res = msgs::UpdateAddHTLC {
3210 channel_id: self.channel_id,
3211 htlc_id: self.next_local_htlc_id,
3212 amount_msat: amount_msat,
3213 payment_hash: payment_hash,
3214 cltv_expiry: cltv_expiry,
3215 onion_routing_packet: onion_routing_packet,
3217 self.next_local_htlc_id += 1;
3222 /// Creates a signed commitment transaction to send to the remote peer.
3223 /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3224 /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3225 /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3226 pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3227 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3228 panic!("Cannot create commitment tx until channel is fully established");
3230 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3231 panic!("Cannot create commitment tx until remote revokes their previous commitment");
3233 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3234 panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3236 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3237 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");
3239 let mut have_updates = self.pending_update_fee.is_some();
3240 for htlc in self.pending_outbound_htlcs.iter() {
3241 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3242 have_updates = true;
3244 if have_updates { break; }
3246 for htlc in self.pending_inbound_htlcs.iter() {
3247 if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3248 have_updates = true;
3250 if have_updates { break; }
3253 panic!("Cannot create commitment tx until we have some updates to send");
3255 self.send_commitment_no_status_check()
3257 /// Only fails in case of bad keys
3258 fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), ChannelError> {
3259 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3260 // fail to generate this, we still are at least at a position where upgrading their status
3262 for htlc in self.pending_inbound_htlcs.iter_mut() {
3263 let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3264 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3266 if let Some(state) = new_state {
3270 for htlc in self.pending_outbound_htlcs.iter_mut() {
3271 if let OutboundHTLCState::AwaitingRemoteRevokeToRemove = htlc.state {
3272 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke;
3276 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3277 Ok((res, (remote_commitment_tx, mut htlcs))) => {
3278 // Update state now that we've passed all the can-fail calls...
3279 let htlcs_no_ref = htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3280 (res, remote_commitment_tx, htlcs_no_ref)
3282 Err(e) => return Err(e),
3285 self.channel_monitor.provide_latest_remote_commitment_tx_info(&remote_commitment_tx, htlcs, self.cur_remote_commitment_transaction_number, self.their_cur_commitment_point.unwrap());
3286 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3287 Ok((res, self.channel_monitor.clone()))
3290 /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3291 /// when we shouldn't change HTLC/channel state.
3292 fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3293 let funding_script = self.get_funding_redeemscript();
3295 let mut feerate_per_kw = self.feerate_per_kw;
3296 if let Some(feerate) = self.pending_update_fee {
3297 if self.channel_outbound {
3298 feerate_per_kw = feerate;
3302 let remote_keys = self.build_remote_transaction_keys()?;
3303 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3304 let remote_commitment_txid = remote_commitment_tx.0.txid();
3305 let remote_sighash = Message::from_slice(&bip143::SighashComponents::new(&remote_commitment_tx.0).sighash_all(&remote_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]).unwrap();
3306 let our_sig = self.secp_ctx.sign(&remote_sighash, &self.local_keys.funding_key);
3308 let mut htlc_sigs = Vec::with_capacity(remote_commitment_tx.1);
3309 for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3310 if let Some(_) = htlc.transaction_output_index {
3311 let htlc_tx = self.build_htlc_transaction(&remote_commitment_txid, htlc, false, &remote_keys, feerate_per_kw);
3312 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &remote_keys);
3313 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
3314 let our_htlc_key = secp_check!(chan_utils::derive_private_key(&self.secp_ctx, &remote_keys.per_commitment_point, &self.local_keys.htlc_base_key), "Derived invalid key, peer is maliciously selecting parameters");
3315 htlc_sigs.push(self.secp_ctx.sign(&htlc_sighash, &our_htlc_key));
3319 Ok((msgs::CommitmentSigned {
3320 channel_id: self.channel_id,
3322 htlc_signatures: htlc_sigs,
3323 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3326 /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3327 /// to send to the remote peer in one go.
3328 /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3330 pub fn send_htlc_and_commit(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitor)>, ChannelError> {
3331 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3332 Some(update_add_htlc) => {
3333 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3334 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3340 /// Begins the shutdown process, getting a message for the remote peer and returning all
3341 /// holding cell HTLCs for payment failure.
3342 pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3343 for htlc in self.pending_outbound_htlcs.iter() {
3344 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3345 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3348 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3349 if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3350 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3352 else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3353 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3356 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3357 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3358 return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3361 let our_closing_script = self.get_closing_scriptpubkey();
3363 // From here on out, we may not fail!
3364 if self.channel_state < ChannelState::FundingSent as u32 {
3365 self.channel_state = ChannelState::ShutdownComplete as u32;
3367 self.channel_state |= ChannelState::LocalShutdownSent as u32;
3369 self.channel_update_count += 1;
3371 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3372 // our shutdown until we've committed all of the pending changes.
3373 self.holding_cell_update_fee = None;
3374 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3375 self.holding_cell_htlc_updates.retain(|htlc_update| {
3377 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3378 dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3385 Ok((msgs::Shutdown {
3386 channel_id: self.channel_id,
3387 scriptpubkey: our_closing_script,
3388 }, dropped_outbound_htlcs))
3391 /// Gets the latest commitment transaction and any dependant transactions for relay (forcing
3392 /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3393 /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3394 /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3395 /// immediately (others we will have to allow to time out).
3396 pub fn force_shutdown(&mut self) -> (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>) {
3397 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3399 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3400 // return them to fail the payment.
3401 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3402 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3404 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3405 dropped_outbound_htlcs.push((source, payment_hash));
3411 for _htlc in self.pending_outbound_htlcs.drain(..) {
3412 //TODO: Do something with the remaining HTLCs
3413 //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3417 self.channel_state = ChannelState::ShutdownComplete as u32;
3418 self.channel_update_count += 1;
3419 let mut res = Vec::new();
3420 mem::swap(&mut res, &mut self.last_local_commitment_txn);
3421 (res, dropped_outbound_htlcs)
3425 const SERIALIZATION_VERSION: u8 = 1;
3426 const MIN_SERIALIZATION_VERSION: u8 = 1;
3428 impl Writeable for InboundHTLCRemovalReason {
3429 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3431 &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3433 error_packet.write(writer)?;
3435 &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3437 onion_hash.write(writer)?;
3438 err_code.write(writer)?;
3440 &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3442 payment_preimage.write(writer)?;
3449 impl<R: ::std::io::Read> Readable<R> for InboundHTLCRemovalReason {
3450 fn read(reader: &mut R) -> Result<Self, DecodeError> {
3451 Ok(match <u8 as Readable<R>>::read(reader)? {
3452 0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3453 1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3454 2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3455 _ => return Err(DecodeError::InvalidValue),
3460 impl Writeable for Channel {
3461 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3462 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3463 // called but include holding cell updates (and obviously we don't modify self).
3465 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3466 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3468 self.user_id.write(writer)?;
3469 self.config.write(writer)?;
3471 self.channel_id.write(writer)?;
3472 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3473 self.channel_outbound.write(writer)?;
3474 self.channel_value_satoshis.write(writer)?;
3476 self.local_keys.write(writer)?;
3477 self.shutdown_pubkey.write(writer)?;
3479 self.cur_local_commitment_transaction_number.write(writer)?;
3480 self.cur_remote_commitment_transaction_number.write(writer)?;
3481 self.value_to_self_msat.write(writer)?;
3483 self.received_commitment_while_awaiting_raa.write(writer)?;
3485 let mut dropped_inbound_htlcs = 0;
3486 for htlc in self.pending_inbound_htlcs.iter() {
3487 if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3488 dropped_inbound_htlcs += 1;
3491 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3492 for htlc in self.pending_inbound_htlcs.iter() {
3493 htlc.htlc_id.write(writer)?;
3494 htlc.amount_msat.write(writer)?;
3495 htlc.cltv_expiry.write(writer)?;
3496 htlc.payment_hash.write(writer)?;
3498 &InboundHTLCState::RemoteAnnounced(_) => {}, // Drop
3499 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3501 htlc_state.write(writer)?;
3503 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3505 htlc_state.write(writer)?;
3507 &InboundHTLCState::Committed => {
3510 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3512 removal_reason.write(writer)?;
3517 macro_rules! write_option {
3520 &None => 0u8.write(writer)?,
3529 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3530 for htlc in self.pending_outbound_htlcs.iter() {
3531 htlc.htlc_id.write(writer)?;
3532 htlc.amount_msat.write(writer)?;
3533 htlc.cltv_expiry.write(writer)?;
3534 htlc.payment_hash.write(writer)?;
3535 htlc.source.write(writer)?;
3536 write_option!(htlc.fail_reason);
3538 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3540 onion_packet.write(writer)?;
3542 &OutboundHTLCState::Committed => {
3545 &OutboundHTLCState::RemoteRemoved => {
3548 &OutboundHTLCState::AwaitingRemoteRevokeToRemove => {
3551 &OutboundHTLCState::AwaitingRemovedRemoteRevoke => {
3557 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3558 for update in self.holding_cell_htlc_updates.iter() {
3560 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, time_created: _ } => {
3562 amount_msat.write(writer)?;
3563 cltv_expiry.write(writer)?;
3564 payment_hash.write(writer)?;
3565 source.write(writer)?;
3566 onion_routing_packet.write(writer)?;
3567 // time_created is not serialized - we re-init the timeout upon deserialization
3569 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3571 payment_preimage.write(writer)?;
3572 htlc_id.write(writer)?;
3574 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3576 htlc_id.write(writer)?;
3577 err_packet.write(writer)?;
3582 self.monitor_pending_revoke_and_ack.write(writer)?;
3583 self.monitor_pending_commitment_signed.write(writer)?;
3584 match self.monitor_pending_order {
3585 None => 0u8.write(writer)?,
3586 Some(RAACommitmentOrder::CommitmentFirst) => 1u8.write(writer)?,
3587 Some(RAACommitmentOrder::RevokeAndACKFirst) => 2u8.write(writer)?,
3590 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3591 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3592 pending_forward.write(writer)?;
3593 htlc_id.write(writer)?;
3596 (self.monitor_pending_failures.len() as u64).write(writer)?;
3597 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3598 htlc_source.write(writer)?;
3599 payment_hash.write(writer)?;
3600 fail_reason.write(writer)?;
3603 write_option!(self.pending_update_fee);
3604 write_option!(self.holding_cell_update_fee);
3606 self.next_local_htlc_id.write(writer)?;
3607 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3608 self.channel_update_count.write(writer)?;
3609 self.feerate_per_kw.write(writer)?;
3611 (self.last_local_commitment_txn.len() as u64).write(writer)?;
3612 for tx in self.last_local_commitment_txn.iter() {
3613 if let Err(e) = tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
3615 encode::Error::Io(e) => return Err(e),
3616 _ => panic!("last_local_commitment_txn must have been well-formed!"),
3621 match self.last_sent_closing_fee {
3622 Some((feerate, fee)) => {
3624 feerate.write(writer)?;
3627 None => 0u8.write(writer)?,
3630 write_option!(self.funding_tx_confirmed_in);
3631 write_option!(self.short_channel_id);
3633 self.last_block_connected.write(writer)?;
3634 self.funding_tx_confirmations.write(writer)?;
3636 self.their_dust_limit_satoshis.write(writer)?;
3637 self.our_dust_limit_satoshis.write(writer)?;
3638 self.their_max_htlc_value_in_flight_msat.write(writer)?;
3639 self.their_channel_reserve_satoshis.write(writer)?;
3640 self.their_htlc_minimum_msat.write(writer)?;
3641 self.our_htlc_minimum_msat.write(writer)?;
3642 self.their_to_self_delay.write(writer)?;
3643 self.their_max_accepted_htlcs.write(writer)?;
3644 self.minimum_depth.write(writer)?;
3646 write_option!(self.their_funding_pubkey);
3647 write_option!(self.their_revocation_basepoint);
3648 write_option!(self.their_payment_basepoint);
3649 write_option!(self.their_delayed_payment_basepoint);
3650 write_option!(self.their_htlc_basepoint);
3651 write_option!(self.their_cur_commitment_point);
3653 write_option!(self.their_prev_commitment_point);
3654 self.their_node_id.write(writer)?;
3656 write_option!(self.their_shutdown_scriptpubkey);
3658 self.channel_monitor.write_for_disk(writer)?;
3663 impl<R : ::std::io::Read> ReadableArgs<R, Arc<Logger>> for Channel {
3664 fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3665 let _ver: u8 = Readable::read(reader)?;
3666 let min_ver: u8 = Readable::read(reader)?;
3667 if min_ver > SERIALIZATION_VERSION {
3668 return Err(DecodeError::UnknownVersion);
3671 let user_id = Readable::read(reader)?;
3672 let config: ChannelConfig = Readable::read(reader)?;
3674 let channel_id = Readable::read(reader)?;
3675 let channel_state = Readable::read(reader)?;
3676 let channel_outbound = Readable::read(reader)?;
3677 let channel_value_satoshis = Readable::read(reader)?;
3679 let local_keys = Readable::read(reader)?;
3680 let shutdown_pubkey = Readable::read(reader)?;
3682 let cur_local_commitment_transaction_number = Readable::read(reader)?;
3683 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
3684 let value_to_self_msat = Readable::read(reader)?;
3686 let received_commitment_while_awaiting_raa = Readable::read(reader)?;
3688 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
3689 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3690 for _ in 0..pending_inbound_htlc_count {
3691 pending_inbound_htlcs.push(InboundHTLCOutput {
3692 htlc_id: Readable::read(reader)?,
3693 amount_msat: Readable::read(reader)?,
3694 cltv_expiry: Readable::read(reader)?,
3695 payment_hash: Readable::read(reader)?,
3696 state: match <u8 as Readable<R>>::read(reader)? {
3697 1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
3698 2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
3699 3 => InboundHTLCState::Committed,
3700 4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
3701 _ => return Err(DecodeError::InvalidValue),
3706 macro_rules! read_option { () => {
3707 match <u8 as Readable<R>>::read(reader)? {
3709 1 => Some(Readable::read(reader)?),
3710 _ => return Err(DecodeError::InvalidValue),
3714 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
3715 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
3716 for _ in 0..pending_outbound_htlc_count {
3717 pending_outbound_htlcs.push(OutboundHTLCOutput {
3718 htlc_id: Readable::read(reader)?,
3719 amount_msat: Readable::read(reader)?,
3720 cltv_expiry: Readable::read(reader)?,
3721 payment_hash: Readable::read(reader)?,
3722 source: Readable::read(reader)?,
3723 fail_reason: read_option!(),
3724 state: match <u8 as Readable<R>>::read(reader)? {
3725 0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
3726 1 => OutboundHTLCState::Committed,
3727 2 => OutboundHTLCState::RemoteRemoved,
3728 3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove,
3729 4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke,
3730 _ => return Err(DecodeError::InvalidValue),
3735 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
3736 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
3737 for _ in 0..holding_cell_htlc_update_count {
3738 holding_cell_htlc_updates.push(match <u8 as Readable<R>>::read(reader)? {
3739 0 => HTLCUpdateAwaitingACK::AddHTLC {
3740 amount_msat: Readable::read(reader)?,
3741 cltv_expiry: Readable::read(reader)?,
3742 payment_hash: Readable::read(reader)?,
3743 source: Readable::read(reader)?,
3744 onion_routing_packet: Readable::read(reader)?,
3745 time_created: Instant::now(),
3747 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
3748 payment_preimage: Readable::read(reader)?,
3749 htlc_id: Readable::read(reader)?,
3751 2 => HTLCUpdateAwaitingACK::FailHTLC {
3752 htlc_id: Readable::read(reader)?,
3753 err_packet: Readable::read(reader)?,
3755 _ => return Err(DecodeError::InvalidValue),
3759 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
3760 let monitor_pending_commitment_signed = Readable::read(reader)?;
3762 let monitor_pending_order = match <u8 as Readable<R>>::read(reader)? {
3764 1 => Some(RAACommitmentOrder::CommitmentFirst),
3765 2 => Some(RAACommitmentOrder::RevokeAndACKFirst),
3766 _ => return Err(DecodeError::InvalidValue),
3769 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
3770 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
3771 for _ in 0..monitor_pending_forwards_count {
3772 monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
3775 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
3776 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
3777 for _ in 0..monitor_pending_failures_count {
3778 monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
3781 let pending_update_fee = read_option!();
3782 let holding_cell_update_fee = read_option!();
3784 let next_local_htlc_id = Readable::read(reader)?;
3785 let next_remote_htlc_id = Readable::read(reader)?;
3786 let channel_update_count = Readable::read(reader)?;
3787 let feerate_per_kw = Readable::read(reader)?;
3789 let last_local_commitment_txn_count: u64 = Readable::read(reader)?;
3790 let mut last_local_commitment_txn = Vec::with_capacity(cmp::min(last_local_commitment_txn_count as usize, OUR_MAX_HTLCS as usize*2 + 1));
3791 for _ in 0..last_local_commitment_txn_count {
3792 last_local_commitment_txn.push(match Transaction::consensus_decode(reader.by_ref()) {
3794 Err(_) => return Err(DecodeError::InvalidValue),
3798 let last_sent_closing_fee = match <u8 as Readable<R>>::read(reader)? {
3800 1 => Some((Readable::read(reader)?, Readable::read(reader)?)),
3801 _ => return Err(DecodeError::InvalidValue),
3804 let funding_tx_confirmed_in = read_option!();
3805 let short_channel_id = read_option!();
3807 let last_block_connected = Readable::read(reader)?;
3808 let funding_tx_confirmations = Readable::read(reader)?;
3810 let their_dust_limit_satoshis = Readable::read(reader)?;
3811 let our_dust_limit_satoshis = Readable::read(reader)?;
3812 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
3813 let their_channel_reserve_satoshis = Readable::read(reader)?;
3814 let their_htlc_minimum_msat = Readable::read(reader)?;
3815 let our_htlc_minimum_msat = Readable::read(reader)?;
3816 let their_to_self_delay = Readable::read(reader)?;
3817 let their_max_accepted_htlcs = Readable::read(reader)?;
3818 let minimum_depth = Readable::read(reader)?;
3820 let their_funding_pubkey = read_option!();
3821 let their_revocation_basepoint = read_option!();
3822 let their_payment_basepoint = read_option!();
3823 let their_delayed_payment_basepoint = read_option!();
3824 let their_htlc_basepoint = read_option!();
3825 let their_cur_commitment_point = read_option!();
3827 let their_prev_commitment_point = read_option!();
3828 let their_node_id = Readable::read(reader)?;
3830 let their_shutdown_scriptpubkey = read_option!();
3831 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
3832 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
3833 // doing full block connection operations on the internal CHannelMonitor copies
3834 if monitor_last_block != last_block_connected {
3835 return Err(DecodeError::InvalidValue);
3845 secp_ctx: Secp256k1::new(),
3846 channel_value_satoshis,
3851 cur_local_commitment_transaction_number,
3852 cur_remote_commitment_transaction_number,
3855 received_commitment_while_awaiting_raa,
3856 pending_inbound_htlcs,
3857 pending_outbound_htlcs,
3858 holding_cell_htlc_updates,
3860 monitor_pending_revoke_and_ack,
3861 monitor_pending_commitment_signed,
3862 monitor_pending_order,
3863 monitor_pending_forwards,
3864 monitor_pending_failures,
3867 holding_cell_update_fee,
3869 next_remote_htlc_id,
3870 channel_update_count,
3873 #[cfg(debug_assertions)]
3874 max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
3875 #[cfg(debug_assertions)]
3876 max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
3878 last_local_commitment_txn,
3880 last_sent_closing_fee,
3882 funding_tx_confirmed_in,
3884 last_block_connected,
3885 funding_tx_confirmations,
3887 their_dust_limit_satoshis,
3888 our_dust_limit_satoshis,
3889 their_max_htlc_value_in_flight_msat,
3890 their_channel_reserve_satoshis,
3891 their_htlc_minimum_msat,
3892 our_htlc_minimum_msat,
3893 their_to_self_delay,
3894 their_max_accepted_htlcs,
3897 their_funding_pubkey,
3898 their_revocation_basepoint,
3899 their_payment_basepoint,
3900 their_delayed_payment_basepoint,
3901 their_htlc_basepoint,
3902 their_cur_commitment_point,
3904 their_prev_commitment_point,
3907 their_shutdown_scriptpubkey,
3918 use bitcoin::util::hash::{Sha256dHash, Hash160};
3919 use bitcoin::util::bip143;
3920 use bitcoin::consensus::encode::serialize;
3921 use bitcoin::blockdata::script::{Script, Builder};
3922 use bitcoin::blockdata::transaction::Transaction;
3923 use bitcoin::blockdata::opcodes;
3925 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
3926 use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
3927 use ln::channel::MAX_FUNDING_SATOSHIS;
3929 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
3930 use chain::keysinterface::KeysInterface;
3931 use chain::transaction::OutPoint;
3932 use util::config::UserConfig;
3933 use util::test_utils;
3934 use util::logger::Logger;
3935 use secp256k1::{Secp256k1,Message,Signature};
3936 use secp256k1::key::{SecretKey,PublicKey};
3937 use bitcoin_hashes::sha256::Hash as Sha256;
3938 use bitcoin_hashes::Hash;
3941 struct TestFeeEstimator {
3944 impl FeeEstimator for TestFeeEstimator {
3945 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
3951 fn test_max_funding_satoshis() {
3952 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
3953 "MAX_FUNDING_SATOSHIS is greater than all satoshis on existence");
3957 chan_keys: ChannelKeys,
3959 impl KeysInterface for Keys {
3960 fn get_node_secret(&self) -> SecretKey { panic!(); }
3961 fn get_destination_script(&self) -> Script {
3962 let secp_ctx = Secp256k1::signing_only();
3963 let channel_monitor_claim_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3964 let our_channel_monitor_claim_key_hash = Hash160::from_data(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
3965 Builder::new().push_opcode(opcodes::All::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
3968 fn get_shutdown_pubkey(&self) -> PublicKey {
3969 let secp_ctx = Secp256k1::signing_only();
3970 let channel_close_key = SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
3971 PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
3974 fn get_channel_keys(&self, _inbound: bool) -> ChannelKeys { self.chan_keys.clone() }
3975 fn get_session_key(&self) -> SecretKey { panic!(); }
3979 fn outbound_commitment_test() {
3980 // Test vectors from BOLT 3 Appendix C:
3981 let feeest = TestFeeEstimator{fee_est: 15000};
3982 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3983 let secp_ctx = Secp256k1::new();
3985 let chan_keys = ChannelKeys {
3986 funding_key: SecretKey::from_slice(&secp_ctx, &hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
3987 payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3988 delayed_payment_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
3989 htlc_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
3991 // These aren't set in the test vectors:
3992 revocation_base_key: SecretKey::from_slice(&secp_ctx, &hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
3993 commitment_seed: [0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff],
3995 assert_eq!(PublicKey::from_secret_key(&secp_ctx, &chan_keys.funding_key).serialize()[..],
3996 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
3997 let keys_provider: Arc<KeysInterface> = Arc::new(Keys { chan_keys });
3999 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &[42; 32]).unwrap());
4000 let mut config = UserConfig::new();
4001 config.channel_options.announced_channel = false;
4002 let mut chan = Channel::new_outbound(&feeest, &keys_provider, their_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap(); // Nothing uses their network key in this test
4003 chan.their_to_self_delay = 144;
4004 chan.our_dust_limit_satoshis = 546;
4006 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4007 chan.channel_monitor.set_funding_info((funding_info, Script::new()));
4009 chan.their_payment_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4010 assert_eq!(chan.their_payment_basepoint.unwrap().serialize()[..],
4011 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4013 chan.their_funding_pubkey = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13").unwrap()[..]).unwrap()));
4014 assert_eq!(chan.their_funding_pubkey.unwrap().serialize()[..],
4015 hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4017 chan.their_htlc_basepoint = Some(PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&secp_ctx, &hex::decode("4444444444444444444444444444444444444444444444444444444444444444").unwrap()[..]).unwrap()));
4018 assert_eq!(chan.their_htlc_basepoint.unwrap().serialize()[..],
4019 hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4021 chan.their_revocation_basepoint = Some(PublicKey::from_slice(&secp_ctx, &hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap());
4023 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4024 // derived from a commitment_seed, so instead we copy it here and call
4025 // build_commitment_transaction.
4026 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.delayed_payment_base_key);
4027 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4028 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4029 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, &chan.local_keys.htlc_base_key);
4030 let keys = TxCreationKeys::new(&secp_ctx, &per_commitment_point, &delayed_payment_base, &htlc_basepoint, &chan.their_revocation_basepoint.unwrap(), &chan.their_payment_basepoint.unwrap(), &chan.their_htlc_basepoint.unwrap()).unwrap();
4032 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4034 macro_rules! test_commitment {
4035 ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr) => {
4037 let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4038 let htlcs = res.2.drain(..)
4039 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4043 let their_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4044 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &chan.get_funding_redeemscript(), chan.channel_value_satoshis)[..]).unwrap();
4045 secp_ctx.verify(&sighash, &their_signature, &chan.their_funding_pubkey.unwrap()).unwrap();
4047 chan.sign_commitment_transaction(&mut unsigned_tx.0, &their_signature);
4049 assert_eq!(serialize(&unsigned_tx.0)[..],
4050 hex::decode($tx_hex).unwrap()[..]);
4054 macro_rules! test_htlc_output {
4055 ( $htlc_idx: expr, $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr ) => {
4056 let remote_signature = Signature::from_der(&secp_ctx, &hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4058 let ref htlc = unsigned_tx.1[$htlc_idx];
4059 let mut htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4060 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4061 let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4062 secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4064 let mut preimage: Option<PaymentPreimage> = None;
4067 let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4068 if out == htlc.payment_hash {
4069 preimage = Some(PaymentPreimage([i; 32]));
4073 assert!(preimage.is_some());
4076 chan.sign_htlc_transaction(&mut htlc_tx, &remote_signature, &preimage, &htlc, &keys).unwrap();
4077 assert_eq!(serialize(&htlc_tx)[..],
4078 hex::decode($tx_hex).unwrap()[..]);
4083 // simple commitment tx with no HTLCs
4084 chan.value_to_self_msat = 7000000000;
4086 test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4087 "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4088 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4091 chan.pending_inbound_htlcs.push({
4092 let mut out = InboundHTLCOutput{
4094 amount_msat: 1000000,
4096 payment_hash: PaymentHash([0; 32]),
4097 state: InboundHTLCState::Committed,
4099 out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4102 chan.pending_inbound_htlcs.push({
4103 let mut out = InboundHTLCOutput{
4105 amount_msat: 2000000,
4107 payment_hash: PaymentHash([0; 32]),
4108 state: InboundHTLCState::Committed,
4110 out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4113 chan.pending_outbound_htlcs.push({
4114 let mut out = OutboundHTLCOutput{
4116 amount_msat: 2000000,
4118 payment_hash: PaymentHash([0; 32]),
4119 state: OutboundHTLCState::Committed,
4120 source: HTLCSource::dummy(),
4123 out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4126 chan.pending_outbound_htlcs.push({
4127 let mut out = OutboundHTLCOutput{
4129 amount_msat: 3000000,
4131 payment_hash: PaymentHash([0; 32]),
4132 state: OutboundHTLCState::Committed,
4133 source: HTLCSource::dummy(),
4136 out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4139 chan.pending_inbound_htlcs.push({
4140 let mut out = InboundHTLCOutput{
4142 amount_msat: 4000000,
4144 payment_hash: PaymentHash([0; 32]),
4145 state: InboundHTLCState::Committed,
4147 out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4152 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4153 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4154 chan.feerate_per_kw = 0;
4156 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4157 "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4158 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4160 assert_eq!(unsigned_tx.1.len(), 5);
4162 test_htlc_output!(0,
4163 "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4164 "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4165 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4167 test_htlc_output!(1,
4168 "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4169 "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4170 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4172 test_htlc_output!(2,
4173 "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4174 "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4175 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4177 test_htlc_output!(3,
4178 "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4179 "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4180 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4182 test_htlc_output!(4,
4183 "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4184 "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4185 "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4189 // commitment tx with seven outputs untrimmed (maximum feerate)
4190 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4191 chan.feerate_per_kw = 647;
4193 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4194 "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4195 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4197 assert_eq!(unsigned_tx.1.len(), 5);
4199 test_htlc_output!(0,
4200 "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4201 "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4202 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000");
4204 test_htlc_output!(1,
4205 "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4206 "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4207 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4209 test_htlc_output!(2,
4210 "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4211 "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4212 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4214 test_htlc_output!(3,
4215 "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4216 "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4217 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4219 test_htlc_output!(4,
4220 "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4221 "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4222 "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4226 // commitment tx with six outputs untrimmed (minimum feerate)
4227 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4228 chan.feerate_per_kw = 648;
4230 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4231 "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4232 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4234 assert_eq!(unsigned_tx.1.len(), 4);
4236 test_htlc_output!(0,
4237 "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4238 "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4239 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4241 test_htlc_output!(1,
4242 "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4243 "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4244 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4246 test_htlc_output!(2,
4247 "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4248 "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4249 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4251 test_htlc_output!(3,
4252 "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4253 "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4254 "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4258 // commitment tx with six outputs untrimmed (maximum feerate)
4259 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4260 chan.feerate_per_kw = 2069;
4262 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4263 "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4264 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4266 assert_eq!(unsigned_tx.1.len(), 4);
4268 test_htlc_output!(0,
4269 "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4270 "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4271 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4273 test_htlc_output!(1,
4274 "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4275 "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4276 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000");
4278 test_htlc_output!(2,
4279 "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4280 "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4281 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4283 test_htlc_output!(3,
4284 "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4285 "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4286 "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4290 // commitment tx with five outputs untrimmed (minimum feerate)
4291 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4292 chan.feerate_per_kw = 2070;
4294 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4295 "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4296 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4298 assert_eq!(unsigned_tx.1.len(), 3);
4300 test_htlc_output!(0,
4301 "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4302 "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4303 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4305 test_htlc_output!(1,
4306 "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4307 "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4308 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4310 test_htlc_output!(2,
4311 "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4312 "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4313 "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4317 // commitment tx with five outputs untrimmed (maximum feerate)
4318 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4319 chan.feerate_per_kw = 2194;
4321 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4322 "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4323 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4325 assert_eq!(unsigned_tx.1.len(), 3);
4327 test_htlc_output!(0,
4328 "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4329 "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4330 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000");
4332 test_htlc_output!(1,
4333 "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4334 "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4335 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4337 test_htlc_output!(2,
4338 "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4339 "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4340 "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4344 // commitment tx with four outputs untrimmed (minimum feerate)
4345 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4346 chan.feerate_per_kw = 2195;
4348 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4349 "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4350 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4352 assert_eq!(unsigned_tx.1.len(), 2);
4354 test_htlc_output!(0,
4355 "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4356 "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4357 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4359 test_htlc_output!(1,
4360 "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4361 "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4362 "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4366 // commitment tx with four outputs untrimmed (maximum feerate)
4367 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4368 chan.feerate_per_kw = 3702;
4370 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4371 "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4372 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4374 assert_eq!(unsigned_tx.1.len(), 2);
4376 test_htlc_output!(0,
4377 "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4378 "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4379 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000");
4381 test_htlc_output!(1,
4382 "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4383 "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4384 "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4388 // commitment tx with three outputs untrimmed (minimum feerate)
4389 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4390 chan.feerate_per_kw = 3703;
4392 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4393 "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4394 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4396 assert_eq!(unsigned_tx.1.len(), 1);
4398 test_htlc_output!(0,
4399 "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4400 "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4401 "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4405 // commitment tx with three outputs untrimmed (maximum feerate)
4406 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4407 chan.feerate_per_kw = 4914;
4409 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4410 "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4411 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4413 assert_eq!(unsigned_tx.1.len(), 1);
4415 test_htlc_output!(0,
4416 "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4417 "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4418 "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000");
4422 // commitment tx with two outputs untrimmed (minimum feerate)
4423 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4424 chan.feerate_per_kw = 4915;
4426 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4427 "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4428 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4430 assert_eq!(unsigned_tx.1.len(), 0);
4434 // commitment tx with two outputs untrimmed (maximum feerate)
4435 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4436 chan.feerate_per_kw = 9651180;
4438 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4439 "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4440 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4442 assert_eq!(unsigned_tx.1.len(), 0);
4446 // commitment tx with one output untrimmed (minimum feerate)
4447 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4448 chan.feerate_per_kw = 9651181;
4450 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4451 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4452 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4454 assert_eq!(unsigned_tx.1.len(), 0);
4458 // commitment tx with fee greater than funder amount
4459 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4460 chan.feerate_per_kw = 9651936;
4462 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4463 "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4464 "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220");
4466 assert_eq!(unsigned_tx.1.len(), 0);
4471 fn test_per_commitment_secret_gen() {
4472 // Test vectors from BOLT 3 Appendix D:
4474 let mut seed = [0; 32];
4475 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4476 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4477 hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4479 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4480 assert_eq!(chan_utils::build_commitment_secret(seed, 281474976710655),
4481 hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4483 assert_eq!(chan_utils::build_commitment_secret(seed, 0xaaaaaaaaaaa),
4484 hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4486 assert_eq!(chan_utils::build_commitment_secret(seed, 0x555555555555),
4487 hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4489 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4490 assert_eq!(chan_utils::build_commitment_secret(seed, 1),
4491 hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4495 fn test_key_derivation() {
4496 // Test vectors from BOLT 3 Appendix E:
4497 let secp_ctx = Secp256k1::new();
4499 let base_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4500 let per_commitment_secret = SecretKey::from_slice(&secp_ctx, &hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4502 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4503 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4505 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4506 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4508 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4509 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4511 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4512 SecretKey::from_slice(&secp_ctx, &hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4514 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4515 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4517 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4518 SecretKey::from_slice(&secp_ctx, &hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());