_ Git - rust-lightning/blob - lightning/src/ln/channel.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 use bitcoin::blockdata::block::BlockHeader;
  11 use bitcoin::blockdata::script::{Script,Builder};
  12 use bitcoin::blockdata::transaction::{TxIn, TxOut, Transaction, SigHashType};
  13 use bitcoin::blockdata::opcodes;
  14 use bitcoin::util::hash::BitcoinHash;
  15 use bitcoin::util::bip143;
  16 use bitcoin::consensus::encode;
  17
  18 use bitcoin::hashes::{Hash, HashEngine};
  19 use bitcoin::hashes::sha256::Hash as Sha256;
  20 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  21
  22 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  23 use bitcoin::secp256k1::{Secp256k1,Signature};
  24 use bitcoin::secp256k1;
  25
  26 use ln::features::{ChannelFeatures, InitFeatures};
  27 use ln::msgs;
  28 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
  29 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER};
  30 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
  31 use ln::chan_utils::{CounterpartyCommitmentSecrets, LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys, PreCalculatedTxCreationKeys};
  32 use ln::chan_utils;
  33 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
  34 use chain::transaction::OutPoint;
  35 use chain::keysinterface::{ChannelKeys, KeysInterface};
  36 use util::transaction_utils;
  37 use util::ser::{Readable, Writeable, Writer};
  38 use util::logger::Logger;
  39 use util::errors::APIError;
  40 use util::config::{UserConfig,ChannelConfig};
  41
  42 use std;
  43 use std::default::Default;
  44 use std::{cmp,mem,fmt};
  45 use std::ops::Deref;
  46 use bitcoin::hashes::hex::ToHex;
  47
  48 #[cfg(test)]
  49 pub struct ChannelValueStat {
  50         pub value_to_self_msat: u64,
  51         pub channel_value_msat: u64,
  52         pub channel_reserve_msat: u64,
  53         pub pending_outbound_htlcs_amount_msat: u64,
  54         pub pending_inbound_htlcs_amount_msat: u64,
  55         pub holding_cell_outbound_amount_msat: u64,
  56         pub their_max_htlc_value_in_flight_msat: u64, // outgoing
  57         pub their_dust_limit_msat: u64,
  58 }
  59
  60 enum InboundHTLCRemovalReason {
  61         FailRelay(msgs::OnionErrorPacket),
  62         FailMalformed(([u8; 32], u16)),
  63         Fulfill(PaymentPreimage),
  64 }
  65
  66 enum InboundHTLCState {
  67         /// Offered by remote, to be included in next local commitment tx. I.e., the remote sent an
  68         /// update_add_htlc message for this HTLC.
  69         RemoteAnnounced(PendingHTLCStatus),
  70         /// Included in a received commitment_signed message (implying we've
  71         /// revoke_and_ack'd it), but the remote hasn't yet revoked their previous
  72         /// state (see the example below). We have not yet included this HTLC in a
  73         /// commitment_signed message because we are waiting on the remote's
  74         /// aforementioned state revocation. One reason this missing remote RAA
  75         /// (revoke_and_ack) blocks us from constructing a commitment_signed message
  76         /// is because every time we create a new "state", i.e. every time we sign a
  77         /// new commitment tx (see [BOLT #2]), we need a new per_commitment_point,
  78         /// which are provided one-at-a-time in each RAA. E.g., the last RAA they
  79         /// sent provided the per_commitment_point for our current commitment tx.
  80         /// The other reason we should not send a commitment_signed without their RAA
  81         /// is because their RAA serves to ACK our previous commitment_signed.
  82         ///
  83         /// Here's an example of how an HTLC could come to be in this state:
  84         /// remote --> update_add_htlc(prev_htlc)   --> local
  85         /// remote --> commitment_signed(prev_htlc) --> local
  86         /// remote <-- revoke_and_ack               <-- local
  87         /// remote <-- commitment_signed(prev_htlc) <-- local
  88         /// [note that here, the remote does not respond with a RAA]
  89         /// remote --> update_add_htlc(this_htlc)   --> local
  90         /// remote --> commitment_signed(prev_htlc, this_htlc) --> local
  91         /// Now `this_htlc` will be assigned this state. It's unable to be officially
  92         /// accepted, i.e. included in a commitment_signed, because we're missing the
  93         /// RAA that provides our next per_commitment_point. The per_commitment_point
  94         /// is used to derive commitment keys, which are used to construct the
  95         /// signatures in a commitment_signed message.
  96         /// Implies AwaitingRemoteRevoke.
  97         /// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
  98         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
  99         /// Included in a received commitment_signed message (implying we've revoke_and_ack'd it).
 100         /// We have also included this HTLC in our latest commitment_signed and are now just waiting
 101         /// on the remote's revoke_and_ack to make this HTLC an irrevocable part of the state of the
 102         /// channel (before it can then get forwarded and/or removed).
 103         /// Implies AwaitingRemoteRevoke.
 104         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
 105         Committed,
 106         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
 107         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
 108         /// we'll drop it.
 109         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
 110         /// commitment transaction without it as otherwise we'll have to force-close the channel to
 111         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
 112         /// anyway). That said, ChannelMonitor does this for us (see
 113         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
 114         /// local state before then, once we're sure that the next commitment_signed and
 115         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
 116         LocalRemoved(InboundHTLCRemovalReason),
 117 }
 118
 119 struct InboundHTLCOutput {
 120         htlc_id: u64,
 121         amount_msat: u64,
 122         cltv_expiry: u32,
 123         payment_hash: PaymentHash,
 124         state: InboundHTLCState,
 125 }
 126
 127 enum OutboundHTLCState {
 128         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
 129         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
 130         /// we will promote to Committed (note that they may not accept it until the next time we
 131         /// revoke, but we don't really care about that:
 132         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
 133         ///    money back (though we won't), and,
 134         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
 135         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
 136         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
 137         ///    we'll never get out of sync).
 138         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
 139         /// OutboundHTLCOutput's size just for a temporary bit
 140         LocalAnnounced(Box<msgs::OnionPacket>),
 141         Committed,
 142         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
 143         /// the change (though they'll need to revoke before we fail the payment).
 144         RemoteRemoved(Option<HTLCFailReason>),
 145         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 146         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 147         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 148         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
 149         /// remote revoke_and_ack on a previous state before we can do so.
 150         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
 151         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 152         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 153         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 154         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
 155         /// revoke_and_ack to drop completely.
 156         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
 157 }
 158
 159 struct OutboundHTLCOutput {
 160         htlc_id: u64,
 161         amount_msat: u64,
 162         cltv_expiry: u32,
 163         payment_hash: PaymentHash,
 164         state: OutboundHTLCState,
 165         source: HTLCSource,
 166 }
 167
 168 /// See AwaitingRemoteRevoke ChannelState for more info
 169 enum HTLCUpdateAwaitingACK {
 170         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
 171                 // always outbound
 172                 amount_msat: u64,
 173                 cltv_expiry: u32,
 174                 payment_hash: PaymentHash,
 175                 source: HTLCSource,
 176                 onion_routing_packet: msgs::OnionPacket,
 177         },
 178         ClaimHTLC {
 179                 payment_preimage: PaymentPreimage,
 180                 htlc_id: u64,
 181         },
 182         FailHTLC {
 183                 htlc_id: u64,
 184                 err_packet: msgs::OnionErrorPacket,
 185         },
 186 }
 187
 188 /// There are a few "states" and then a number of flags which can be applied:
 189 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
 190 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
 191 /// move on to ChannelFunded.
 192 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
 193 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
 194 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
 195 enum ChannelState {
 196         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
 197         OurInitSent = 1 << 0,
 198         /// Implies we have received their open_channel/accept_channel message
 199         TheirInitSent = 1 << 1,
 200         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
 201         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
 202         /// upon receipt of funding_created, so simply skip this state.
 203         FundingCreated = 4,
 204         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
 205         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
 206         /// and our counterparty consider the funding transaction confirmed.
 207         FundingSent = 8,
 208         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
 209         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 210         TheirFundingLocked = 1 << 4,
 211         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
 212         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 213         OurFundingLocked = 1 << 5,
 214         ChannelFunded = 64,
 215         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
 216         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
 217         /// dance.
 218         PeerDisconnected = 1 << 7,
 219         /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
 220         /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
 221         /// outbound messages until they've managed to do so.
 222         MonitorUpdateFailed = 1 << 8,
 223         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
 224         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
 225         /// messages as then we will be unable to determine which HTLCs they included in their
 226         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
 227         /// later.
 228         /// Flag is set on ChannelFunded.
 229         AwaitingRemoteRevoke = 1 << 9,
 230         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
 231         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
 232         /// to respond with our own shutdown message when possible.
 233         RemoteShutdownSent = 1 << 10,
 234         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
 235         /// point, we may not add any new HTLCs to the channel.
 236         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
 237         /// us their shutdown.
 238         LocalShutdownSent = 1 << 11,
 239         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
 240         /// to drop us, but we store this anyway.
 241         ShutdownComplete = 4096,
 242 }
 243 const BOTH_SIDES_SHUTDOWN_MASK: u32 = ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32;
 244 const MULTI_STATE_FLAGS: u32 = BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32;
 245
 246 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
 247
 248 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
 249 /// If channel is public, network should have a liveness view announced by us on a
 250 /// best-effort, which means we may filter out some status transitions to avoid spam.
 251 /// See further timer_chan_freshness_every_min.
 252 #[derive(PartialEq)]
 253 enum UpdateStatus {
 254         /// Status has been gossiped.
 255         Fresh,
 256         /// Status has been changed.
 257         DisabledMarked,
 258         /// Status has been marked to be gossiped at next flush
 259         DisabledStaged,
 260 }
 261
 262 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
 263 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
 264 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
 265 // inbound channel.
 266 pub(super) struct Channel<ChanSigner: ChannelKeys> {
 267         config: ChannelConfig,
 268
 269         user_id: u64,
 270
 271         channel_id: [u8; 32],
 272         channel_state: u32,
 273         channel_outbound: bool,
 274         secp_ctx: Secp256k1<secp256k1::All>,
 275         channel_value_satoshis: u64,
 276
 277         latest_monitor_update_id: u64,
 278
 279         #[cfg(not(test))]
 280         local_keys: ChanSigner,
 281         #[cfg(test)]
 282         pub(super) local_keys: ChanSigner,
 283         shutdown_pubkey: PublicKey,
 284         destination_script: Script,
 285
 286         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
 287         // generation start at 0 and count up...this simplifies some parts of implementation at the
 288         // cost of others, but should really just be changed.
 289
 290         cur_local_commitment_transaction_number: u64,
 291         cur_remote_commitment_transaction_number: u64,
 292         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
 293         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
 294         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
 295         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
 296
 297         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
 298         /// need to ensure we resend them in the order we originally generated them. Note that because
 299         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
 300         /// sufficient to simply set this to the opposite of any message we are generating as we
 301         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
 302         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
 303         /// send it first.
 304         resend_order: RAACommitmentOrder,
 305
 306         monitor_pending_funding_locked: bool,
 307         monitor_pending_revoke_and_ack: bool,
 308         monitor_pending_commitment_signed: bool,
 309         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
 310         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
 311
 312         // pending_update_fee is filled when sending and receiving update_fee
 313         // For outbound channel, feerate_per_kw is updated with the value from
 314         // pending_update_fee when revoke_and_ack is received
 315         //
 316         // For inbound channel, feerate_per_kw is updated when it receives
 317         // commitment_signed and revoke_and_ack is generated
 318         // The pending value is kept when another pair of update_fee and commitment_signed
 319         // is received during AwaitingRemoteRevoke and relieved when the expected
 320         // revoke_and_ack is received and new commitment_signed is generated to be
 321         // sent to the funder. Otherwise, the pending value is removed when receiving
 322         // commitment_signed.
 323         pending_update_fee: Option<u32>,
 324         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
 325         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
 326         // is received. holding_cell_update_fee is updated when there are additional
 327         // update_fee() during ChannelState::AwaitingRemoteRevoke.
 328         holding_cell_update_fee: Option<u32>,
 329         next_local_htlc_id: u64,
 330         next_remote_htlc_id: u64,
 331         update_time_counter: u32,
 332         feerate_per_kw: u32,
 333
 334         #[cfg(debug_assertions)]
 335         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
 336         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
 337         #[cfg(debug_assertions)]
 338         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
 339         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
 340
 341         last_sent_closing_fee: Option<(u32, u64, Signature)>, // (feerate, fee, our_sig)
 342
 343         funding_txo: Option<OutPoint>,
 344
 345         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
 346         /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
 347         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
 348         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
 349         funding_tx_confirmed_in: Option<BlockHash>,
 350         short_channel_id: Option<u64>,
 351         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
 352         /// ChannelManager deserialization (hence pub(super))
 353         pub(super) last_block_connected: BlockHash,
 354         funding_tx_confirmations: u64,
 355
 356         their_dust_limit_satoshis: u64,
 357         #[cfg(test)]
 358         pub(super) our_dust_limit_satoshis: u64,
 359         #[cfg(not(test))]
 360         our_dust_limit_satoshis: u64,
 361         #[cfg(test)]
 362         pub(super) their_max_htlc_value_in_flight_msat: u64,
 363         #[cfg(not(test))]
 364         their_max_htlc_value_in_flight_msat: u64,
 365         //get_our_max_htlc_value_in_flight_msat(): u64,
 366         /// minimum channel reserve for self to maintain - set by them.
 367         local_channel_reserve_satoshis: u64,
 368         // get_remote_channel_reserve_satoshis(channel_value_sats: u64): u64
 369         their_htlc_minimum_msat: u64,
 370         our_htlc_minimum_msat: u64,
 371         their_to_self_delay: u16,
 372         our_to_self_delay: u16,
 373         #[cfg(test)]
 374         pub their_max_accepted_htlcs: u16,
 375         #[cfg(not(test))]
 376         their_max_accepted_htlcs: u16,
 377         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
 378         minimum_depth: u32,
 379
 380         their_pubkeys: Option<ChannelPublicKeys>,
 381
 382         their_cur_commitment_point: Option<PublicKey>,
 383
 384         their_prev_commitment_point: Option<PublicKey>,
 385         their_node_id: PublicKey,
 386
 387         their_shutdown_scriptpubkey: Option<Script>,
 388
 389         commitment_secrets: CounterpartyCommitmentSecrets,
 390
 391         network_sync: UpdateStatus,
 392 }
 393
 394 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
 395 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
 396 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
 397 /// really allow for this, so instead we're stuck closing it out at that point.
 398 const UNCONF_THRESHOLD: u32 = 6;
 399 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
 400 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?)
 401
 402 #[cfg(not(test))]
 403 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 404 #[cfg(test)]
 405 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 406 #[cfg(not(test))]
 407 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 408 #[cfg(test)]
 409 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 410
 411 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
 412 /// it's 2^24.
 413 pub const MAX_FUNDING_SATOSHIS: u64 = 1 << 24;
 414
 415 /// Used to return a simple Error back to ChannelManager. Will get converted to a
 416 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
 417 /// channel_id in ChannelManager.
 418 pub(super) enum ChannelError {
 419         Ignore(String),
 420         Close(String),
 421         CloseDelayBroadcast(String),
 422 }
 423
 424 impl fmt::Debug for ChannelError {
 425         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 426                 match self {
 427                         &ChannelError::Ignore(ref e) => write!(f, "Ignore : {}", e),
 428                         &ChannelError::Close(ref e) => write!(f, "Close : {}", e),
 429                         &ChannelError::CloseDelayBroadcast(ref e) => write!(f, "CloseDelayBroadcast : {}", e)
 430                 }
 431         }
 432 }
 433
 434 macro_rules! secp_check {
 435         ($res: expr, $err: expr) => {
 436                 match $res {
 437                         Ok(thing) => thing,
 438                         Err(_) => return Err(ChannelError::Close($err)),
 439                 }
 440         };
 441 }
 442
 443 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 444         // Convert constants + channel value to limits:
 445         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
 446                 channel_value_satoshis * 1000 / 10 //TODO
 447         }
 448
 449         /// Returns a minimum channel reserve value the remote needs to maintain,
 450         /// required by us.
 451         ///
 452         /// Guaranteed to return a value no larger than channel_value_satoshis
 453         pub(crate) fn get_remote_channel_reserve_satoshis(channel_value_satoshis: u64) -> u64 {
 454                 let (q, _) = channel_value_satoshis.overflowing_div(100);
 455                 cmp::min(channel_value_satoshis, cmp::max(q, 1000)) //TODO
 456         }
 457
 458         fn derive_our_dust_limit_satoshis(at_open_background_feerate: u32) -> u64 {
 459                 cmp::max(at_open_background_feerate as u64 * B_OUTPUT_PLUS_SPENDING_INPUT_WEIGHT / 1000, 546) //TODO
 460         }
 461
 462         // Constructors:
 463         pub fn new_outbound<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, APIError>
 464         where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
 465               F::Target: FeeEstimator,
 466         {
 467                 let our_to_self_delay = config.own_channel_config.our_to_self_delay;
 468                 let chan_keys = keys_provider.get_channel_keys(false, channel_value_satoshis);
 469
 470                 if channel_value_satoshis >= MAX_FUNDING_SATOSHIS {
 471                         return Err(APIError::APIMisuseError{err: format!("funding_value must be smaller than {}, it was {}", MAX_FUNDING_SATOSHIS, channel_value_satoshis)});
 472                 }
 473                 let channel_value_msat = channel_value_satoshis * 1000;
 474                 if push_msat > channel_value_msat {
 475                         return Err(APIError::APIMisuseError { err: format!("Push value ({}) was larger than channel_value ({})", push_msat, channel_value_msat) });
 476                 }
 477                 if our_to_self_delay < BREAKDOWN_TIMEOUT {
 478                         return Err(APIError::APIMisuseError {err: format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks", our_to_self_delay)});
 479                 }
 480                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 481                 if Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(channel_value_satoshis) < Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate) {
 482                         return Err(APIError::FeeRateTooHigh{err: format!("Not enough reserve above dust limit can be found at current fee rate({})", background_feerate), feerate: background_feerate});
 483                 }
 484
 485                 let feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
 486
 487                 Ok(Channel {
 488                         user_id: user_id,
 489                         config: config.channel_options.clone(),
 490
 491                         channel_id: keys_provider.get_secure_random_bytes(),
 492                         channel_state: ChannelState::OurInitSent as u32,
 493                         channel_outbound: true,
 494                         secp_ctx: Secp256k1::new(),
 495                         channel_value_satoshis: channel_value_satoshis,
 496
 497                         latest_monitor_update_id: 0,
 498
 499                         local_keys: chan_keys,
 500                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
 501                         destination_script: keys_provider.get_destination_script(),
 502
 503                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 504                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 505                         value_to_self_msat: channel_value_satoshis * 1000 - push_msat,
 506
 507                         pending_inbound_htlcs: Vec::new(),
 508                         pending_outbound_htlcs: Vec::new(),
 509                         holding_cell_htlc_updates: Vec::new(),
 510                         pending_update_fee: None,
 511                         holding_cell_update_fee: None,
 512                         next_local_htlc_id: 0,
 513                         next_remote_htlc_id: 0,
 514                         update_time_counter: 1,
 515
 516                         resend_order: RAACommitmentOrder::CommitmentFirst,
 517
 518                         monitor_pending_funding_locked: false,
 519                         monitor_pending_revoke_and_ack: false,
 520                         monitor_pending_commitment_signed: false,
 521                         monitor_pending_forwards: Vec::new(),
 522                         monitor_pending_failures: Vec::new(),
 523
 524                         #[cfg(debug_assertions)]
 525                         max_commitment_tx_output_local: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
 526                         #[cfg(debug_assertions)]
 527                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((channel_value_satoshis * 1000 - push_msat, push_msat)),
 528
 529                         last_sent_closing_fee: None,
 530
 531                         funding_txo: None,
 532                         funding_tx_confirmed_in: None,
 533                         short_channel_id: None,
 534                         last_block_connected: Default::default(),
 535                         funding_tx_confirmations: 0,
 536
 537                         feerate_per_kw: feerate,
 538                         their_dust_limit_satoshis: 0,
 539                         our_dust_limit_satoshis: Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate),
 540                         their_max_htlc_value_in_flight_msat: 0,
 541                         local_channel_reserve_satoshis: 0,
 542                         their_htlc_minimum_msat: 0,
 543                         our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
 544                         their_to_self_delay: 0,
 545                         our_to_self_delay,
 546                         their_max_accepted_htlcs: 0,
 547                         minimum_depth: 0, // Filled in in accept_channel
 548
 549                         their_pubkeys: None,
 550                         their_cur_commitment_point: None,
 551
 552                         their_prev_commitment_point: None,
 553                         their_node_id: their_node_id,
 554
 555                         their_shutdown_scriptpubkey: None,
 556
 557                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
 558
 559                         network_sync: UpdateStatus::Fresh,
 560                 })
 561         }
 562
 563         fn check_remote_fee<F: Deref>(fee_estimator: &F, feerate_per_kw: u32) -> Result<(), ChannelError>
 564                 where F::Target: FeeEstimator
 565         {
 566                 let lower_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 567                 if feerate_per_kw < lower_limit {
 568                         return Err(ChannelError::Close(format!("Peer's feerate much too low. Actual: {}. Our expected lower limit: {}", feerate_per_kw, lower_limit)));
 569                 }
 570                 let upper_limit = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) as u64  * 2;
 571                 if feerate_per_kw as u64 > upper_limit {
 572                         return Err(ChannelError::Close(format!("Peer's feerate much too high. Actual: {}. Our expected upper limit: {}", feerate_per_kw, upper_limit)));
 573                 }
 574                 Ok(())
 575         }
 576
 577         /// Creates a new channel from a remote sides' request for one.
 578         /// Assumes chain_hash has already been checked and corresponds with what we expect!
 579         pub fn new_from_req<K: Deref, F: Deref>(fee_estimator: &F, keys_provider: &K, their_node_id: PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel, user_id: u64, config: &UserConfig) -> Result<Channel<ChanSigner>, ChannelError>
 580                 where K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
 581           F::Target: FeeEstimator
 582         {
 583                 let mut chan_keys = keys_provider.get_channel_keys(true, msg.funding_satoshis);
 584                 let their_pubkeys = ChannelPublicKeys {
 585                         funding_pubkey: msg.funding_pubkey,
 586                         revocation_basepoint: msg.revocation_basepoint,
 587                         payment_point: msg.payment_point,
 588                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
 589                         htlc_basepoint: msg.htlc_basepoint
 590                 };
 591                 chan_keys.on_accept(&their_pubkeys, msg.to_self_delay, config.own_channel_config.our_to_self_delay);
 592                 let mut local_config = (*config).channel_options.clone();
 593
 594                 if config.own_channel_config.our_to_self_delay < BREAKDOWN_TIMEOUT {
 595                         return Err(ChannelError::Close(format!("Configured with an unreasonable our_to_self_delay ({}) putting user funds at risks. It must be greater than {}", config.own_channel_config.our_to_self_delay, BREAKDOWN_TIMEOUT)));
 596                 }
 597
 598                 // Check sanity of message fields:
 599                 if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS {
 600                         return Err(ChannelError::Close(format!("Funding must be smaller than {}. It was {}", MAX_FUNDING_SATOSHIS, msg.funding_satoshis)));
 601                 }
 602                 if msg.channel_reserve_satoshis > msg.funding_satoshis {
 603                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must be not greater than funding_satoshis: {}", msg.channel_reserve_satoshis, msg.funding_satoshis)));
 604                 }
 605                 let funding_value = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
 606                 if msg.push_msat > funding_value {
 607                         return Err(ChannelError::Close(format!("push_msat {} was larger than funding value {}", msg.push_msat, funding_value)));
 608                 }
 609                 if msg.dust_limit_satoshis > msg.funding_satoshis {
 610                         return Err(ChannelError::Close(format!("dust_limit_satoshis {} was larger than funding_satoshis {}. Peer never wants payout outputs?", msg.dust_limit_satoshis, msg.funding_satoshis)));
 611                 }
 612                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
 613                         return Err(ChannelError::Close(format!("Bogus; channel reserve ({}) is less than dust limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
 614                 }
 615                 let full_channel_value_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000;
 616                 if msg.htlc_minimum_msat >= full_channel_value_msat {
 617                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) was larger than full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
 618                 }
 619                 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
 620
 621                 let max_to_self_delay = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
 622                 if msg.to_self_delay > max_to_self_delay {
 623                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_to_self_delay, msg.to_self_delay)));
 624                 }
 625                 if msg.max_accepted_htlcs < 1 {
 626                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
 627                 }
 628                 if msg.max_accepted_htlcs > 483 {
 629                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than 483", msg.max_accepted_htlcs)));
 630                 }
 631
 632                 // Now check against optional parameters as set by config...
 633                 if msg.funding_satoshis < config.peer_channel_config_limits.min_funding_satoshis {
 634                         return Err(ChannelError::Close(format!("Funding satoshis ({}) is less than the user specified limit ({})", msg.funding_satoshis, config.peer_channel_config_limits.min_funding_satoshis)));
 635                 }
 636                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
 637                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat,  config.peer_channel_config_limits.max_htlc_minimum_msat)));
 638                 }
 639                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
 640                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
 641                 }
 642                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
 643                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
 644                 }
 645                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
 646                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
 647                 }
 648                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
 649                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.min_dust_limit_satoshis)));
 650                 }
 651                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
 652                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.max_dust_limit_satoshis)));
 653                 }
 654
 655                 // Convert things into internal flags and prep our state:
 656
 657                 let their_announce = if (msg.channel_flags & 1) == 1 { true } else { false };
 658                 if config.peer_channel_config_limits.force_announced_channel_preference {
 659                         if local_config.announced_channel != their_announce {
 660                                 return Err(ChannelError::Close("Peer tried to open channel but their announcement preference is different from ours".to_owned()));
 661                         }
 662                 }
 663                 // we either accept their preference or the preferences match
 664                 local_config.announced_channel = their_announce;
 665
 666                 let background_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
 667
 668                 let our_dust_limit_satoshis = Channel::<ChanSigner>::derive_our_dust_limit_satoshis(background_feerate);
 669                 let remote_channel_reserve_satoshis = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(msg.funding_satoshis);
 670                 if remote_channel_reserve_satoshis < our_dust_limit_satoshis {
 671                         return Err(ChannelError::Close(format!("Suitable channel reserve not found. remote_channel_reserve was ({}). our_dust_limit_satoshis is ({}).", remote_channel_reserve_satoshis, our_dust_limit_satoshis)));
 672                 }
 673                 if msg.channel_reserve_satoshis < our_dust_limit_satoshis {
 674                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is smaller than our dust limit ({})", msg.channel_reserve_satoshis, our_dust_limit_satoshis)));
 675                 }
 676                 if remote_channel_reserve_satoshis < msg.dust_limit_satoshis {
 677                         return Err(ChannelError::Close(format!("Dust limit ({}) too high for the channel reserve we require the remote to keep ({})", msg.dust_limit_satoshis, remote_channel_reserve_satoshis)));
 678                 }
 679
 680                 // check if the funder's amount for the initial commitment tx is sufficient
 681                 // for full fee payment
 682                 let funders_amount_msat = msg.funding_satoshis * 1000 - msg.push_msat;
 683                 let lower_limit = background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
 684                 if funders_amount_msat < lower_limit {
 685                         return Err(ChannelError::Close(format!("Insufficient funding amount ({}) for initial commitment. Must be at least {}", funders_amount_msat, lower_limit)));
 686                 }
 687
 688                 let to_local_msat = msg.push_msat;
 689                 let to_remote_msat = funders_amount_msat - background_feerate as u64 * COMMITMENT_TX_BASE_WEIGHT;
 690                 if to_local_msat <= msg.channel_reserve_satoshis * 1000 && to_remote_msat <= remote_channel_reserve_satoshis * 1000 {
 691                         return Err(ChannelError::Close("Insufficient funding amount for initial commitment".to_owned()));
 692                 }
 693
 694                 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
 695                         match &msg.shutdown_scriptpubkey {
 696                                 &OptionalField::Present(ref script) => {
 697                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
 698                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
 699                                                 Some(script.clone())
 700                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
 701                                         } else if script.len() == 0 {
 702                                                 None
 703                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
 704                                         } else {
 705                                                 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. script: ({})", script.to_bytes().to_hex())));
 706                                         }
 707                                 },
 708                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
 709                                 &OptionalField::Absent => {
 710                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
 711                                 }
 712                         }
 713                 } else { None };
 714
 715                 let chan = Channel {
 716                         user_id: user_id,
 717                         config: local_config,
 718
 719                         channel_id: msg.temporary_channel_id,
 720                         channel_state: (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32),
 721                         channel_outbound: false,
 722                         secp_ctx: Secp256k1::new(),
 723
 724                         latest_monitor_update_id: 0,
 725
 726                         local_keys: chan_keys,
 727                         shutdown_pubkey: keys_provider.get_shutdown_pubkey(),
 728                         destination_script: keys_provider.get_destination_script(),
 729
 730                         cur_local_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 731                         cur_remote_commitment_transaction_number: INITIAL_COMMITMENT_NUMBER,
 732                         value_to_self_msat: msg.push_msat,
 733
 734                         pending_inbound_htlcs: Vec::new(),
 735                         pending_outbound_htlcs: Vec::new(),
 736                         holding_cell_htlc_updates: Vec::new(),
 737                         pending_update_fee: None,
 738                         holding_cell_update_fee: None,
 739                         next_local_htlc_id: 0,
 740                         next_remote_htlc_id: 0,
 741                         update_time_counter: 1,
 742
 743                         resend_order: RAACommitmentOrder::CommitmentFirst,
 744
 745                         monitor_pending_funding_locked: false,
 746                         monitor_pending_revoke_and_ack: false,
 747                         monitor_pending_commitment_signed: false,
 748                         monitor_pending_forwards: Vec::new(),
 749                         monitor_pending_failures: Vec::new(),
 750
 751                         #[cfg(debug_assertions)]
 752                         max_commitment_tx_output_local: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
 753                         #[cfg(debug_assertions)]
 754                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((msg.push_msat, msg.funding_satoshis * 1000 - msg.push_msat)),
 755
 756                         last_sent_closing_fee: None,
 757
 758                         funding_txo: None,
 759                         funding_tx_confirmed_in: None,
 760                         short_channel_id: None,
 761                         last_block_connected: Default::default(),
 762                         funding_tx_confirmations: 0,
 763
 764                         feerate_per_kw: msg.feerate_per_kw,
 765                         channel_value_satoshis: msg.funding_satoshis,
 766                         their_dust_limit_satoshis: msg.dust_limit_satoshis,
 767                         our_dust_limit_satoshis: our_dust_limit_satoshis,
 768                         their_max_htlc_value_in_flight_msat: cmp::min(msg.max_htlc_value_in_flight_msat, msg.funding_satoshis * 1000),
 769                         local_channel_reserve_satoshis: msg.channel_reserve_satoshis,
 770                         their_htlc_minimum_msat: msg.htlc_minimum_msat,
 771                         our_htlc_minimum_msat: if config.own_channel_config.our_htlc_minimum_msat == 0 { 1 } else { config.own_channel_config.our_htlc_minimum_msat },
 772                         their_to_self_delay: msg.to_self_delay,
 773                         our_to_self_delay: config.own_channel_config.our_to_self_delay,
 774                         their_max_accepted_htlcs: msg.max_accepted_htlcs,
 775                         minimum_depth: config.own_channel_config.minimum_depth,
 776
 777                         their_pubkeys: Some(their_pubkeys),
 778                         their_cur_commitment_point: Some(msg.first_per_commitment_point),
 779
 780                         their_prev_commitment_point: None,
 781                         their_node_id: their_node_id,
 782
 783                         their_shutdown_scriptpubkey,
 784
 785                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
 786
 787                         network_sync: UpdateStatus::Fresh,
 788                 };
 789
 790                 Ok(chan)
 791         }
 792
 793         // Utilities to build transactions:
 794
 795         fn get_commitment_transaction_number_obscure_factor(&self) -> u64 {
 796                 let mut sha = Sha256::engine();
 797
 798                 let their_payment_point = &self.their_pubkeys.as_ref().unwrap().payment_point.serialize();
 799                 if self.channel_outbound {
 800                         sha.input(&self.local_keys.pubkeys().payment_point.serialize());
 801                         sha.input(their_payment_point);
 802                 } else {
 803                         sha.input(their_payment_point);
 804                         sha.input(&self.local_keys.pubkeys().payment_point.serialize());
 805                 }
 806                 let res = Sha256::from_engine(sha).into_inner();
 807
 808                 ((res[26] as u64) << 5*8) |
 809                 ((res[27] as u64) << 4*8) |
 810                 ((res[28] as u64) << 3*8) |
 811                 ((res[29] as u64) << 2*8) |
 812                 ((res[30] as u64) << 1*8) |
 813                 ((res[31] as u64) << 0*8)
 814         }
 815
 816         /// Transaction nomenclature is somewhat confusing here as there are many different cases - a
 817         /// transaction is referred to as "a's transaction" implying that a will be able to broadcast
 818         /// the transaction. Thus, b will generally be sending a signature over such a transaction to
 819         /// a, and a can revoke the transaction by providing b the relevant per_commitment_secret. As
 820         /// such, a transaction is generally the result of b increasing the amount paid to a (or adding
 821         /// an HTLC to a).
 822         /// @local is used only to convert relevant internal structures which refer to remote vs local
 823         /// to decide value of outputs and direction of HTLCs.
 824         /// @generated_by_local is used to determine *which* HTLCs to include - noting that the HTLC
 825         /// state may indicate that one peer has informed the other that they'd like to add an HTLC but
 826         /// have not yet committed it. Such HTLCs will only be included in transactions which are being
 827         /// generated by the peer which proposed adding the HTLCs, and thus we need to understand both
 828         /// which peer generated this transaction and "to whom" this transaction flows.
 829         /// Returns (the transaction built, the number of HTLC outputs which were present in the
 830         /// transaction, the list of HTLCs which were not ignored when building the transaction).
 831         /// Note that below-dust HTLCs are included in the third return value, but not the second, and
 832         /// sources are provided only for outbound HTLCs in the third return value.
 833         #[inline]
 834         fn build_commitment_transaction<L: Deref>(&self, commitment_number: u64, keys: &TxCreationKeys, local: bool, generated_by_local: bool, feerate_per_kw: u32, logger: &L) -> (Transaction, usize, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>) where L::Target: Logger {
 835                 let obscured_commitment_transaction_number = self.get_commitment_transaction_number_obscure_factor() ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
 836
 837                 let txins = {
 838                         let mut ins: Vec<TxIn> = Vec::new();
 839                         ins.push(TxIn {
 840                                 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
 841                                 script_sig: Script::new(),
 842                                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
 843                                 witness: Vec::new(),
 844                         });
 845                         ins
 846                 };
 847
 848                 let mut txouts: Vec<(TxOut, Option<(HTLCOutputInCommitment, Option<&HTLCSource>)>)> = Vec::with_capacity(self.pending_inbound_htlcs.len() + self.pending_outbound_htlcs.len() + 2);
 849                 let mut included_dust_htlcs: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::new();
 850
 851                 let dust_limit_satoshis = if local { self.our_dust_limit_satoshis } else { self.their_dust_limit_satoshis };
 852                 let mut remote_htlc_total_msat = 0;
 853                 let mut local_htlc_total_msat = 0;
 854                 let mut value_to_self_msat_offset = 0;
 855
 856                 log_trace!(logger, "Building commitment transaction number {} (really {} xor {}) for {}, generated by {} with fee {}...", commitment_number, (INITIAL_COMMITMENT_NUMBER - commitment_number), self.get_commitment_transaction_number_obscure_factor(), if local { "us" } else { "remote" }, if generated_by_local { "us" } else { "remote" }, feerate_per_kw);
 857
 858                 macro_rules! get_htlc_in_commitment {
 859                         ($htlc: expr, $offered: expr) => {
 860                                 HTLCOutputInCommitment {
 861                                         offered: $offered,
 862                                         amount_msat: $htlc.amount_msat,
 863                                         cltv_expiry: $htlc.cltv_expiry,
 864                                         payment_hash: $htlc.payment_hash,
 865                                         transaction_output_index: None
 866                                 }
 867                         }
 868                 }
 869
 870                 macro_rules! add_htlc_output {
 871                         ($htlc: expr, $outbound: expr, $source: expr, $state_name: expr) => {
 872                                 if $outbound == local { // "offered HTLC output"
 873                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, true);
 874                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000) {
 875                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 876                                                 txouts.push((TxOut {
 877                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 878                                                         value: $htlc.amount_msat / 1000
 879                                                 }, Some((htlc_in_tx, $source))));
 880                                         } else {
 881                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {} due to dust limit", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 882                                                 included_dust_htlcs.push((htlc_in_tx, $source));
 883                                         }
 884                                 } else {
 885                                         let htlc_in_tx = get_htlc_in_commitment!($htlc, false);
 886                                         if $htlc.amount_msat / 1000 >= dust_limit_satoshis + (feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000) {
 887                                                 log_trace!(logger, "   ...including {} {} HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 888                                                 txouts.push((TxOut { // "received HTLC output"
 889                                                         script_pubkey: chan_utils::get_htlc_redeemscript(&htlc_in_tx, &keys).to_v0_p2wsh(),
 890                                                         value: $htlc.amount_msat / 1000
 891                                                 }, Some((htlc_in_tx, $source))));
 892                                         } else {
 893                                                 log_trace!(logger, "   ...including {} {} dust HTLC {} (hash {}) with value {}", if $outbound { "outbound" } else { "inbound" }, $state_name, $htlc.htlc_id, log_bytes!($htlc.payment_hash.0), $htlc.amount_msat);
 894                                                 included_dust_htlcs.push((htlc_in_tx, $source));
 895                                         }
 896                                 }
 897                         }
 898                 }
 899
 900                 for ref htlc in self.pending_inbound_htlcs.iter() {
 901                         let (include, state_name) = match htlc.state {
 902                                 InboundHTLCState::RemoteAnnounced(_) => (!generated_by_local, "RemoteAnnounced"),
 903                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) => (!generated_by_local, "AwaitingRemoteRevokeToAnnounce"),
 904                                 InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => (true, "AwaitingAnnouncedRemoteRevoke"),
 905                                 InboundHTLCState::Committed => (true, "Committed"),
 906                                 InboundHTLCState::LocalRemoved(_) => (!generated_by_local, "LocalRemoved"),
 907                         };
 908
 909                         if include {
 910                                 add_htlc_output!(htlc, false, None, state_name);
 911                                 remote_htlc_total_msat += htlc.amount_msat;
 912                         } else {
 913                                 log_trace!(logger, "   ...not including inbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 914                                 match &htlc.state {
 915                                         &InboundHTLCState::LocalRemoved(ref reason) => {
 916                                                 if generated_by_local {
 917                                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
 918                                                                 value_to_self_msat_offset += htlc.amount_msat as i64;
 919                                                         }
 920                                                 }
 921                                         },
 922                                         _ => {},
 923                                 }
 924                         }
 925                 }
 926
 927                 for ref htlc in self.pending_outbound_htlcs.iter() {
 928                         let (include, state_name) = match htlc.state {
 929                                 OutboundHTLCState::LocalAnnounced(_) => (generated_by_local, "LocalAnnounced"),
 930                                 OutboundHTLCState::Committed => (true, "Committed"),
 931                                 OutboundHTLCState::RemoteRemoved(_) => (generated_by_local, "RemoteRemoved"),
 932                                 OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) => (generated_by_local, "AwaitingRemoteRevokeToRemove"),
 933                                 OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) => (false, "AwaitingRemovedRemoteRevoke"),
 934                         };
 935
 936                         if include {
 937                                 add_htlc_output!(htlc, true, Some(&htlc.source), state_name);
 938                                 local_htlc_total_msat += htlc.amount_msat;
 939                         } else {
 940                                 log_trace!(logger, "   ...not including outbound HTLC {} (hash {}) with value {} due to state ({})", htlc.htlc_id, log_bytes!(htlc.payment_hash.0), htlc.amount_msat, state_name);
 941                                 match htlc.state {
 942                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(None)|OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) => {
 943                                                 value_to_self_msat_offset -= htlc.amount_msat as i64;
 944                                         },
 945                                         OutboundHTLCState::RemoteRemoved(None) => {
 946                                                 if !generated_by_local {
 947                                                         value_to_self_msat_offset -= htlc.amount_msat as i64;
 948                                                 }
 949                                         },
 950                                         _ => {},
 951                                 }
 952                         }
 953                 }
 954
 955                 let value_to_self_msat: i64 = (self.value_to_self_msat - local_htlc_total_msat) as i64 + value_to_self_msat_offset;
 956                 assert!(value_to_self_msat >= 0);
 957                 // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
 958                 // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
 959                 // "violate" their reserve value by couting those against it. Thus, we have to convert
 960                 // everything to i64 before subtracting as otherwise we can overflow.
 961                 let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
 962                 assert!(value_to_remote_msat >= 0);
 963
 964                 #[cfg(debug_assertions)]
 965                 {
 966                         // Make sure that the to_self/to_remote is always either past the appropriate
 967                         // channel_reserve *or* it is making progress towards it.
 968                         let mut max_commitment_tx_output = if generated_by_local {
 969                                 self.max_commitment_tx_output_local.lock().unwrap()
 970                         } else {
 971                                 self.max_commitment_tx_output_remote.lock().unwrap()
 972                         };
 973                         debug_assert!(max_commitment_tx_output.0 <= value_to_self_msat as u64 || value_to_self_msat / 1000 >= self.local_channel_reserve_satoshis as i64);
 974                         max_commitment_tx_output.0 = cmp::max(max_commitment_tx_output.0, value_to_self_msat as u64);
 975                         debug_assert!(max_commitment_tx_output.1 <= value_to_remote_msat as u64 || value_to_remote_msat / 1000 >= Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) as i64);
 976                         max_commitment_tx_output.1 = cmp::max(max_commitment_tx_output.1, value_to_remote_msat as u64);
 977                 }
 978
 979                 let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (txouts.len() as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 980                 let (value_to_self, value_to_remote) = if self.channel_outbound {
 981                         (value_to_self_msat / 1000 - total_fee as i64, value_to_remote_msat / 1000)
 982                 } else {
 983                         (value_to_self_msat / 1000, value_to_remote_msat / 1000 - total_fee as i64)
 984                 };
 985
 986                 let value_to_a = if local { value_to_self } else { value_to_remote };
 987                 let value_to_b = if local { value_to_remote } else { value_to_self };
 988
 989                 if value_to_a >= (dust_limit_satoshis as i64) {
 990                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_local" } else { "to_remote" }, value_to_a);
 991                         txouts.push((TxOut {
 992                                 script_pubkey: chan_utils::get_revokeable_redeemscript(&keys.revocation_key,
 993                                                                                        if local { self.their_to_self_delay } else { self.our_to_self_delay },
 994                                                                                        &keys.a_delayed_payment_key).to_v0_p2wsh(),
 995                                 value: value_to_a as u64
 996                         }, None));
 997                 }
 998
 999                 if value_to_b >= (dust_limit_satoshis as i64) {
1000                         log_trace!(logger, "   ...including {} output with value {}", if local { "to_remote" } else { "to_local" }, value_to_b);
1001                         let static_payment_pk = if local {
1002                                 self.their_pubkeys.as_ref().unwrap().payment_point
1003                         } else {
1004                                 self.local_keys.pubkeys().payment_point
1005                         }.serialize();
1006                         txouts.push((TxOut {
1007                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1008                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1009                                                              .into_script(),
1010                                 value: value_to_b as u64
1011                         }, None));
1012                 }
1013
1014                 transaction_utils::sort_outputs(&mut txouts, |a, b| {
1015                         if let &Some(ref a_htlc) = a {
1016                                 if let &Some(ref b_htlc) = b {
1017                                         a_htlc.0.cltv_expiry.cmp(&b_htlc.0.cltv_expiry)
1018                                                 // Note that due to hash collisions, we have to have a fallback comparison
1019                                                 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1020                                                 // may fail)!
1021                                                 .then(a_htlc.0.payment_hash.0.cmp(&b_htlc.0.payment_hash.0))
1022                                 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1023                                 // close the channel due to mismatches - they're doing something dumb:
1024                                 } else { cmp::Ordering::Equal }
1025                         } else { cmp::Ordering::Equal }
1026                 });
1027
1028                 let mut outputs: Vec<TxOut> = Vec::with_capacity(txouts.len());
1029                 let mut htlcs_included: Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)> = Vec::with_capacity(txouts.len() + included_dust_htlcs.len());
1030                 for (idx, mut out) in txouts.drain(..).enumerate() {
1031                         outputs.push(out.0);
1032                         if let Some((mut htlc, source_option)) = out.1.take() {
1033                                 htlc.transaction_output_index = Some(idx as u32);
1034                                 htlcs_included.push((htlc, source_option));
1035                         }
1036                 }
1037                 let non_dust_htlc_count = htlcs_included.len();
1038                 htlcs_included.append(&mut included_dust_htlcs);
1039
1040                 (Transaction {
1041                         version: 2,
1042                         lock_time: ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1043                         input: txins,
1044                         output: outputs,
1045                 }, non_dust_htlc_count, htlcs_included)
1046         }
1047
1048         #[inline]
1049         fn get_closing_scriptpubkey(&self) -> Script {
1050                 let our_channel_close_key_hash = WPubkeyHash::hash(&self.shutdown_pubkey.serialize());
1051                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script()
1052         }
1053
1054         #[inline]
1055         fn get_closing_transaction_weight(a_scriptpubkey: &Script, b_scriptpubkey: &Script) -> u64 {
1056                 (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)
1057         }
1058
1059         #[inline]
1060         fn build_closing_transaction(&self, proposed_total_fee_satoshis: u64, skip_remote_output: bool) -> (Transaction, u64) {
1061                 let txins = {
1062                         let mut ins: Vec<TxIn> = Vec::new();
1063                         ins.push(TxIn {
1064                                 previous_output: self.funding_txo.unwrap().into_bitcoin_outpoint(),
1065                                 script_sig: Script::new(),
1066                                 sequence: 0xffffffff,
1067                                 witness: Vec::new(),
1068                         });
1069                         ins
1070                 };
1071
1072                 assert!(self.pending_inbound_htlcs.is_empty());
1073                 assert!(self.pending_outbound_htlcs.is_empty());
1074                 let mut txouts: Vec<(TxOut, ())> = Vec::new();
1075
1076                 let mut total_fee_satoshis = proposed_total_fee_satoshis;
1077                 let value_to_self: i64 = (self.value_to_self_msat as i64) / 1000 - if self.channel_outbound { total_fee_satoshis as i64 } else { 0 };
1078                 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 };
1079
1080                 if value_to_self < 0 {
1081                         assert!(self.channel_outbound);
1082                         total_fee_satoshis += (-value_to_self) as u64;
1083                 } else if value_to_remote < 0 {
1084                         assert!(!self.channel_outbound);
1085                         total_fee_satoshis += (-value_to_remote) as u64;
1086                 }
1087
1088                 if !skip_remote_output && value_to_remote as u64 > self.our_dust_limit_satoshis {
1089                         txouts.push((TxOut {
1090                                 script_pubkey: self.their_shutdown_scriptpubkey.clone().unwrap(),
1091                                 value: value_to_remote as u64
1092                         }, ()));
1093                 }
1094
1095                 if value_to_self as u64 > self.our_dust_limit_satoshis {
1096                         txouts.push((TxOut {
1097                                 script_pubkey: self.get_closing_scriptpubkey(),
1098                                 value: value_to_self as u64
1099                         }, ()));
1100                 }
1101
1102                 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
1103
1104                 let mut outputs: Vec<TxOut> = Vec::new();
1105                 for out in txouts.drain(..) {
1106                         outputs.push(out.0);
1107                 }
1108
1109                 (Transaction {
1110                         version: 2,
1111                         lock_time: 0,
1112                         input: txins,
1113                         output: outputs,
1114                 }, total_fee_satoshis)
1115         }
1116
1117         #[inline]
1118         /// Creates a set of keys for build_commitment_transaction to generate a transaction which our
1119         /// counterparty will sign (ie DO NOT send signatures over a transaction created by this to
1120         /// our counterparty!)
1121         /// The result is a transaction which we can revoke ownership of (ie a "local" transaction)
1122         /// TODO Some magic rust shit to compile-time check this?
1123         fn build_local_transaction_keys(&self, commitment_number: u64) -> Result<TxCreationKeys, ChannelError> {
1124                 let per_commitment_point = self.local_keys.get_per_commitment_point(commitment_number, &self.secp_ctx);
1125                 let delayed_payment_base = &self.local_keys.pubkeys().delayed_payment_basepoint;
1126                 let htlc_basepoint = &self.local_keys.pubkeys().htlc_basepoint;
1127                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1128
1129                 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint), "Local tx keys generation got bogus keys".to_owned()))
1130         }
1131
1132         #[inline]
1133         /// Creates a set of keys for build_commitment_transaction to generate a transaction which we
1134         /// will sign and send to our counterparty.
1135         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
1136         fn build_remote_transaction_keys(&self) -> Result<TxCreationKeys, ChannelError> {
1137                 //TODO: Ensure that the payment_key derived here ends up in the library users' wallet as we
1138                 //may see payments to it!
1139                 let revocation_basepoint = &self.local_keys.pubkeys().revocation_basepoint;
1140                 let htlc_basepoint = &self.local_keys.pubkeys().htlc_basepoint;
1141                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1142
1143                 Ok(secp_check!(TxCreationKeys::derive_new(&self.secp_ctx, &self.their_cur_commitment_point.unwrap(), &their_pubkeys.delayed_payment_basepoint, &their_pubkeys.htlc_basepoint, revocation_basepoint, htlc_basepoint), "Remote tx keys generation got bogus keys".to_owned()))
1144         }
1145
1146         /// Gets the redeemscript for the funding transaction output (ie the funding transaction output
1147         /// pays to get_funding_redeemscript().to_v0_p2wsh()).
1148         /// Panics if called before accept_channel/new_from_req
1149         pub fn get_funding_redeemscript(&self) -> Script {
1150                 make_funding_redeemscript(&self.local_keys.pubkeys().funding_pubkey, self.their_funding_pubkey())
1151         }
1152
1153         /// Builds the htlc-success or htlc-timeout transaction which spends a given HTLC output
1154         /// @local is used only to convert relevant internal structures which refer to remote vs local
1155         /// to decide value of outputs and direction of HTLCs.
1156         fn build_htlc_transaction(&self, prev_hash: &Txid, htlc: &HTLCOutputInCommitment, local: bool, keys: &TxCreationKeys, feerate_per_kw: u32) -> Transaction {
1157                 chan_utils::build_htlc_transaction(prev_hash, feerate_per_kw, if local { self.their_to_self_delay } else { self.our_to_self_delay }, htlc, &keys.a_delayed_payment_key, &keys.revocation_key)
1158         }
1159
1160         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1161         /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1162         /// return Ok(_) if debug assertions are turned on or preconditions are met.
1163         ///
1164         /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1165         /// but then have a reorg which settles on an HTLC-failure on chain.
1166         fn get_update_fulfill_htlc<L: Deref>(&mut self, htlc_id_arg: u64, payment_preimage_arg: PaymentPreimage, logger: &L) -> Result<(Option<msgs::UpdateFulfillHTLC>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1167                 // Either ChannelFunded got set (which means it won't be unset) or there is no way any
1168                 // caller thought we could have something claimed (cause we wouldn't have accepted in an
1169                 // incoming HTLC anyway). If we got to ShutdownComplete, callers aren't allowed to call us,
1170                 // either.
1171                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1172                         panic!("Was asked to fulfill an HTLC when channel was not in an operational state");
1173                 }
1174                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1175
1176                 let payment_hash_calc = PaymentHash(Sha256::hash(&payment_preimage_arg.0[..]).into_inner());
1177
1178                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1179                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1180                 // these, but for now we just have to treat them as normal.
1181
1182                 let mut pending_idx = std::usize::MAX;
1183                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1184                         if htlc.htlc_id == htlc_id_arg {
1185                                 assert_eq!(htlc.payment_hash, payment_hash_calc);
1186                                 match htlc.state {
1187                                         InboundHTLCState::Committed => {},
1188                                         InboundHTLCState::LocalRemoved(ref reason) => {
1189                                                 if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
1190                                                 } else {
1191                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with payment hash {} we already failed against channel {}", log_bytes!(htlc.payment_hash.0), log_bytes!(self.channel_id()));
1192                                                 }
1193                                                 debug_assert!(false, "Tried to fulfill an HTLC that was already fail/fulfilled");
1194                                                 return Ok((None, None));
1195                                         },
1196                                         _ => {
1197                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1198                                                 // Don't return in release mode here so that we can update channel_monitor
1199                                         }
1200                                 }
1201                                 pending_idx = idx;
1202                                 break;
1203                         }
1204                 }
1205                 if pending_idx == std::usize::MAX {
1206                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1207                 }
1208
1209                 // Now update local state:
1210                 //
1211                 // We have to put the payment_preimage in the channel_monitor right away here to ensure we
1212                 // can claim it even if the channel hits the chain before we see their next commitment.
1213                 self.latest_monitor_update_id += 1;
1214                 let monitor_update = ChannelMonitorUpdate {
1215                         update_id: self.latest_monitor_update_id,
1216                         updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
1217                                 payment_preimage: payment_preimage_arg.clone(),
1218                         }],
1219                 };
1220
1221                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1222                         for pending_update in self.holding_cell_htlc_updates.iter() {
1223                                 match pending_update {
1224                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1225                                                 if htlc_id_arg == htlc_id {
1226                                                         // Make sure we don't leave latest_monitor_update_id incremented here:
1227                                                         self.latest_monitor_update_id -= 1;
1228                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already fulfilled");
1229                                                         return Ok((None, None));
1230                                                 }
1231                                         },
1232                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1233                                                 if htlc_id_arg == htlc_id {
1234                                                         log_warn!(logger, "Have preimage and want to fulfill HTLC with pending failure against channel {}", log_bytes!(self.channel_id()));
1235                                                         // TODO: We may actually be able to switch to a fulfill here, though its
1236                                                         // rare enough it may not be worth the complexity burden.
1237                                                         debug_assert!(false, "Tried to fulfill an HTLC that was already failed");
1238                                                         return Ok((None, Some(monitor_update)));
1239                                                 }
1240                                         },
1241                                         _ => {}
1242                                 }
1243                         }
1244                         log_trace!(logger, "Adding HTLC claim to holding_cell! Current state: {}", self.channel_state);
1245                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::ClaimHTLC {
1246                                 payment_preimage: payment_preimage_arg, htlc_id: htlc_id_arg,
1247                         });
1248                         return Ok((None, Some(monitor_update)));
1249                 }
1250
1251                 {
1252                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1253                         if let InboundHTLCState::Committed = htlc.state {
1254                         } else {
1255                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1256                                 return Ok((None, Some(monitor_update)));
1257                         }
1258                         log_trace!(logger, "Upgrading HTLC {} to LocalRemoved with a Fulfill!", log_bytes!(htlc.payment_hash.0));
1259                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::Fulfill(payment_preimage_arg.clone()));
1260                 }
1261
1262                 Ok((Some(msgs::UpdateFulfillHTLC {
1263                         channel_id: self.channel_id(),
1264                         htlc_id: htlc_id_arg,
1265                         payment_preimage: payment_preimage_arg,
1266                 }), Some(monitor_update)))
1267         }
1268
1269         pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> Result<(Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)>, Option<ChannelMonitorUpdate>), ChannelError> where L::Target: Logger {
1270                 match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger)? {
1271                         (Some(update_fulfill_htlc), Some(mut monitor_update)) => {
1272                                 let (commitment, mut additional_update) = self.send_commitment_no_status_check(logger)?;
1273                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1274                                 // strictly increasing by one, so decrement it here.
1275                                 self.latest_monitor_update_id = monitor_update.update_id;
1276                                 monitor_update.updates.append(&mut additional_update.updates);
1277                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1278                         },
1279                         (Some(update_fulfill_htlc), None) => {
1280                                 let (commitment, monitor_update) = self.send_commitment_no_status_check(logger)?;
1281                                 Ok((Some((update_fulfill_htlc, commitment)), Some(monitor_update)))
1282                         },
1283                         (None, Some(monitor_update)) => Ok((None, Some(monitor_update))),
1284                         (None, None) => Ok((None, None))
1285                 }
1286         }
1287
1288         /// Per HTLC, only one get_update_fail_htlc or get_update_fulfill_htlc call may be made.
1289         /// In such cases we debug_assert!(false) and return a ChannelError::Ignore. Thus, will always
1290         /// return Ok(_) if debug assertions are turned on or preconditions are met.
1291         ///
1292         /// Note that it is still possible to hit these assertions in case we find a preimage on-chain
1293         /// but then have a reorg which settles on an HTLC-failure on chain.
1294         pub fn get_update_fail_htlc(&mut self, htlc_id_arg: u64, err_packet: msgs::OnionErrorPacket) -> Result<Option<msgs::UpdateFailHTLC>, ChannelError> {
1295                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1296                         panic!("Was asked to fail an HTLC when channel was not in an operational state");
1297                 }
1298                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
1299
1300                 // ChannelManager may generate duplicate claims/fails due to HTLC update events from
1301                 // on-chain ChannelsMonitors during block rescan. Ideally we'd figure out a way to drop
1302                 // these, but for now we just have to treat them as normal.
1303
1304                 let mut pending_idx = std::usize::MAX;
1305                 for (idx, htlc) in self.pending_inbound_htlcs.iter().enumerate() {
1306                         if htlc.htlc_id == htlc_id_arg {
1307                                 match htlc.state {
1308                                         InboundHTLCState::Committed => {},
1309                                         InboundHTLCState::LocalRemoved(_) => {
1310                                                 debug_assert!(false, "Tried to fail an HTLC that was already fail/fulfilled");
1311                                                 return Ok(None);
1312                                         },
1313                                         _ => {
1314                                                 debug_assert!(false, "Have an inbound HTLC we tried to claim before it was fully committed to");
1315                                                 return Err(ChannelError::Ignore(format!("Unable to find a pending HTLC which matched the given HTLC ID ({})", htlc.htlc_id)));
1316                                         }
1317                                 }
1318                                 pending_idx = idx;
1319                         }
1320                 }
1321                 if pending_idx == std::usize::MAX {
1322                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1323                 }
1324
1325                 // Now update local state:
1326                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
1327                         for pending_update in self.holding_cell_htlc_updates.iter() {
1328                                 match pending_update {
1329                                         &HTLCUpdateAwaitingACK::ClaimHTLC { htlc_id, .. } => {
1330                                                 if htlc_id_arg == htlc_id {
1331                                                         debug_assert!(false, "Tried to fail an HTLC that was already fulfilled");
1332                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1333                                                 }
1334                                         },
1335                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, .. } => {
1336                                                 if htlc_id_arg == htlc_id {
1337                                                         debug_assert!(false, "Tried to fail an HTLC that was already failed");
1338                                                         return Err(ChannelError::Ignore("Unable to find a pending HTLC which matched the given HTLC ID".to_owned()));
1339                                                 }
1340                                         },
1341                                         _ => {}
1342                                 }
1343                         }
1344                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::FailHTLC {
1345                                 htlc_id: htlc_id_arg,
1346                                 err_packet,
1347                         });
1348                         return Ok(None);
1349                 }
1350
1351                 {
1352                         let htlc = &mut self.pending_inbound_htlcs[pending_idx];
1353                         htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(err_packet.clone()));
1354                 }
1355
1356                 Ok(Some(msgs::UpdateFailHTLC {
1357                         channel_id: self.channel_id(),
1358                         htlc_id: htlc_id_arg,
1359                         reason: err_packet
1360                 }))
1361         }
1362
1363         // Message handlers:
1364
1365         pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel, config: &UserConfig, their_features: InitFeatures) -> Result<(), ChannelError> {
1366                 // Check sanity of message fields:
1367                 if !self.channel_outbound {
1368                         return Err(ChannelError::Close("Got an accept_channel message from an inbound peer".to_owned()));
1369                 }
1370                 if self.channel_state != ChannelState::OurInitSent as u32 {
1371                         return Err(ChannelError::Close("Got an accept_channel message at a strange time".to_owned()));
1372                 }
1373                 if msg.dust_limit_satoshis > 21000000 * 100000000 {
1374                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? dust_limit_satoshis was {}", msg.dust_limit_satoshis)));
1375                 }
1376                 if msg.channel_reserve_satoshis > self.channel_value_satoshis {
1377                         return Err(ChannelError::Close(format!("Bogus channel_reserve_satoshis ({}). Must not be greater than ({})", msg.channel_reserve_satoshis, self.channel_value_satoshis)));
1378                 }
1379                 if msg.dust_limit_satoshis > msg.channel_reserve_satoshis {
1380                         return Err(ChannelError::Close(format!("Bogus channel_reserve ({}) and dust_limit ({})", msg.channel_reserve_satoshis, msg.dust_limit_satoshis)));
1381                 }
1382                 if msg.channel_reserve_satoshis < self.our_dust_limit_satoshis {
1383                         return Err(ChannelError::Close(format!("Peer never wants payout outputs? channel_reserve_satoshis was ({}). our_dust_limit is ({})", msg.channel_reserve_satoshis, self.our_dust_limit_satoshis)));
1384                 }
1385                 let remote_reserve = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
1386                 if msg.dust_limit_satoshis > remote_reserve {
1387                         return Err(ChannelError::Close(format!("Dust limit ({}) is bigger than our channel reserve ({})", msg.dust_limit_satoshis, remote_reserve)));
1388                 }
1389                 let full_channel_value_msat = (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000;
1390                 if msg.htlc_minimum_msat >= full_channel_value_msat {
1391                         return Err(ChannelError::Close(format!("Minimum htlc value ({}) is full channel value ({})", msg.htlc_minimum_msat, full_channel_value_msat)));
1392                 }
1393                 let max_delay_acceptable = u16::min(config.peer_channel_config_limits.their_to_self_delay, MAX_LOCAL_BREAKDOWN_TIMEOUT);
1394                 if msg.to_self_delay > max_delay_acceptable {
1395                         return Err(ChannelError::Close(format!("They wanted our payments to be delayed by a needlessly long period. Upper limit: {}. Actual: {}", max_delay_acceptable, msg.to_self_delay)));
1396                 }
1397                 if msg.max_accepted_htlcs < 1 {
1398                         return Err(ChannelError::Close("0 max_accepted_htlcs makes for a useless channel".to_owned()));
1399                 }
1400                 if msg.max_accepted_htlcs > 483 {
1401                         return Err(ChannelError::Close(format!("max_accepted_htlcs was {}. It must not be larger than 483", msg.max_accepted_htlcs)));
1402                 }
1403
1404                 // Now check against optional parameters as set by config...
1405                 if msg.htlc_minimum_msat > config.peer_channel_config_limits.max_htlc_minimum_msat {
1406                         return Err(ChannelError::Close(format!("htlc_minimum_msat ({}) is higher than the user specified limit ({})", msg.htlc_minimum_msat, config.peer_channel_config_limits.max_htlc_minimum_msat)));
1407                 }
1408                 if msg.max_htlc_value_in_flight_msat < config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat {
1409                         return Err(ChannelError::Close(format!("max_htlc_value_in_flight_msat ({}) is less than the user specified limit ({})", msg.max_htlc_value_in_flight_msat, config.peer_channel_config_limits.min_max_htlc_value_in_flight_msat)));
1410                 }
1411                 if msg.channel_reserve_satoshis > config.peer_channel_config_limits.max_channel_reserve_satoshis {
1412                         return Err(ChannelError::Close(format!("channel_reserve_satoshis ({}) is higher than the user specified limit ({})", msg.channel_reserve_satoshis, config.peer_channel_config_limits.max_channel_reserve_satoshis)));
1413                 }
1414                 if msg.max_accepted_htlcs < config.peer_channel_config_limits.min_max_accepted_htlcs {
1415                         return Err(ChannelError::Close(format!("max_accepted_htlcs ({}) is less than the user specified limit ({})", msg.max_accepted_htlcs, config.peer_channel_config_limits.min_max_accepted_htlcs)));
1416                 }
1417                 if msg.dust_limit_satoshis < config.peer_channel_config_limits.min_dust_limit_satoshis {
1418                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is less than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.min_dust_limit_satoshis)));
1419                 }
1420                 if msg.dust_limit_satoshis > config.peer_channel_config_limits.max_dust_limit_satoshis {
1421                         return Err(ChannelError::Close(format!("dust_limit_satoshis ({}) is greater than the user specified limit ({})", msg.dust_limit_satoshis, config.peer_channel_config_limits.max_dust_limit_satoshis)));
1422                 }
1423                 if msg.minimum_depth > config.peer_channel_config_limits.max_minimum_depth {
1424                         return Err(ChannelError::Close(format!("We consider the minimum depth to be unreasonably large. Expected minimum: ({}). Actual: ({})", config.peer_channel_config_limits.max_minimum_depth, msg.minimum_depth)));
1425                 }
1426
1427                 let their_shutdown_scriptpubkey = if their_features.supports_upfront_shutdown_script() {
1428                         match &msg.shutdown_scriptpubkey {
1429                                 &OptionalField::Present(ref script) => {
1430                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. We enforce it while receiving shutdown msg
1431                                         if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wsh() || script.is_v0_p2wpkh() {
1432                                                 Some(script.clone())
1433                                         // Peer is signaling upfront_shutdown and has opt-out with a 0-length script. We don't enforce anything
1434                                         } else if script.len() == 0 {
1435                                                 None
1436                                         // Peer is signaling upfront_shutdown and has provided a non-accepted scriptpubkey format. Fail the channel
1437                                         } else {
1438                                                 return Err(ChannelError::Close(format!("Peer is signaling upfront_shutdown but has provided a non-accepted scriptpubkey format. scriptpubkey: ({})", script.to_bytes().to_hex())));
1439                                         }
1440                                 },
1441                                 // Peer is signaling upfront shutdown but don't opt-out with correct mechanism (a.k.a 0-length script). Peer looks buggy, we fail the channel
1442                                 &OptionalField::Absent => {
1443                                         return Err(ChannelError::Close("Peer is signaling upfront_shutdown but we don't get any script. Use 0-length script to opt-out".to_owned()));
1444                                 }
1445                         }
1446                 } else { None };
1447
1448                 self.their_dust_limit_satoshis = msg.dust_limit_satoshis;
1449                 self.their_max_htlc_value_in_flight_msat = cmp::min(msg.max_htlc_value_in_flight_msat, self.channel_value_satoshis * 1000);
1450                 self.local_channel_reserve_satoshis = msg.channel_reserve_satoshis;
1451                 self.their_htlc_minimum_msat = msg.htlc_minimum_msat;
1452                 self.their_to_self_delay = msg.to_self_delay;
1453                 self.their_max_accepted_htlcs = msg.max_accepted_htlcs;
1454                 self.minimum_depth = msg.minimum_depth;
1455
1456                 let their_pubkeys = ChannelPublicKeys {
1457                         funding_pubkey: msg.funding_pubkey,
1458                         revocation_basepoint: msg.revocation_basepoint,
1459                         payment_point: msg.payment_point,
1460                         delayed_payment_basepoint: msg.delayed_payment_basepoint,
1461                         htlc_basepoint: msg.htlc_basepoint
1462                 };
1463
1464                 self.local_keys.on_accept(&their_pubkeys, msg.to_self_delay, self.our_to_self_delay);
1465                 self.their_pubkeys = Some(their_pubkeys);
1466
1467                 self.their_cur_commitment_point = Some(msg.first_per_commitment_point);
1468                 self.their_shutdown_scriptpubkey = their_shutdown_scriptpubkey;
1469
1470                 self.channel_state = ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32;
1471
1472                 Ok(())
1473         }
1474
1475         fn funding_created_signature<L: Deref>(&mut self, sig: &Signature, logger: &L) -> Result<(Transaction, LocalCommitmentTransaction, Signature), ChannelError> where L::Target: Logger {
1476                 let funding_script = self.get_funding_redeemscript();
1477
1478                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1479                 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1480                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1481
1482                 // They sign the "local" commitment transaction...
1483                 log_trace!(logger, "Checking funding_created tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(sig.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_initial_commitment_tx), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1484                 secp_check!(self.secp_ctx.verify(&local_sighash, &sig, self.their_funding_pubkey()), "Invalid funding_created signature from peer".to_owned());
1485
1486                 let localtx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx, sig.clone(), &self.local_keys.pubkeys().funding_pubkey, self.their_funding_pubkey(), local_keys, self.feerate_per_kw, Vec::new());
1487
1488                 let remote_keys = self.build_remote_transaction_keys()?;
1489                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1490                 let pre_remote_keys = PreCalculatedTxCreationKeys::new(remote_keys);
1491                 let remote_signature = self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &pre_remote_keys, &Vec::new(), &self.secp_ctx)
1492                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0;
1493
1494                 // We sign the "remote" commitment transaction, allowing them to broadcast the tx if they wish.
1495                 Ok((remote_initial_commitment_tx, localtx, remote_signature))
1496         }
1497
1498         fn their_funding_pubkey(&self) -> &PublicKey {
1499                 &self.their_pubkeys.as_ref().expect("their_funding_pubkey() only allowed after accept_channel").funding_pubkey
1500         }
1501
1502         pub fn funding_created<L: Deref>(&mut self, msg: &msgs::FundingCreated, logger: &L) -> Result<(msgs::FundingSigned, ChannelMonitor<ChanSigner>), ChannelError> where L::Target: Logger {
1503                 if self.channel_outbound {
1504                         return Err(ChannelError::Close("Received funding_created for an outbound channel?".to_owned()));
1505                 }
1506                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
1507                         // BOLT 2 says that if we disconnect before we send funding_signed we SHOULD NOT
1508                         // remember the channel, so it's safe to just send an error_message here and drop the
1509                         // channel.
1510                         return Err(ChannelError::Close("Received funding_created after we got the channel!".to_owned()));
1511                 }
1512                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1513                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1514                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1515                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1516                 }
1517
1518                 let funding_txo = OutPoint{ txid: msg.funding_txid, index: msg.funding_output_index };
1519                 self.funding_txo = Some(funding_txo.clone());
1520
1521                 let (remote_initial_commitment_tx, local_initial_commitment_tx, our_signature) = match self.funding_created_signature(&msg.signature, logger) {
1522                         Ok(res) => res,
1523                         Err(e) => {
1524                                 self.funding_txo = None;
1525                                 return Err(e);
1526                         }
1527                 };
1528
1529                 // Now that we're past error-generating stuff, update our local state:
1530
1531                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1532                 let funding_redeemscript = self.get_funding_redeemscript();
1533                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1534                 macro_rules! create_monitor {
1535                         () => { {
1536                                 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1537                                                                               &self.shutdown_pubkey, self.our_to_self_delay,
1538                                                                               &self.destination_script, (funding_txo, funding_txo_script.clone()),
1539                                                                               &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1540                                                                               self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1541                                                                               self.get_commitment_transaction_number_obscure_factor(),
1542                                                                               local_initial_commitment_tx.clone());
1543
1544                                 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(), logger);
1545                                 channel_monitor
1546                         } }
1547                 }
1548
1549                 let channel_monitor = create_monitor!();
1550
1551                 self.channel_state = ChannelState::FundingSent as u32;
1552                 self.channel_id = funding_txo.to_channel_id();
1553                 self.cur_remote_commitment_transaction_number -= 1;
1554                 self.cur_local_commitment_transaction_number -= 1;
1555
1556                 Ok((msgs::FundingSigned {
1557                         channel_id: self.channel_id,
1558                         signature: our_signature
1559                 }, channel_monitor))
1560         }
1561
1562         /// Handles a funding_signed message from the remote end.
1563         /// If this call is successful, broadcast the funding transaction (and not before!)
1564         pub fn funding_signed<L: Deref>(&mut self, msg: &msgs::FundingSigned, logger: &L) -> Result<ChannelMonitor<ChanSigner>, ChannelError> where L::Target: Logger {
1565                 if !self.channel_outbound {
1566                         return Err(ChannelError::Close("Received funding_signed for an inbound channel?".to_owned()));
1567                 }
1568                 if self.channel_state & !(ChannelState::MonitorUpdateFailed as u32) != ChannelState::FundingCreated as u32 {
1569                         return Err(ChannelError::Close("Received funding_signed in strange state!".to_owned()));
1570                 }
1571                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
1572                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
1573                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
1574                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
1575                 }
1576
1577                 let funding_script = self.get_funding_redeemscript();
1578
1579                 let remote_keys = self.build_remote_transaction_keys()?;
1580                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
1581
1582                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number)?;
1583                 let local_initial_commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, self.feerate_per_kw, logger).0;
1584                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_initial_commitment_tx).sighash_all(&local_initial_commitment_tx.input[0], &funding_script, self.channel_value_satoshis)[..]);
1585
1586                 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1587
1588                 // They sign the "local" commitment transaction, allowing us to broadcast the tx if we wish.
1589                 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, their_funding_pubkey) {
1590                         return Err(ChannelError::Close("Invalid funding_signed signature from peer".to_owned()));
1591                 }
1592
1593                 let their_pubkeys = self.their_pubkeys.as_ref().unwrap();
1594                 let funding_redeemscript = self.get_funding_redeemscript();
1595                 let funding_txo = self.funding_txo.as_ref().unwrap();
1596                 let funding_txo_script = funding_redeemscript.to_v0_p2wsh();
1597                 macro_rules! create_monitor {
1598                         () => { {
1599                                 let local_commitment_tx = LocalCommitmentTransaction::new_missing_local_sig(local_initial_commitment_tx.clone(), msg.signature.clone(), &self.local_keys.pubkeys().funding_pubkey, their_funding_pubkey, local_keys.clone(), self.feerate_per_kw, Vec::new());
1600                                 let mut channel_monitor = ChannelMonitor::new(self.local_keys.clone(),
1601                                                                               &self.shutdown_pubkey, self.our_to_self_delay,
1602                                                                               &self.destination_script, (funding_txo.clone(), funding_txo_script.clone()),
1603                                                                               &their_pubkeys.htlc_basepoint, &their_pubkeys.delayed_payment_basepoint,
1604                                                                               self.their_to_self_delay, funding_redeemscript.clone(), self.channel_value_satoshis,
1605                                                                               self.get_commitment_transaction_number_obscure_factor(),
1606                                                                               local_commitment_tx);
1607
1608                                 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(), logger);
1609
1610                                 channel_monitor
1611                         } }
1612                 }
1613
1614                 let channel_monitor = create_monitor!();
1615
1616                 assert_eq!(self.channel_state & (ChannelState::MonitorUpdateFailed as u32), 0); // We have no had any monitor(s) yet to fail update!
1617                 self.channel_state = ChannelState::FundingSent as u32;
1618                 self.cur_local_commitment_transaction_number -= 1;
1619                 self.cur_remote_commitment_transaction_number -= 1;
1620
1621                 Ok(channel_monitor)
1622         }
1623
1624         pub fn funding_locked(&mut self, msg: &msgs::FundingLocked) -> Result<(), ChannelError> {
1625                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1626                         return Err(ChannelError::Close("Peer sent funding_locked when we needed a channel_reestablish".to_owned()));
1627                 }
1628
1629                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
1630
1631                 if non_shutdown_state == ChannelState::FundingSent as u32 {
1632                         self.channel_state |= ChannelState::TheirFundingLocked as u32;
1633                 } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
1634                         self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
1635                         self.update_time_counter += 1;
1636                 } else if (self.channel_state & (ChannelState::ChannelFunded as u32) != 0 &&
1637                                  // Note that funding_signed/funding_created will have decremented both by 1!
1638                                  self.cur_local_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1 &&
1639                                  self.cur_remote_commitment_transaction_number == INITIAL_COMMITMENT_NUMBER - 1) ||
1640                                 // If we reconnected before sending our funding locked they may still resend theirs:
1641                                 (self.channel_state & (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) ==
1642                                                       (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32)) {
1643                         if self.their_cur_commitment_point != Some(msg.next_per_commitment_point) {
1644                                 return Err(ChannelError::Close("Peer sent a reconnect funding_locked with a different point".to_owned()));
1645                         }
1646                         // They probably disconnected/reconnected and re-sent the funding_locked, which is required
1647                         return Ok(());
1648                 } else {
1649                         return Err(ChannelError::Close("Peer sent a funding_locked at a strange time".to_owned()));
1650                 }
1651
1652                 self.their_prev_commitment_point = self.their_cur_commitment_point;
1653                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
1654                 Ok(())
1655         }
1656
1657         /// Returns (inbound_htlc_count, htlc_inbound_value_msat)
1658         fn get_inbound_pending_htlc_stats(&self) -> (u32, u64) {
1659                 let mut htlc_inbound_value_msat = 0;
1660                 for ref htlc in self.pending_inbound_htlcs.iter() {
1661                         htlc_inbound_value_msat += htlc.amount_msat;
1662                 }
1663                 (self.pending_inbound_htlcs.len() as u32, htlc_inbound_value_msat)
1664         }
1665
1666         /// Returns (outbound_htlc_count, htlc_outbound_value_msat) *including* pending adds in our
1667         /// holding cell.
1668         fn get_outbound_pending_htlc_stats(&self) -> (u32, u64) {
1669                 let mut htlc_outbound_value_msat = 0;
1670                 for ref htlc in self.pending_outbound_htlcs.iter() {
1671                         htlc_outbound_value_msat += htlc.amount_msat;
1672                 }
1673
1674                 let mut htlc_outbound_count = self.pending_outbound_htlcs.len();
1675                 for update in self.holding_cell_htlc_updates.iter() {
1676                         if let &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, .. } = update {
1677                                 htlc_outbound_count += 1;
1678                                 htlc_outbound_value_msat += amount_msat;
1679                         }
1680                 }
1681
1682                 (htlc_outbound_count as u32, htlc_outbound_value_msat)
1683         }
1684
1685         /// Get the available (ie not including pending HTLCs) inbound and outbound balance in msat.
1686         /// Doesn't bother handling the
1687         /// if-we-removed-it-already-but-haven't-fully-resolved-they-can-still-send-an-inbound-HTLC
1688         /// corner case properly.
1689         pub fn get_inbound_outbound_available_balance_msat(&self) -> (u64, u64) {
1690                 // Note that we have to handle overflow due to the above case.
1691                 (cmp::max(self.channel_value_satoshis as i64 * 1000 - self.value_to_self_msat as i64 - self.get_inbound_pending_htlc_stats().1 as i64, 0) as u64,
1692                 cmp::max(self.value_to_self_msat as i64 - self.get_outbound_pending_htlc_stats().1 as i64, 0) as u64)
1693         }
1694
1695         // Get the fee cost of a commitment tx with a given number of HTLC outputs.
1696         // Note that num_htlcs should not include dust HTLCs.
1697         fn commit_tx_fee_msat(&self, num_htlcs: usize) -> u64 {
1698                 // Note that we need to divide before multiplying to round properly,
1699                 // since the lowest denomination of bitcoin on-chain is the satoshi.
1700                 (COMMITMENT_TX_BASE_WEIGHT + num_htlcs as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC) * self.feerate_per_kw as u64 / 1000 * 1000
1701         }
1702
1703         // Get the commitment tx fee for the local (i.e our) next commitment transaction
1704         // based on the number of pending HTLCs that are on track to be in our next
1705         // commitment tx. `addl_htcs` is an optional parameter allowing the caller
1706         // to add a number of additional HTLCs to the calculation. Note that dust
1707         // HTLCs are excluded.
1708         fn next_local_commit_tx_fee_msat(&self, addl_htlcs: usize) -> u64 {
1709                 assert!(self.channel_outbound);
1710
1711                 let mut their_acked_htlcs = self.pending_inbound_htlcs.len();
1712                 for ref htlc in self.pending_outbound_htlcs.iter() {
1713                         if htlc.amount_msat / 1000 <= self.our_dust_limit_satoshis {
1714                                 continue
1715                         }
1716                         match htlc.state {
1717                                 OutboundHTLCState::Committed => their_acked_htlcs += 1,
1718                                 OutboundHTLCState::RemoteRemoved {..} => their_acked_htlcs += 1,
1719                                 OutboundHTLCState::LocalAnnounced {..} => their_acked_htlcs += 1,
1720                                 _ => {},
1721                         }
1722                 }
1723
1724                 for htlc in self.holding_cell_htlc_updates.iter() {
1725                         match htlc {
1726                                 &HTLCUpdateAwaitingACK::AddHTLC { .. } => their_acked_htlcs += 1,
1727                                 _ => {},
1728                         }
1729                 }
1730
1731                 self.commit_tx_fee_msat(their_acked_htlcs + addl_htlcs)
1732         }
1733
1734         // Get the commitment tx fee for the remote's next commitment transaction
1735         // based on the number of pending HTLCs that are on track to be in their
1736         // next commitment tx. `addl_htcs` is an optional parameter allowing the caller
1737         // to add a number of additional HTLCs to the calculation. Note that dust HTLCs
1738         // are excluded.
1739         fn next_remote_commit_tx_fee_msat(&self, addl_htlcs: usize) -> u64 {
1740                 assert!(!self.channel_outbound);
1741
1742                 // When calculating the set of HTLCs which will be included in their next
1743                 // commitment_signed, all inbound HTLCs are included (as all states imply it will be
1744                 // included) and only committed outbound HTLCs, see below.
1745                 let mut their_acked_htlcs = self.pending_inbound_htlcs.len();
1746                 for ref htlc in self.pending_outbound_htlcs.iter() {
1747                         if htlc.amount_msat / 1000 <= self.their_dust_limit_satoshis {
1748                                 continue
1749                         }
1750                         // We only include outbound HTLCs if it will not be included in their next
1751                         // commitment_signed, i.e. if they've responded to us with an RAA after announcement.
1752                         match htlc.state {
1753                                 OutboundHTLCState::Committed => their_acked_htlcs += 1,
1754                                 OutboundHTLCState::RemoteRemoved {..} => their_acked_htlcs += 1,
1755                                 _ => {},
1756                         }
1757                 }
1758
1759                 self.commit_tx_fee_msat(their_acked_htlcs + addl_htlcs)
1760         }
1761
1762         pub fn update_add_htlc<F, L: Deref>(&mut self, msg: &msgs::UpdateAddHTLC, mut pending_forward_status: PendingHTLCStatus, create_pending_htlc_status: F, logger: &L) -> Result<(), ChannelError>
1763         where F: for<'a> Fn(&'a Self, PendingHTLCStatus, u16) -> PendingHTLCStatus, L::Target: Logger {
1764                 // We can't accept HTLCs sent after we've sent a shutdown.
1765                 let local_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::LocalShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1766                 if local_sent_shutdown {
1767                         pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|20);
1768                 }
1769                 // If the remote has sent a shutdown prior to adding this HTLC, then they are in violation of the spec.
1770                 let remote_sent_shutdown = (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32);
1771                 if remote_sent_shutdown {
1772                         return Err(ChannelError::Close("Got add HTLC message when channel was not in an operational state".to_owned()));
1773                 }
1774                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1775                         return Err(ChannelError::Close("Peer sent update_add_htlc when we needed a channel_reestablish".to_owned()));
1776                 }
1777                 if msg.amount_msat > self.channel_value_satoshis * 1000 {
1778                         return Err(ChannelError::Close("Remote side tried to send more than the total value of the channel".to_owned()));
1779                 }
1780                 if msg.amount_msat == 0 {
1781                         return Err(ChannelError::Close("Remote side tried to send a 0-msat HTLC".to_owned()));
1782                 }
1783                 if msg.amount_msat < self.our_htlc_minimum_msat {
1784                         return Err(ChannelError::Close(format!("Remote side tried to send less than our minimum HTLC value. Lower limit: ({}). Actual: ({})", self.our_htlc_minimum_msat, msg.amount_msat)));
1785                 }
1786
1787                 let (inbound_htlc_count, htlc_inbound_value_msat) = self.get_inbound_pending_htlc_stats();
1788                 if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 {
1789                         return Err(ChannelError::Close(format!("Remote tried to push more than our max accepted HTLCs ({})", OUR_MAX_HTLCS)));
1790                 }
1791                 let our_max_htlc_value_in_flight_msat = Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis);
1792                 if htlc_inbound_value_msat + msg.amount_msat > our_max_htlc_value_in_flight_msat {
1793                         return Err(ChannelError::Close(format!("Remote HTLC add would put them over our max HTLC value ({})", our_max_htlc_value_in_flight_msat)));
1794                 }
1795                 // Check remote_channel_reserve_satoshis (we're getting paid, so they have to at least meet
1796                 // the reserve_satoshis we told them to always have as direct payment so that they lose
1797                 // something if we punish them for broadcasting an old state).
1798                 // Note that we don't really care about having a small/no to_remote output in our local
1799                 // commitment transactions, as the purpose of the channel reserve is to ensure we can
1800                 // punish *them* if they misbehave, so we discount any outbound HTLCs which will not be
1801                 // present in the next commitment transaction we send them (at least for fulfilled ones,
1802                 // failed ones won't modify value_to_self).
1803                 // Note that we will send HTLCs which another instance of rust-lightning would think
1804                 // violate the reserve value if we do not do this (as we forget inbound HTLCs from the
1805                 // Channel state once they will not be present in the next received commitment
1806                 // transaction).
1807                 let mut removed_outbound_total_msat = 0;
1808                 for ref htlc in self.pending_outbound_htlcs.iter() {
1809                         if let OutboundHTLCState::AwaitingRemoteRevokeToRemove(None) = htlc.state {
1810                                 removed_outbound_total_msat += htlc.amount_msat;
1811                         } else if let OutboundHTLCState::AwaitingRemovedRemoteRevoke(None) = htlc.state {
1812                                 removed_outbound_total_msat += htlc.amount_msat;
1813                         }
1814                 }
1815
1816                 let pending_value_to_self_msat =
1817                         self.value_to_self_msat + htlc_inbound_value_msat - removed_outbound_total_msat;
1818                 let pending_remote_value_msat =
1819                         self.channel_value_satoshis * 1000 - pending_value_to_self_msat;
1820                 if pending_remote_value_msat < msg.amount_msat {
1821                         return Err(ChannelError::Close("Remote HTLC add would overdraw remaining funds".to_owned()));
1822                 }
1823
1824                 // Check that the remote can afford to pay for this HTLC on-chain at the current
1825                 // feerate_per_kw, while maintaining their channel reserve (as required by the spec).
1826                 let remote_commit_tx_fee_msat = if self.channel_outbound { 0 } else {
1827                         // +1 for this HTLC.
1828                         self.next_remote_commit_tx_fee_msat(1)
1829                 };
1830                 if pending_remote_value_msat - msg.amount_msat < remote_commit_tx_fee_msat {
1831                         return Err(ChannelError::Close("Remote HTLC add would not leave enough to pay for fees".to_owned()));
1832                 };
1833
1834                 let chan_reserve_msat =
1835                         Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis) * 1000;
1836                 if pending_remote_value_msat - msg.amount_msat - remote_commit_tx_fee_msat < chan_reserve_msat {
1837                         return Err(ChannelError::Close("Remote HTLC add would put them under remote reserve value".to_owned()));
1838                 }
1839
1840                 if !self.channel_outbound {
1841                         // `+1` for this HTLC, `2 *` and `+1` fee spike buffer we keep for the remote. This deviates from the
1842                         // spec because in the spec, the fee spike buffer requirement doesn't exist on the receiver's side,
1843                         // only on the sender's.
1844                         // Note that when we eventually remove support for fee updates and switch to anchor output fees,
1845                         // we will drop the `2 *`, since we no longer be as sensitive to fee spikes. But, keep the extra +1
1846                         // as we should still be able to afford adding this HTLC plus one more future HTLC, regardless of
1847                         // being sensitive to fee spikes.
1848                         let remote_fee_cost_incl_stuck_buffer_msat = 2 * self.next_remote_commit_tx_fee_msat(1 + 1);
1849                         if pending_remote_value_msat - msg.amount_msat - chan_reserve_msat < remote_fee_cost_incl_stuck_buffer_msat {
1850                                 // Note that if the pending_forward_status is not updated here, then it's because we're already failing
1851                                 // the HTLC, i.e. its status is already set to failing.
1852                                 log_info!(logger, "Attempting to fail HTLC due to fee spike buffer violation");
1853                                 pending_forward_status = create_pending_htlc_status(self, pending_forward_status, 0x1000|7);
1854                         }
1855                 } else {
1856                         // Check that they won't violate our local required channel reserve by adding this HTLC.
1857
1858                         // +1 for this HTLC.
1859                         let local_commit_tx_fee_msat = self.next_local_commit_tx_fee_msat(1);
1860                         if self.value_to_self_msat < self.local_channel_reserve_satoshis * 1000 + local_commit_tx_fee_msat {
1861                                 return Err(ChannelError::Close("Cannot receive value that would put us under local channel reserve value".to_owned()));
1862                         }
1863                 }
1864
1865                 if self.next_remote_htlc_id != msg.htlc_id {
1866                         return Err(ChannelError::Close(format!("Remote skipped HTLC ID (skipped ID: {})", self.next_remote_htlc_id)));
1867                 }
1868                 if msg.cltv_expiry >= 500000000 {
1869                         return Err(ChannelError::Close("Remote provided CLTV expiry in seconds instead of block height".to_owned()));
1870                 }
1871
1872                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1873                         if let PendingHTLCStatus::Forward(_) = pending_forward_status {
1874                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1875                         }
1876                 }
1877
1878                 // Now update local state:
1879                 self.next_remote_htlc_id += 1;
1880                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1881                         htlc_id: msg.htlc_id,
1882                         amount_msat: msg.amount_msat,
1883                         payment_hash: msg.payment_hash,
1884                         cltv_expiry: msg.cltv_expiry,
1885                         state: InboundHTLCState::RemoteAnnounced(pending_forward_status),
1886                 });
1887                 Ok(())
1888         }
1889
1890         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1891         #[inline]
1892         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1893                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1894                         if htlc.htlc_id == htlc_id {
1895                                 match check_preimage {
1896                                         None => {},
1897                                         Some(payment_hash) =>
1898                                                 if payment_hash != htlc.payment_hash {
1899                                                         return Err(ChannelError::Close(format!("Remote tried to fulfill HTLC ({}) with an incorrect preimage", htlc_id)));
1900                                                 }
1901                                 };
1902                                 match htlc.state {
1903                                         OutboundHTLCState::LocalAnnounced(_) =>
1904                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) before it had been committed", htlc_id))),
1905                                         OutboundHTLCState::Committed => {
1906                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1907                                         },
1908                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1909                                                 return Err(ChannelError::Close(format!("Remote tried to fulfill/fail HTLC ({}) that they'd already fulfilled/failed", htlc_id))),
1910                                 }
1911                                 return Ok(&htlc.source);
1912                         }
1913                 }
1914                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find".to_owned()))
1915         }
1916
1917         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1918                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1919                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state".to_owned()));
1920                 }
1921                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1922                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish".to_owned()));
1923                 }
1924
1925                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1926                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1927         }
1928
1929         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1930                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1931                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state".to_owned()));
1932                 }
1933                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1934                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish".to_owned()));
1935                 }
1936
1937                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1938                 Ok(())
1939         }
1940
1941         pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1942                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1943                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state".to_owned()));
1944                 }
1945                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1946                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish".to_owned()));
1947                 }
1948
1949                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1950                 Ok(())
1951         }
1952
1953         pub fn commitment_signed<F: Deref, L: Deref>(&mut self, msg: &msgs::CommitmentSigned, fee_estimator: &F, logger: &L) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate), (Option<ChannelMonitorUpdate>, ChannelError)>
1954         where F::Target: FeeEstimator,
1955                                 L::Target: Logger
1956         {
1957                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1958                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state".to_owned())));
1959                 }
1960                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1961                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish".to_owned())));
1962                 }
1963                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1964                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds".to_owned())));
1965                 }
1966
1967                 let funding_script = self.get_funding_redeemscript();
1968
1969                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1970
1971                 let mut update_fee = false;
1972                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1973                         update_fee = true;
1974                         self.pending_update_fee.unwrap()
1975                 } else {
1976                         self.feerate_per_kw
1977                 };
1978
1979                 let mut local_commitment_tx = {
1980                         let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw, logger);
1981                         let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1982                         (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1983                 };
1984                 let local_commitment_txid = local_commitment_tx.0.txid();
1985                 let local_sighash = hash_to_message!(&bip143::SighashComponents::new(&local_commitment_tx.0).sighash_all(&local_commitment_tx.0.input[0], &funding_script, self.channel_value_satoshis)[..]);
1986                 log_trace!(logger, "Checking commitment tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.signature.serialize_compact()[..]), log_bytes!(self.their_funding_pubkey().serialize()), encode::serialize_hex(&local_commitment_tx.0), log_bytes!(local_sighash[..]), encode::serialize_hex(&funding_script));
1987                 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1988                         return Err((None, ChannelError::Close("Invalid commitment tx signature from peer".to_owned())));
1989                 }
1990
1991                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1992                 if update_fee {
1993                         let num_htlcs = local_commitment_tx.1;
1994                         let total_fee = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1995
1996                         let remote_reserve_we_require = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
1997                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + remote_reserve_we_require {
1998                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee".to_owned())));
1999                         }
2000                 }
2001
2002                 if msg.htlc_signatures.len() != local_commitment_tx.1 {
2003                         return Err((None, ChannelError::Close(format!("Got wrong number of HTLC signatures ({}) from remote. It must be {}", msg.htlc_signatures.len(), local_commitment_tx.1))));
2004                 }
2005
2006                 // TODO: Merge these two, sadly they are currently both required to be passed separately to
2007                 // ChannelMonitor:
2008                 let mut htlcs_without_source = Vec::with_capacity(local_commitment_tx.2.len());
2009                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
2010                 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
2011                         if let Some(_) = htlc.transaction_output_index {
2012                                 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
2013                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
2014                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
2015                                 log_trace!(logger, "Checking HTLC tx signature {} by key {} against tx {} (sighash {}) with redeemscript {}", log_bytes!(msg.htlc_signatures[idx].serialize_compact()[..]), log_bytes!(local_keys.b_htlc_key.serialize()), encode::serialize_hex(&htlc_tx), log_bytes!(htlc_sighash[..]), encode::serialize_hex(&htlc_redeemscript));
2016                                 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
2017                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer".to_owned())));
2018                                 }
2019                                 htlcs_without_source.push((htlc.clone(), Some(msg.htlc_signatures[idx])));
2020                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
2021                         } else {
2022                                 htlcs_without_source.push((htlc.clone(), None));
2023                                 htlcs_and_sigs.push((htlc, None, source));
2024                         }
2025                 }
2026
2027                 let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number - 1, &self.secp_ctx);
2028                 let per_commitment_secret = self.local_keys.release_commitment_secret(self.cur_local_commitment_transaction_number + 1);
2029
2030                 // Update state now that we've passed all the can-fail calls...
2031                 let mut need_our_commitment = false;
2032                 if !self.channel_outbound {
2033                         if let Some(fee_update) = self.pending_update_fee {
2034                                 self.feerate_per_kw = fee_update;
2035                                 // We later use the presence of pending_update_fee to indicate we should generate a
2036                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
2037                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
2038                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
2039                                         need_our_commitment = true;
2040                                         self.pending_update_fee = None;
2041                                 }
2042                         }
2043                 }
2044
2045                 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2046
2047                 self.latest_monitor_update_id += 1;
2048                 let mut monitor_update = ChannelMonitorUpdate {
2049                         update_id: self.latest_monitor_update_id,
2050                         updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
2051                                 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_commitment_tx.0, msg.signature.clone(), &self.local_keys.pubkeys().funding_pubkey, &their_funding_pubkey, local_keys, self.feerate_per_kw, htlcs_without_source),
2052                                 htlc_outputs: htlcs_and_sigs
2053                         }]
2054                 };
2055
2056                 for htlc in self.pending_inbound_htlcs.iter_mut() {
2057                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
2058                                 Some(forward_info.clone())
2059                         } else { None };
2060                         if let Some(forward_info) = new_forward {
2061                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
2062                                 need_our_commitment = true;
2063                         }
2064                 }
2065                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2066                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
2067                                 Some(fail_reason.take())
2068                         } else { None } {
2069                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
2070                                 need_our_commitment = true;
2071                         }
2072                 }
2073
2074                 self.cur_local_commitment_transaction_number -= 1;
2075                 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
2076                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
2077                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
2078
2079                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
2080                         // In case we initially failed monitor updating without requiring a response, we need
2081                         // to make sure the RAA gets sent first.
2082                         self.monitor_pending_revoke_and_ack = true;
2083                         if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2084                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
2085                                 // the corresponding HTLC status updates so that get_last_commitment_update
2086                                 // includes the right HTLCs.
2087                                 self.monitor_pending_commitment_signed = true;
2088                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2089                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2090                                 // strictly increasing by one, so decrement it here.
2091                                 self.latest_monitor_update_id = monitor_update.update_id;
2092                                 monitor_update.updates.append(&mut additional_update.updates);
2093                         }
2094                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
2095                         // re-send the message on restoration)
2096                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA".to_owned())));
2097                 }
2098
2099                 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
2100                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
2101                         // we'll send one right away when we get the revoke_and_ack when we
2102                         // free_holding_cell_htlcs().
2103                         let (msg, mut additional_update) = self.send_commitment_no_status_check(logger).map_err(|e| (None, e))?;
2104                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2105                         // strictly increasing by one, so decrement it here.
2106                         self.latest_monitor_update_id = monitor_update.update_id;
2107                         monitor_update.updates.append(&mut additional_update.updates);
2108                         (Some(msg), None)
2109                 } else if !need_our_commitment {
2110                         (None, self.maybe_propose_first_closing_signed(fee_estimator))
2111                 } else { (None, None) };
2112
2113                 Ok((msgs::RevokeAndACK {
2114                         channel_id: self.channel_id,
2115                         per_commitment_secret: per_commitment_secret,
2116                         next_per_commitment_point: next_per_commitment_point,
2117                 }, our_commitment_signed, closing_signed, monitor_update))
2118         }
2119
2120         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
2121         /// fulfilling or failing the last pending HTLC)
2122         fn free_holding_cell_htlcs<L: Deref>(&mut self, logger: &L) -> Result<(Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>), ChannelError> where L::Target: Logger {
2123                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2124                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
2125                         log_trace!(logger, "Freeing holding cell with {} HTLC updates{}", self.holding_cell_htlc_updates.len(), if self.holding_cell_update_fee.is_some() { " and a fee update" } else { "" });
2126
2127                         let mut monitor_update = ChannelMonitorUpdate {
2128                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
2129                                 updates: Vec::new(),
2130                         };
2131
2132                         let mut htlc_updates = Vec::new();
2133                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
2134                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
2135                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
2136                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
2137                         let mut htlcs_to_fail = Vec::new();
2138                         for htlc_update in htlc_updates.drain(..) {
2139                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
2140                                 // fee races with adding too many outputs which push our total payments just over
2141                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
2142                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2143                                 // to rebalance channels.
2144                                 match &htlc_update {
2145                                         &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2146                                                 match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2147                                                         Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2148                                                         Err(e) => {
2149                                                                 match e {
2150                                                                         ChannelError::Ignore(ref msg) => {
2151                                                                                 log_info!(logger, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2152                                                                                 // If we fail to send here, then this HTLC should
2153                                                                                 // be failed backwards. Failing to send here
2154                                                                                 // indicates that this HTLC may keep being put back
2155                                                                                 // into the holding cell without ever being
2156                                                                                 // successfully forwarded/failed/fulfilled, causing
2157                                                                                 // our counterparty to eventually close on us.
2158                                                                                 htlcs_to_fail.push((source.clone(), *payment_hash));
2159                                                                         },
2160                                                                         _ => {
2161                                                                                 panic!("Got a non-IgnoreError action trying to send holding cell HTLC");
2162                                                                         },
2163                                                                 }
2164                                                         }
2165                                                 }
2166                                         },
2167                                         &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2168                                                 match self.get_update_fulfill_htlc(htlc_id, *payment_preimage, logger) {
2169                                                         Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2170                                                                 update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2171                                                                 if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2172                                                                         monitor_update.updates.append(&mut additional_monitor_update.updates);
2173                                                                 }
2174                                                         },
2175                                                         Err(e) => {
2176                                                                 if let ChannelError::Ignore(_) = e {}
2177                                                                 else {
2178                                                                         panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2179                                                                 }
2180                                                         }
2181                                                 }
2182                                         },
2183                                         &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2184                                                 match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2185                                                         Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2186                                                         Err(e) => {
2187                                                                 if let ChannelError::Ignore(_) = e {}
2188                                                                 else {
2189                                                                         panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2190                                                                 }
2191                                                         }
2192                                                 }
2193                                         },
2194                                 }
2195                         }
2196                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2197                                 return Ok((None, htlcs_to_fail));
2198                         }
2199                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2200                                 self.pending_update_fee = self.holding_cell_update_fee.take();
2201                                 Some(msgs::UpdateFee {
2202                                         channel_id: self.channel_id,
2203                                         feerate_per_kw: feerate as u32,
2204                                 })
2205                         } else {
2206                                 None
2207                         };
2208
2209                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2210                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2211                         // but we want them to be strictly increasing by one, so reset it here.
2212                         self.latest_monitor_update_id = monitor_update.update_id;
2213                         monitor_update.updates.append(&mut additional_update.updates);
2214
2215                         Ok((Some((msgs::CommitmentUpdate {
2216                                 update_add_htlcs,
2217                                 update_fulfill_htlcs,
2218                                 update_fail_htlcs,
2219                                 update_fail_malformed_htlcs: Vec::new(),
2220                                 update_fee: update_fee,
2221                                 commitment_signed,
2222                         }, monitor_update)), htlcs_to_fail))
2223                 } else {
2224                         Ok((None, Vec::new()))
2225                 }
2226         }
2227
2228         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2229         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2230         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2231         /// generating an appropriate error *after* the channel state has been updated based on the
2232         /// revoke_and_ack message.
2233         pub fn revoke_and_ack<F: Deref, L: Deref>(&mut self, msg: &msgs::RevokeAndACK, fee_estimator: &F, logger: &L) -> Result<(Option<msgs::CommitmentUpdate>, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, Option<msgs::ClosingSigned>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2234                 where F::Target: FeeEstimator,
2235                                         L::Target: Logger,
2236         {
2237                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2238                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state".to_owned()));
2239                 }
2240                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2241                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish".to_owned()));
2242                 }
2243                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2244                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds".to_owned()));
2245                 }
2246
2247                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2248                         if PublicKey::from_secret_key(&self.secp_ctx, &secp_check!(SecretKey::from_slice(&msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret".to_owned())) != their_prev_commitment_point {
2249                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey".to_owned()));
2250                         }
2251                 }
2252
2253                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2254                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
2255                         // haven't given them a new commitment transaction to broadcast). We should probably
2256                         // take advantage of this by updating our channel monitor, sending them an error, and
2257                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2258                         // lot of work, and there's some chance this is all a misunderstanding anyway.
2259                         // We have to do *something*, though, since our signer may get mad at us for otherwise
2260                         // jumping a remote commitment number, so best to just force-close and move on.
2261                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack".to_owned()));
2262                 }
2263
2264                 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2265                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one".to_owned()))?;
2266                 self.latest_monitor_update_id += 1;
2267                 let mut monitor_update = ChannelMonitorUpdate {
2268                         update_id: self.latest_monitor_update_id,
2269                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2270                                 idx: self.cur_remote_commitment_transaction_number + 1,
2271                                 secret: msg.per_commitment_secret,
2272                         }],
2273                 };
2274
2275                 // Update state now that we've passed all the can-fail calls...
2276                 // (note that we may still fail to generate the new commitment_signed message, but that's
2277                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2278                 // channel based on that, but stepping stuff here should be safe either way.
2279                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2280                 self.their_prev_commitment_point = self.their_cur_commitment_point;
2281                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2282                 self.cur_remote_commitment_transaction_number -= 1;
2283
2284                 log_trace!(logger, "Updating HTLCs on receipt of RAA...");
2285                 let mut to_forward_infos = Vec::new();
2286                 let mut revoked_htlcs = Vec::new();
2287                 let mut update_fail_htlcs = Vec::new();
2288                 let mut update_fail_malformed_htlcs = Vec::new();
2289                 let mut require_commitment = false;
2290                 let mut value_to_self_msat_diff: i64 = 0;
2291
2292                 {
2293                         // Take references explicitly so that we can hold multiple references to self.
2294                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2295                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2296
2297                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2298                         pending_inbound_htlcs.retain(|htlc| {
2299                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2300                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2301                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2302                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2303                                         }
2304                                         false
2305                                 } else { true }
2306                         });
2307                         pending_outbound_htlcs.retain(|htlc| {
2308                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2309                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2310                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2311                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2312                                         } else {
2313                                                 // They fulfilled, so we sent them money
2314                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2315                                         }
2316                                         false
2317                                 } else { true }
2318                         });
2319                         for htlc in pending_inbound_htlcs.iter_mut() {
2320                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2321                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2322                                         true
2323                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2324                                         log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2325                                         true
2326                                 } else { false };
2327                                 if swap {
2328                                         let mut state = InboundHTLCState::Committed;
2329                                         mem::swap(&mut state, &mut htlc.state);
2330
2331                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2332                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2333                                                 require_commitment = true;
2334                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2335                                                 match forward_info {
2336                                                         PendingHTLCStatus::Fail(fail_msg) => {
2337                                                                 require_commitment = true;
2338                                                                 match fail_msg {
2339                                                                         HTLCFailureMsg::Relay(msg) => {
2340                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2341                                                                                 update_fail_htlcs.push(msg)
2342                                                                         },
2343                                                                         HTLCFailureMsg::Malformed(msg) => {
2344                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2345                                                                                 update_fail_malformed_htlcs.push(msg)
2346                                                                         },
2347                                                                 }
2348                                                         },
2349                                                         PendingHTLCStatus::Forward(forward_info) => {
2350                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2351                                                                 htlc.state = InboundHTLCState::Committed;
2352                                                         }
2353                                                 }
2354                                         }
2355                                 }
2356                         }
2357                         for htlc in pending_outbound_htlcs.iter_mut() {
2358                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2359                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2360                                         htlc.state = OutboundHTLCState::Committed;
2361                                 }
2362                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2363                                         Some(fail_reason.take())
2364                                 } else { None } {
2365                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2366                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2367                                         require_commitment = true;
2368                                 }
2369                         }
2370                 }
2371                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2372
2373                 if self.channel_outbound {
2374                         if let Some(feerate) = self.pending_update_fee.take() {
2375                                 self.feerate_per_kw = feerate;
2376                         }
2377                 } else {
2378                         if let Some(feerate) = self.pending_update_fee {
2379                                 // Because a node cannot send two commitment_signeds in a row without getting a
2380                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2381                                 // it should use to create keys with) and because a node can't send a
2382                                 // commitment_signed without changes, checking if the feerate is equal to the
2383                                 // pending feerate update is sufficient to detect require_commitment.
2384                                 if feerate == self.feerate_per_kw {
2385                                         require_commitment = true;
2386                                         self.pending_update_fee = None;
2387                                 }
2388                         }
2389                 }
2390
2391                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2392                         // We can't actually generate a new commitment transaction (incl by freeing holding
2393                         // cells) while we can't update the monitor, so we just return what we have.
2394                         if require_commitment {
2395                                 self.monitor_pending_commitment_signed = true;
2396                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2397                                 // which does not update state, but we're definitely now awaiting a remote revoke
2398                                 // before we can step forward any more, so set it here.
2399                                 let (_, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2400                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2401                                 // strictly increasing by one, so decrement it here.
2402                                 self.latest_monitor_update_id = monitor_update.update_id;
2403                                 monitor_update.updates.append(&mut additional_update.updates);
2404                         }
2405                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2406                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2407                         return Ok((None, Vec::new(), Vec::new(), None, monitor_update, Vec::new()))
2408                 }
2409
2410                 match self.free_holding_cell_htlcs(logger)? {
2411                         (Some((mut commitment_update, mut additional_update)), htlcs_to_fail) => {
2412                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2413                                 for fail_msg in update_fail_htlcs.drain(..) {
2414                                         commitment_update.update_fail_htlcs.push(fail_msg);
2415                                 }
2416                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2417                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2418                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2419                                 }
2420
2421                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2422                                 // strictly increasing by one, so decrement it here.
2423                                 self.latest_monitor_update_id = monitor_update.update_id;
2424                                 monitor_update.updates.append(&mut additional_update.updates);
2425
2426                                 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2427                         },
2428                         (None, htlcs_to_fail) => {
2429                                 if require_commitment {
2430                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check(logger)?;
2431
2432                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2433                                         // strictly increasing by one, so decrement it here.
2434                                         self.latest_monitor_update_id = monitor_update.update_id;
2435                                         monitor_update.updates.append(&mut additional_update.updates);
2436
2437                                         Ok((Some(msgs::CommitmentUpdate {
2438                                                 update_add_htlcs: Vec::new(),
2439                                                 update_fulfill_htlcs: Vec::new(),
2440                                                 update_fail_htlcs,
2441                                                 update_fail_malformed_htlcs,
2442                                                 update_fee: None,
2443                                                 commitment_signed
2444                                         }), to_forward_infos, revoked_htlcs, None, monitor_update, htlcs_to_fail))
2445                                 } else {
2446                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update, htlcs_to_fail))
2447                                 }
2448                         }
2449                 }
2450
2451         }
2452
2453         /// Adds a pending update to this channel. See the doc for send_htlc for
2454         /// further details on the optionness of the return value.
2455         /// You MUST call send_commitment prior to any other calls on this Channel
2456         fn send_update_fee(&mut self, feerate_per_kw: u32) -> Option<msgs::UpdateFee> {
2457                 if !self.channel_outbound {
2458                         panic!("Cannot send fee from inbound channel");
2459                 }
2460                 if !self.is_usable() {
2461                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2462                 }
2463                 if !self.is_live() {
2464                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2465                 }
2466
2467                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2468                         self.holding_cell_update_fee = Some(feerate_per_kw);
2469                         return None;
2470                 }
2471
2472                 debug_assert!(self.pending_update_fee.is_none());
2473                 self.pending_update_fee = Some(feerate_per_kw);
2474
2475                 Some(msgs::UpdateFee {
2476                         channel_id: self.channel_id,
2477                         feerate_per_kw: feerate_per_kw,
2478                 })
2479         }
2480
2481         pub fn send_update_fee_and_commit<L: Deref>(&mut self, feerate_per_kw: u32, logger: &L) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
2482                 match self.send_update_fee(feerate_per_kw) {
2483                         Some(update_fee) => {
2484                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
2485                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2486                         },
2487                         None => Ok(None)
2488                 }
2489         }
2490
2491         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2492         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2493         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2494         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2495         /// No further message handling calls may be made until a channel_reestablish dance has
2496         /// completed.
2497         pub fn remove_uncommitted_htlcs_and_mark_paused<L: Deref>(&mut self, logger: &L) -> Vec<(HTLCSource, PaymentHash)> where L::Target: Logger {
2498                 let mut outbound_drops = Vec::new();
2499
2500                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2501                 if self.channel_state < ChannelState::FundingSent as u32 {
2502                         self.channel_state = ChannelState::ShutdownComplete as u32;
2503                         return outbound_drops;
2504                 }
2505                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2506                 // will be retransmitted.
2507                 self.last_sent_closing_fee = None;
2508
2509                 let mut inbound_drop_count = 0;
2510                 self.pending_inbound_htlcs.retain(|htlc| {
2511                         match htlc.state {
2512                                 InboundHTLCState::RemoteAnnounced(_) => {
2513                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2514                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2515                                         // this HTLC accordingly
2516                                         inbound_drop_count += 1;
2517                                         false
2518                                 },
2519                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2520                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2521                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2522                                         // in response to it yet, so don't touch it.
2523                                         true
2524                                 },
2525                                 InboundHTLCState::Committed => true,
2526                                 InboundHTLCState::LocalRemoved(_) => {
2527                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2528                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2529                                         // (that we missed). Keep this around for now and if they tell us they missed
2530                                         // the commitment_signed we can re-transmit the update then.
2531                                         true
2532                                 },
2533                         }
2534                 });
2535                 self.next_remote_htlc_id -= inbound_drop_count;
2536
2537                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2538                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2539                                 // They sent us an update to remove this but haven't yet sent the corresponding
2540                                 // commitment_signed, we need to move it back to Committed and they can re-send
2541                                 // the update upon reconnection.
2542                                 htlc.state = OutboundHTLCState::Committed;
2543                         }
2544                 }
2545
2546                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2547                         match htlc_update {
2548                                 // Note that currently on channel reestablish we assert that there are
2549                                 // no holding cell HTLC update_adds, so if in the future we stop
2550                                 // dropping added HTLCs here and failing them backwards, then there will
2551                                 // need to be corresponding changes made in the Channel's re-establish
2552                                 // logic.
2553                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2554                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2555                                         false
2556                                 },
2557                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2558                         }
2559                 });
2560                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2561                 log_debug!(logger, "Peer disconnection resulted in {} remote-announced HTLC drops and {} waiting-to-locally-announced HTLC drops on channel {}", outbound_drops.len(), inbound_drop_count, log_bytes!(self.channel_id()));
2562                 outbound_drops
2563         }
2564
2565         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2566         /// updates are partially paused.
2567         /// This must be called immediately after the call which generated the ChannelMonitor update
2568         /// which failed. The messages which were generated from that call which generated the
2569         /// monitor update failure must *not* have been sent to the remote end, and must instead
2570         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2571         pub fn monitor_update_failed(&mut self, resend_raa: bool, resend_commitment: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>, mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>) {
2572                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2573                 self.monitor_pending_revoke_and_ack = resend_raa;
2574                 self.monitor_pending_commitment_signed = resend_commitment;
2575                 assert!(self.monitor_pending_forwards.is_empty());
2576                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2577                 assert!(self.monitor_pending_failures.is_empty());
2578                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2579                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2580         }
2581
2582         /// Indicates that the latest ChannelMonitor update has been committed by the client
2583         /// successfully and we should restore normal operation. Returns messages which should be sent
2584         /// to the remote side.
2585         pub fn monitor_updating_restored<L: Deref>(&mut self, logger: &L) -> (Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder, Vec<(PendingHTLCInfo, u64)>, Vec<(HTLCSource, PaymentHash, HTLCFailReason)>, bool, Option<msgs::FundingLocked>) where L::Target: Logger {
2586                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2587                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2588
2589                 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2590
2591                 // Because we will never generate a FundingBroadcastSafe event when we're in
2592                 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2593                 // they received the FundingBroadcastSafe event, we can only ever hit
2594                 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2595                 // monitor on funding_created, and we even got the funding transaction confirmed before the
2596                 // monitor was persisted.
2597                 let funding_locked = if self.monitor_pending_funding_locked {
2598                         assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2599                         self.monitor_pending_funding_locked = false;
2600                         let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
2601                         Some(msgs::FundingLocked {
2602                                 channel_id: self.channel_id(),
2603                                 next_per_commitment_point: next_per_commitment_point,
2604                         })
2605                 } else { None };
2606
2607                 let mut forwards = Vec::new();
2608                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2609                 let mut failures = Vec::new();
2610                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2611
2612                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2613                         self.monitor_pending_revoke_and_ack = false;
2614                         self.monitor_pending_commitment_signed = false;
2615                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2616                 }
2617
2618                 let raa = if self.monitor_pending_revoke_and_ack {
2619                         Some(self.get_last_revoke_and_ack())
2620                 } else { None };
2621                 let commitment_update = if self.monitor_pending_commitment_signed {
2622                         Some(self.get_last_commitment_update(logger))
2623                 } else { None };
2624
2625                 self.monitor_pending_revoke_and_ack = false;
2626                 self.monitor_pending_commitment_signed = false;
2627                 let order = self.resend_order.clone();
2628                 log_trace!(logger, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2629                         if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2630                         if commitment_update.is_some() { "a" } else { "no" },
2631                         if raa.is_some() { "an" } else { "no" },
2632                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2633                 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2634         }
2635
2636         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2637                 where F::Target: FeeEstimator
2638         {
2639                 if self.channel_outbound {
2640                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee".to_owned()));
2641                 }
2642                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2643                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish".to_owned()));
2644                 }
2645                 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2646                 self.pending_update_fee = Some(msg.feerate_per_kw);
2647                 self.update_time_counter += 1;
2648                 Ok(())
2649         }
2650
2651         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2652                 let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
2653                 let per_commitment_secret = self.local_keys.release_commitment_secret(self.cur_local_commitment_transaction_number + 2);
2654                 msgs::RevokeAndACK {
2655                         channel_id: self.channel_id,
2656                         per_commitment_secret,
2657                         next_per_commitment_point,
2658                 }
2659         }
2660
2661         fn get_last_commitment_update<L: Deref>(&self, logger: &L) -> msgs::CommitmentUpdate where L::Target: Logger {
2662                 let mut update_add_htlcs = Vec::new();
2663                 let mut update_fulfill_htlcs = Vec::new();
2664                 let mut update_fail_htlcs = Vec::new();
2665                 let mut update_fail_malformed_htlcs = Vec::new();
2666
2667                 for htlc in self.pending_outbound_htlcs.iter() {
2668                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2669                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2670                                         channel_id: self.channel_id(),
2671                                         htlc_id: htlc.htlc_id,
2672                                         amount_msat: htlc.amount_msat,
2673                                         payment_hash: htlc.payment_hash,
2674                                         cltv_expiry: htlc.cltv_expiry,
2675                                         onion_routing_packet: (**onion_packet).clone(),
2676                                 });
2677                         }
2678                 }
2679
2680                 for htlc in self.pending_inbound_htlcs.iter() {
2681                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2682                                 match reason {
2683                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2684                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2685                                                         channel_id: self.channel_id(),
2686                                                         htlc_id: htlc.htlc_id,
2687                                                         reason: err_packet.clone()
2688                                                 });
2689                                         },
2690                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2691                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2692                                                         channel_id: self.channel_id(),
2693                                                         htlc_id: htlc.htlc_id,
2694                                                         sha256_of_onion: sha256_of_onion.clone(),
2695                                                         failure_code: failure_code.clone(),
2696                                                 });
2697                                         },
2698                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2699                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2700                                                         channel_id: self.channel_id(),
2701                                                         htlc_id: htlc.htlc_id,
2702                                                         payment_preimage: payment_preimage.clone(),
2703                                                 });
2704                                         },
2705                                 }
2706                         }
2707                 }
2708
2709                 log_trace!(logger, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2710                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2711                 msgs::CommitmentUpdate {
2712                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2713                         update_fee: None,
2714                         commitment_signed: self.send_commitment_no_state_update(logger).expect("It looks like we failed to re-generate a commitment_signed we had previously sent?").0,
2715                 }
2716         }
2717
2718         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2719         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2720         pub fn channel_reestablish<L: Deref>(&mut self, msg: &msgs::ChannelReestablish, logger: &L) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, Option<ChannelMonitorUpdate>, RAACommitmentOrder, Option<msgs::Shutdown>), ChannelError> where L::Target: Logger {
2721                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2722                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2723                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2724                         // just close here instead of trying to recover.
2725                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect".to_owned()));
2726                 }
2727
2728                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2729                         msg.next_local_commitment_number == 0 {
2730                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish".to_owned()));
2731                 }
2732
2733                 if msg.next_remote_commitment_number > 0 {
2734                         match msg.data_loss_protect {
2735                                 OptionalField::Present(ref data_loss) => {
2736                                         let expected_point = self.local_keys.get_per_commitment_point(INITIAL_COMMITMENT_NUMBER - msg.next_remote_commitment_number + 1, &self.secp_ctx);
2737                                         let given_secret = SecretKey::from_slice(&data_loss.your_last_per_commitment_secret)
2738                                                 .map_err(|_| ChannelError::Close("Peer sent a garbage channel_reestablish with unparseable secret key".to_owned()))?;
2739                                         if expected_point != PublicKey::from_secret_key(&self.secp_ctx, &given_secret) {
2740                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided".to_owned()));
2741                                         }
2742                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2743                                                 return Err(ChannelError::CloseDelayBroadcast(
2744                                                         "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting".to_owned()
2745                                                 ));
2746                                         }
2747                                 },
2748                                 OptionalField::Absent => {}
2749                         }
2750                 }
2751
2752                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2753                 // remaining cases either succeed or ErrorMessage-fail).
2754                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2755
2756                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2757                         Some(msgs::Shutdown {
2758                                 channel_id: self.channel_id,
2759                                 scriptpubkey: self.get_closing_scriptpubkey(),
2760                         })
2761                 } else { None };
2762
2763                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2764                         // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2765                         if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2766                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2767                                 if msg.next_remote_commitment_number != 0 {
2768                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet".to_owned()));
2769                                 }
2770                                 // Short circuit the whole handler as there is nothing we can resend them
2771                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2772                         }
2773
2774                         // We have OurFundingLocked set!
2775                         let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
2776                         return Ok((Some(msgs::FundingLocked {
2777                                 channel_id: self.channel_id(),
2778                                 next_per_commitment_point: next_per_commitment_point,
2779                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2780                 }
2781
2782                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2783                         // Remote isn't waiting on any RevokeAndACK from us!
2784                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2785                         None
2786                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2787                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2788                                 self.monitor_pending_revoke_and_ack = true;
2789                                 None
2790                         } else {
2791                                 Some(self.get_last_revoke_and_ack())
2792                         }
2793                 } else {
2794                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction".to_owned()));
2795                 };
2796
2797                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2798                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2799                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2800                 // the corresponding revoke_and_ack back yet.
2801                 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 };
2802
2803                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2804                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2805                         let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
2806                         Some(msgs::FundingLocked {
2807                                 channel_id: self.channel_id(),
2808                                 next_per_commitment_point: next_per_commitment_point,
2809                         })
2810                 } else { None };
2811
2812                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2813                         if required_revoke.is_some() {
2814                                 log_debug!(logger, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2815                         } else {
2816                                 log_debug!(logger, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2817                         }
2818
2819                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2820                                 // Note that if in the future we no longer drop holding cell update_adds on peer
2821                                 // disconnect, this logic will need to be updated.
2822                                 for htlc_update in self.holding_cell_htlc_updates.iter() {
2823                                         if let &HTLCUpdateAwaitingACK::AddHTLC { .. } = htlc_update {
2824                                                 debug_assert!(false, "There shouldn't be any add-HTLCs in the holding cell now because they should have been dropped on peer disconnect. Panic here because said HTLCs won't be handled correctly.");
2825                                         }
2826                                 }
2827
2828                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2829                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2830                                 // have received some updates while we were disconnected. Free the holding cell
2831                                 // now!
2832                                 match self.free_holding_cell_htlcs(logger) {
2833                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2834                                         Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast(_)) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2835                                         Ok((Some((commitment_update, monitor_update)), htlcs_to_fail)) => {
2836                                                 // If in the future we no longer drop holding cell update_adds on peer
2837                                                 // disconnect, we may be handed some HTLCs to fail backwards here.
2838                                                 assert!(htlcs_to_fail.is_empty());
2839                                                 return Ok((resend_funding_locked, required_revoke, Some(commitment_update), Some(monitor_update), self.resend_order.clone(), shutdown_msg));
2840                                         },
2841                                         Ok((None, htlcs_to_fail)) => {
2842                                                 // If in the future we no longer drop holding cell update_adds on peer
2843                                                 // disconnect, we may be handed some HTLCs to fail backwards here.
2844                                                 assert!(htlcs_to_fail.is_empty());
2845                                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2846                                         },
2847                                 }
2848                         } else {
2849                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2850                         }
2851                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2852                         if required_revoke.is_some() {
2853                                 log_debug!(logger, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2854                         } else {
2855                                 log_debug!(logger, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2856                         }
2857
2858                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2859                                 self.monitor_pending_commitment_signed = true;
2860                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2861                         }
2862
2863                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update(logger)), None, self.resend_order.clone(), shutdown_msg));
2864                 } else {
2865                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction".to_owned()));
2866                 }
2867         }
2868
2869         fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2870                 where F::Target: FeeEstimator
2871         {
2872                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2873                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2874                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2875                         return None;
2876                 }
2877
2878                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2879                 if self.feerate_per_kw > proposed_feerate {
2880                         proposed_feerate = self.feerate_per_kw;
2881                 }
2882                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2883                 let proposed_total_fee_satoshis = proposed_feerate as u64 * tx_weight / 1000;
2884
2885                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2886                 let our_sig = self.local_keys
2887                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2888                         .ok();
2889                 if our_sig.is_none() { return None; }
2890
2891                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2892                 Some(msgs::ClosingSigned {
2893                         channel_id: self.channel_id,
2894                         fee_satoshis: total_fee_satoshis,
2895                         signature: our_sig.unwrap(),
2896                 })
2897         }
2898
2899         pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2900                 where F::Target: FeeEstimator
2901         {
2902                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2903                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish".to_owned()));
2904                 }
2905                 if self.channel_state < ChannelState::FundingSent as u32 {
2906                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2907                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2908                         // can do that via error message without getting a connection fail anyway...
2909                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation".to_owned()));
2910                 }
2911                 for htlc in self.pending_inbound_htlcs.iter() {
2912                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2913                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs".to_owned()));
2914                         }
2915                 }
2916                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2917
2918                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2919                 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2920                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2921                         return Err(ChannelError::Close(format!("Got shutdown_scriptpubkey ({}) of absurd length from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
2922                 }
2923
2924                 //Check shutdown_scriptpubkey form as BOLT says we must
2925                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2926                         return Err(ChannelError::Close(format!("Got a nonstandard scriptpubkey ({}) from remote peer", msg.scriptpubkey.to_bytes().to_hex())));
2927                 }
2928
2929                 if self.their_shutdown_scriptpubkey.is_some() {
2930                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2931                                 return Err(ChannelError::Close(format!("Got shutdown request with a scriptpubkey ({}) which did not match their previous scriptpubkey.", msg.scriptpubkey.to_bytes().to_hex())));
2932                         }
2933                 } else {
2934                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2935                 }
2936
2937                 // From here on out, we may not fail!
2938
2939                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2940                 self.update_time_counter += 1;
2941
2942                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2943                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2944                 // cell HTLCs and return them to fail the payment.
2945                 self.holding_cell_update_fee = None;
2946                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2947                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2948                         match htlc_update {
2949                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2950                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2951                                         false
2952                                 },
2953                                 _ => true
2954                         }
2955                 });
2956                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2957                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2958                 // any further commitment updates after we set LocalShutdownSent.
2959
2960                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2961                         None
2962                 } else {
2963                         Some(msgs::Shutdown {
2964                                 channel_id: self.channel_id,
2965                                 scriptpubkey: self.get_closing_scriptpubkey(),
2966                         })
2967                 };
2968
2969                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2970                 self.update_time_counter += 1;
2971
2972                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2973         }
2974
2975         fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2976                 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2977                 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2978                 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2979
2980                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2981
2982                 let our_funding_key = self.local_keys.pubkeys().funding_pubkey.serialize();
2983                 let their_funding_key = self.their_funding_pubkey().serialize();
2984                 if our_funding_key[..] < their_funding_key[..] {
2985                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2986                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2987                 } else {
2988                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2989                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2990                 }
2991                 tx.input[0].witness[1].push(SigHashType::All as u8);
2992                 tx.input[0].witness[2].push(SigHashType::All as u8);
2993
2994                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2995         }
2996
2997         pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2998                 where F::Target: FeeEstimator
2999         {
3000                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
3001                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown".to_owned()));
3002                 }
3003                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
3004                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish".to_owned()));
3005                 }
3006                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
3007                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs".to_owned()));
3008                 }
3009                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
3010                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee".to_owned()));
3011                 }
3012
3013                 let funding_redeemscript = self.get_funding_redeemscript();
3014                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
3015                 if used_total_fee != msg.fee_satoshis {
3016                         return Err(ChannelError::Close(format!("Remote sent us a closing_signed with a fee greater than the value they can claim. Fee in message: {}", msg.fee_satoshis)));
3017                 }
3018                 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
3019
3020                 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
3021
3022                 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
3023                         Ok(_) => {},
3024                         Err(_e) => {
3025                                 // The remote end may have decided to revoke their output due to inconsistent dust
3026                                 // limits, so check for that case by re-checking the signature here.
3027                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
3028                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
3029                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer".to_owned());
3030                         },
3031                 };
3032
3033                 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
3034                         if last_fee == msg.fee_satoshis {
3035                                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
3036                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3037                                 self.update_time_counter += 1;
3038                                 return Ok((None, Some(closing_tx)));
3039                         }
3040                 }
3041
3042                 macro_rules! propose_new_feerate {
3043                         ($new_feerate: expr) => {
3044                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
3045                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate as u64 * closing_tx_max_weight / 1000, false);
3046                                 let our_sig = self.local_keys
3047                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3048                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3049                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
3050                                 return Ok((Some(msgs::ClosingSigned {
3051                                         channel_id: self.channel_id,
3052                                         fee_satoshis: used_total_fee,
3053                                         signature: our_sig,
3054                                 }), None))
3055                         }
3056                 }
3057
3058                 let proposed_sat_per_kw = msg.fee_satoshis  * 1000 / closing_tx.get_weight() as u64;
3059                 if self.channel_outbound {
3060                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3061                         if (proposed_sat_per_kw as u32) > our_max_feerate {
3062                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3063                                         if our_max_feerate <= last_feerate {
3064                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something higher ({}) than our Normal feerate ({})", last_feerate, our_max_feerate)));
3065                                         }
3066                                 }
3067                                 propose_new_feerate!(our_max_feerate);
3068                         }
3069                 } else {
3070                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
3071                         if (proposed_sat_per_kw as u32) < our_min_feerate {
3072                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
3073                                         if our_min_feerate >= last_feerate {
3074                                                 return Err(ChannelError::Close(format!("Unable to come to consensus about closing feerate, remote wanted something lower ({}) than our Background feerate ({}).", last_feerate, our_min_feerate)));
3075                                         }
3076                                 }
3077                                 propose_new_feerate!(our_min_feerate);
3078                         }
3079                 }
3080
3081                 let our_sig = self.local_keys
3082                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
3083                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction".to_owned()))?;
3084                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
3085
3086                 self.channel_state = ChannelState::ShutdownComplete as u32;
3087                 self.update_time_counter += 1;
3088
3089                 Ok((Some(msgs::ClosingSigned {
3090                         channel_id: self.channel_id,
3091                         fee_satoshis: msg.fee_satoshis,
3092                         signature: our_sig,
3093                 }), Some(closing_tx)))
3094         }
3095
3096         // Public utilities:
3097
3098         pub fn channel_id(&self) -> [u8; 32] {
3099                 self.channel_id
3100         }
3101
3102         /// Gets the "user_id" value passed into the construction of this channel. It has no special
3103         /// meaning and exists only to allow users to have a persistent identifier of a channel.
3104         pub fn get_user_id(&self) -> u64 {
3105                 self.user_id
3106         }
3107
3108         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
3109         /// is_usable() returns true).
3110         /// Allowed in any state (including after shutdown)
3111         pub fn get_short_channel_id(&self) -> Option<u64> {
3112                 self.short_channel_id
3113         }
3114
3115         /// Returns the funding_txo we either got from our peer, or were given by
3116         /// get_outbound_funding_created.
3117         pub fn get_funding_txo(&self) -> Option<OutPoint> {
3118                 self.funding_txo
3119         }
3120
3121         /// Allowed in any state (including after shutdown)
3122         pub fn get_their_node_id(&self) -> PublicKey {
3123                 self.their_node_id
3124         }
3125
3126         /// Allowed in any state (including after shutdown)
3127         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
3128                 self.our_htlc_minimum_msat
3129         }
3130
3131         /// Allowed in any state (including after shutdown)
3132         pub fn get_announced_htlc_max_msat(&self) -> u64 {
3133                 return cmp::min(
3134                         // Upper bound by capacity. We make it a bit less than full capacity to prevent attempts
3135                         // to use full capacity. This is an effort to reduce routing failures, because in many cases
3136                         // channel might have been used to route very small values (either by honest users or as DoS).
3137                         self.channel_value_satoshis * 9 / 10,
3138
3139                         Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis)
3140                 );
3141         }
3142
3143         /// Allowed in any state (including after shutdown)
3144         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
3145                 self.our_htlc_minimum_msat
3146         }
3147
3148         pub fn get_value_satoshis(&self) -> u64 {
3149                 self.channel_value_satoshis
3150         }
3151
3152         pub fn get_fee_proportional_millionths(&self) -> u32 {
3153                 self.config.fee_proportional_millionths
3154         }
3155
3156         #[cfg(test)]
3157         pub fn get_feerate(&self) -> u32 {
3158                 self.feerate_per_kw
3159         }
3160
3161         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
3162                 self.cur_local_commitment_transaction_number + 1
3163         }
3164
3165         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
3166                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3167         }
3168
3169         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
3170                 self.cur_remote_commitment_transaction_number + 2
3171         }
3172
3173         #[cfg(test)]
3174         pub fn get_local_keys(&self) -> &ChanSigner {
3175                 &self.local_keys
3176         }
3177
3178         #[cfg(test)]
3179         pub fn get_value_stat(&self) -> ChannelValueStat {
3180                 ChannelValueStat {
3181                         value_to_self_msat: self.value_to_self_msat,
3182                         channel_value_msat: self.channel_value_satoshis * 1000,
3183                         channel_reserve_msat: self.local_channel_reserve_satoshis * 1000,
3184                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3185                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3186                         holding_cell_outbound_amount_msat: {
3187                                 let mut res = 0;
3188                                 for h in self.holding_cell_htlc_updates.iter() {
3189                                         match h {
3190                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3191                                                         res += amount_msat;
3192                                                 }
3193                                                 _ => {}
3194                                         }
3195                                 }
3196                                 res
3197                         },
3198                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3199                         their_dust_limit_msat: self.their_dust_limit_satoshis * 1000,
3200                 }
3201         }
3202
3203         /// Allowed in any state (including after shutdown)
3204         pub fn get_update_time_counter(&self) -> u32 {
3205                 self.update_time_counter
3206         }
3207
3208         pub fn get_latest_monitor_update_id(&self) -> u64 {
3209                 self.latest_monitor_update_id
3210         }
3211
3212         pub fn should_announce(&self) -> bool {
3213                 self.config.announced_channel
3214         }
3215
3216         pub fn is_outbound(&self) -> bool {
3217                 self.channel_outbound
3218         }
3219
3220         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3221         /// Allowed in any state (including after shutdown)
3222         pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3223                 where F::Target: FeeEstimator
3224         {
3225                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3226                 // output value back into a transaction with the regular channel output:
3227
3228                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3229                 let mut res = self.feerate_per_kw as u64 * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3230
3231                 if self.channel_outbound {
3232                         // + the marginal fee increase cost to us in the commitment transaction:
3233                         res += self.feerate_per_kw as u64 * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3234                 }
3235
3236                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3237                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) as u64 * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3238
3239                 res as u32
3240         }
3241
3242         /// Returns true if we've ever received a message from the remote end for this Channel
3243         pub fn have_received_message(&self) -> bool {
3244                 self.channel_state > (ChannelState::OurInitSent as u32)
3245         }
3246
3247         /// Returns true if this channel is fully established and not known to be closing.
3248         /// Allowed in any state (including after shutdown)
3249         pub fn is_usable(&self) -> bool {
3250                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3251                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3252         }
3253
3254         /// Returns true if this channel is currently available for use. This is a superset of
3255         /// is_usable() and considers things like the channel being temporarily disabled.
3256         /// Allowed in any state (including after shutdown)
3257         pub fn is_live(&self) -> bool {
3258                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3259         }
3260
3261         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3262         /// Allowed in any state (including after shutdown)
3263         pub fn is_awaiting_monitor_update(&self) -> bool {
3264                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3265         }
3266
3267         /// Returns true if funding_created was sent/received.
3268         pub fn is_funding_initiated(&self) -> bool {
3269                 self.channel_state >= ChannelState::FundingSent as u32
3270         }
3271
3272         /// Returns true if this channel is fully shut down. True here implies that no further actions
3273         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3274         /// will be handled appropriately by the chain monitor.
3275         pub fn is_shutdown(&self) -> bool {
3276                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
3277                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3278                         true
3279                 } else { false }
3280         }
3281
3282         pub fn to_disabled_staged(&mut self) {
3283                 self.network_sync = UpdateStatus::DisabledStaged;
3284         }
3285
3286         pub fn to_disabled_marked(&mut self) {
3287                 self.network_sync = UpdateStatus::DisabledMarked;
3288         }
3289
3290         pub fn to_fresh(&mut self) {
3291                 self.network_sync = UpdateStatus::Fresh;
3292         }
3293
3294         pub fn is_disabled_staged(&self) -> bool {
3295                 self.network_sync == UpdateStatus::DisabledStaged
3296         }
3297
3298         pub fn is_disabled_marked(&self) -> bool {
3299                 self.network_sync == UpdateStatus::DisabledMarked
3300         }
3301
3302         /// When we receive a new block, we (a) check whether the block contains the funding
3303         /// transaction (which would start us counting blocks until we send the funding_signed), and
3304         /// (b) check the height of the block against outbound holding cell HTLCs in case we need to
3305         /// give up on them prematurely and time them out. Everything else (e.g. commitment
3306         /// transaction broadcasts, channel closure detection, HTLC transaction broadcasting, etc) is
3307         /// handled by the ChannelMonitor.
3308         ///
3309         /// If we return Err, the channel may have been closed, at which point the standard
3310         /// requirements apply - no calls may be made except those explicitly stated to be allowed
3311         /// post-shutdown.
3312         /// Only returns an ErrorAction of DisconnectPeer, if Err.
3313         ///
3314         /// May return some HTLCs (and their payment_hash) which have timed out and should be failed
3315         /// back.
3316         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[usize]) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage> {
3317                 let mut timed_out_htlcs = Vec::new();
3318                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3319                         match htlc_update {
3320                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, ref cltv_expiry, .. } => {
3321                                         if *cltv_expiry <= height + HTLC_FAIL_BACK_BUFFER {
3322                                                 timed_out_htlcs.push((source.clone(), payment_hash.clone()));
3323                                                 false
3324                                         } else { true }
3325                                 },
3326                                 _ => true
3327                         }
3328                 });
3329                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3330                 if header.bitcoin_hash() != self.last_block_connected {
3331                         if self.funding_tx_confirmations > 0 {
3332                                 self.funding_tx_confirmations += 1;
3333                         }
3334                 }
3335                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3336                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3337                                 if tx.txid() == self.funding_txo.unwrap().txid {
3338                                         let txo_idx = self.funding_txo.unwrap().index as usize;
3339                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3340                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
3341                                                 if self.channel_outbound {
3342                                                         // If we generated the funding transaction and it doesn't match what it
3343                                                         // should, the client is really broken and we should just panic and
3344                                                         // tell them off. That said, because hash collisions happen with high
3345                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
3346                                                         // channel and move on.
3347                                                         #[cfg(not(feature = "fuzztarget"))]
3348                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3349                                                 }
3350                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3351                                                 self.update_time_counter += 1;
3352                                                 return Err(msgs::ErrorMessage {
3353                                                         channel_id: self.channel_id(),
3354                                                         data: "funding tx had wrong script/value".to_owned()
3355                                                 });
3356                                         } else {
3357                                                 if self.channel_outbound {
3358                                                         for input in tx.input.iter() {
3359                                                                 if input.witness.is_empty() {
3360                                                                         // We generated a malleable funding transaction, implying we've
3361                                                                         // just exposed ourselves to funds loss to our counterparty.
3362                                                                         #[cfg(not(feature = "fuzztarget"))]
3363                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3364                                                                 }
3365                                                         }
3366                                                 }
3367                                                 if height > 0xff_ff_ff || (*index_in_block) > 0xff_ff_ff {
3368                                                         panic!("Block was bogus - either height 16 million or had > 16 million transactions");
3369                                                 }
3370                                                 assert!(txo_idx <= 0xffff); // txo_idx is a (u16 as usize), so this is just listed here for completeness
3371                                                 self.funding_tx_confirmations = 1;
3372                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
3373                                                                              ((*index_in_block as u64) << (2*8)) |
3374                                                                              ((txo_idx as u64)         << (0*8)));
3375                                         }
3376                                 }
3377                         }
3378                 }
3379                 if header.bitcoin_hash() != self.last_block_connected {
3380                         self.last_block_connected = header.bitcoin_hash();
3381                         self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3382                         if self.funding_tx_confirmations > 0 {
3383                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3384                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3385                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
3386                                                 true
3387                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3388                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3389                                                 self.update_time_counter += 1;
3390                                                 true
3391                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3392                                                 // We got a reorg but not enough to trigger a force close, just update
3393                                                 // funding_tx_confirmed_in and return.
3394                                                 false
3395                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3396                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3397                                         } else {
3398                                                 // We got a reorg but not enough to trigger a force close, just update
3399                                                 // funding_tx_confirmed_in and return.
3400                                                 false
3401                                         };
3402                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3403
3404                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3405                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3406                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3407                                         //a protocol oversight, but I assume I'm just missing something.
3408                                         if need_commitment_update {
3409                                                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3410                                                         let next_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
3411                                                         return Ok((Some(msgs::FundingLocked {
3412                                                                 channel_id: self.channel_id,
3413                                                                 next_per_commitment_point: next_per_commitment_point,
3414                                                         }), timed_out_htlcs));
3415                                                 } else {
3416                                                         self.monitor_pending_funding_locked = true;
3417                                                         return Ok((None, timed_out_htlcs));
3418                                                 }
3419                                         }
3420                                 }
3421                         }
3422                 }
3423                 Ok((None, timed_out_htlcs))
3424         }
3425
3426         /// Called by channelmanager based on chain blocks being disconnected.
3427         /// Returns true if we need to close the channel now due to funding transaction
3428         /// unconfirmation/reorg.
3429         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3430                 if self.funding_tx_confirmations > 0 {
3431                         self.funding_tx_confirmations -= 1;
3432                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3433                                 return true;
3434                         }
3435                 }
3436                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3437                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3438                 }
3439                 self.last_block_connected = header.bitcoin_hash();
3440                 false
3441         }
3442
3443         // Methods to get unprompted messages to send to the remote end (or where we already returned
3444         // something in the handler for the message that prompted this message):
3445
3446         pub fn get_open_channel(&self, chain_hash: BlockHash) -> msgs::OpenChannel {
3447                 if !self.channel_outbound {
3448                         panic!("Tried to open a channel for an inbound channel?");
3449                 }
3450                 if self.channel_state != ChannelState::OurInitSent as u32 {
3451                         panic!("Cannot generate an open_channel after we've moved forward");
3452                 }
3453
3454                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3455                         panic!("Tried to send an open_channel for a channel that has already advanced");
3456                 }
3457
3458                 let first_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
3459                 let local_keys = self.local_keys.pubkeys();
3460
3461                 msgs::OpenChannel {
3462                         chain_hash: chain_hash,
3463                         temporary_channel_id: self.channel_id,
3464                         funding_satoshis: self.channel_value_satoshis,
3465                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3466                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3467                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3468                         channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3469                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3470                         feerate_per_kw: self.feerate_per_kw as u32,
3471                         to_self_delay: self.our_to_self_delay,
3472                         max_accepted_htlcs: OUR_MAX_HTLCS,
3473                         funding_pubkey: local_keys.funding_pubkey,
3474                         revocation_basepoint: local_keys.revocation_basepoint,
3475                         payment_point: local_keys.payment_point,
3476                         delayed_payment_basepoint: local_keys.delayed_payment_basepoint,
3477                         htlc_basepoint: local_keys.htlc_basepoint,
3478                         first_per_commitment_point,
3479                         channel_flags: if self.config.announced_channel {1} else {0},
3480                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3481                 }
3482         }
3483
3484         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3485                 if self.channel_outbound {
3486                         panic!("Tried to send accept_channel for an outbound channel?");
3487                 }
3488                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3489                         panic!("Tried to send accept_channel after channel had moved forward");
3490                 }
3491                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3492                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3493                 }
3494
3495                 let first_per_commitment_point = self.local_keys.get_per_commitment_point(self.cur_local_commitment_transaction_number, &self.secp_ctx);
3496                 let local_keys = self.local_keys.pubkeys();
3497
3498                 msgs::AcceptChannel {
3499                         temporary_channel_id: self.channel_id,
3500                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3501                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3502                         channel_reserve_satoshis: Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis),
3503                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3504                         minimum_depth: self.minimum_depth,
3505                         to_self_delay: self.our_to_self_delay,
3506                         max_accepted_htlcs: OUR_MAX_HTLCS,
3507                         funding_pubkey: local_keys.funding_pubkey,
3508                         revocation_basepoint: local_keys.revocation_basepoint,
3509                         payment_point: local_keys.payment_point,
3510                         delayed_payment_basepoint: local_keys.delayed_payment_basepoint,
3511                         htlc_basepoint: local_keys.htlc_basepoint,
3512                         first_per_commitment_point,
3513                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3514                 }
3515         }
3516
3517         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3518         fn get_outbound_funding_created_signature<L: Deref>(&mut self, logger: &L) -> Result<Signature, ChannelError> where L::Target: Logger {
3519                 let remote_keys = self.build_remote_transaction_keys()?;
3520                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw, logger).0;
3521                 let pre_remote_keys = PreCalculatedTxCreationKeys::new(remote_keys);
3522                 Ok(self.local_keys.sign_remote_commitment(self.feerate_per_kw, &remote_initial_commitment_tx, &pre_remote_keys, &Vec::new(), &self.secp_ctx)
3523                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?.0)
3524         }
3525
3526         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3527         /// a funding_created message for the remote peer.
3528         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3529         /// or if called on an inbound channel.
3530         /// Note that channel_id changes during this call!
3531         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3532         /// If an Err is returned, it is a ChannelError::Close.
3533         pub fn get_outbound_funding_created<L: Deref>(&mut self, funding_txo: OutPoint, logger: &L) -> Result<msgs::FundingCreated, ChannelError> where L::Target: Logger {
3534                 if !self.channel_outbound {
3535                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3536                 }
3537                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3538                         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)");
3539                 }
3540                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3541                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3542                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3543                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3544                 }
3545
3546                 self.funding_txo = Some(funding_txo.clone());
3547                 let our_signature = match self.get_outbound_funding_created_signature(logger) {
3548                         Ok(res) => res,
3549                         Err(e) => {
3550                                 log_error!(logger, "Got bad signatures: {:?}!", e);
3551                                 self.funding_txo = None;
3552                                 return Err(e);
3553                         }
3554                 };
3555
3556                 let temporary_channel_id = self.channel_id;
3557
3558                 // Now that we're past error-generating stuff, update our local state:
3559
3560                 self.channel_state = ChannelState::FundingCreated as u32;
3561                 self.channel_id = funding_txo.to_channel_id();
3562
3563                 Ok(msgs::FundingCreated {
3564                         temporary_channel_id,
3565                         funding_txid: funding_txo.txid,
3566                         funding_output_index: funding_txo.index,
3567                         signature: our_signature
3568                 })
3569         }
3570
3571         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3572         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3573         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3574         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3575         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3576         /// closing).
3577         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3578         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3579         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: BlockHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3580                 if !self.config.announced_channel {
3581                         return Err(ChannelError::Ignore("Channel is not available for public announcements".to_owned()));
3582                 }
3583                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3584                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked".to_owned()));
3585                 }
3586                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3587                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing".to_owned()));
3588                 }
3589
3590                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3591
3592                 let msg = msgs::UnsignedChannelAnnouncement {
3593                         features: ChannelFeatures::known(),
3594                         chain_hash: chain_hash,
3595                         short_channel_id: self.get_short_channel_id().unwrap(),
3596                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3597                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3598                         bitcoin_key_1: if were_node_one { self.local_keys.pubkeys().funding_pubkey } else { self.their_funding_pubkey().clone() },
3599                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { self.local_keys.pubkeys().funding_pubkey },
3600                         excess_data: Vec::new(),
3601                 };
3602
3603                 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3604                         .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement".to_owned()))?;
3605
3606                 Ok((msg, sig))
3607         }
3608
3609         /// May panic if called on a channel that wasn't immediately-previously
3610         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3611         pub fn get_channel_reestablish<L: Deref>(&self, logger: &L) -> msgs::ChannelReestablish where L::Target: Logger {
3612                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3613                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3614                 // Prior to static_remotekey, my_current_per_commitment_point was critical to claiming
3615                 // current to_remote balances. However, it no longer has any use, and thus is now simply
3616                 // set to a dummy (but valid, as required by the spec) public key.
3617                 // fuzztarget mode marks a subset of pubkeys as invalid so that we can hit "invalid pubkey"
3618                 // branches, but we unwrap it below, so we arbitrarily select a dummy pubkey which is both
3619                 // valid, and valid in fuzztarget mode's arbitrary validity criteria:
3620                 let mut pk = [2; 33]; pk[1] = 0xff;
3621                 let dummy_pubkey = PublicKey::from_slice(&pk).unwrap();
3622                 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3623                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3624                         log_trace!(logger, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3625                         OptionalField::Present(DataLossProtect {
3626                                 your_last_per_commitment_secret: remote_last_secret,
3627                                 my_current_per_commitment_point: dummy_pubkey
3628                         })
3629                 } else {
3630                         log_info!(logger, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3631                         OptionalField::Present(DataLossProtect {
3632                                 your_last_per_commitment_secret: [0;32],
3633                                 my_current_per_commitment_point: dummy_pubkey,
3634                         })
3635                 };
3636                 msgs::ChannelReestablish {
3637                         channel_id: self.channel_id(),
3638                         // The protocol has two different commitment number concepts - the "commitment
3639                         // transaction number", which starts from 0 and counts up, and the "revocation key
3640                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3641                         // commitment transaction numbers by the index which will be used to reveal the
3642                         // revocation key for that commitment transaction, which means we have to convert them
3643                         // to protocol-level commitment numbers here...
3644
3645                         // next_local_commitment_number is the next commitment_signed number we expect to
3646                         // receive (indicating if they need to resend one that we missed).
3647                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3648                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3649                         // receive, however we track it by the next commitment number for a remote transaction
3650                         // (which is one further, as they always revoke previous commitment transaction, not
3651                         // the one we send) so we have to decrement by 1. Note that if
3652                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3653                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3654                         // overflow here.
3655                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3656                         data_loss_protect,
3657                 }
3658         }
3659
3660
3661         // Send stuff to our remote peers:
3662
3663         /// Adds a pending outbound HTLC to this channel, note that you probably want
3664         /// send_htlc_and_commit instead cause you'll want both messages at once.
3665         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3666         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3667         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3668         /// You MUST call send_commitment prior to any other calls on this Channel
3669         /// If an Err is returned, it's a ChannelError::Ignore!
3670         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> {
3671                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3672                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down".to_owned()));
3673                 }
3674                 let channel_total_msat = self.channel_value_satoshis * 1000;
3675                 if amount_msat > channel_total_msat {
3676                         return Err(ChannelError::Ignore(format!("Cannot send amount {}, because it is more than the total value of the channel {}", amount_msat, channel_total_msat)));
3677                 }
3678
3679                 if amount_msat == 0 {
3680                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC".to_owned()));
3681                 }
3682
3683                 if amount_msat < self.their_htlc_minimum_msat {
3684                         return Err(ChannelError::Ignore(format!("Cannot send less than their minimum HTLC value ({})", self.their_htlc_minimum_msat)));
3685                 }
3686
3687                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3688                         // Note that this should never really happen, if we're !is_live() on receipt of an
3689                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3690                         // the user to send directly into a !is_live() channel. However, if we
3691                         // disconnected during the time the previous hop was doing the commitment dance we may
3692                         // end up getting here after the forwarding delay. In any case, returning an
3693                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3694                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update".to_owned()));
3695                 }
3696
3697                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3698                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3699                         return Err(ChannelError::Ignore(format!("Cannot push more than their max accepted HTLCs ({})", self.their_max_accepted_htlcs)));
3700                 }
3701                 // Check their_max_htlc_value_in_flight_msat
3702                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3703                         return Err(ChannelError::Ignore(format!("Cannot send value that would put us over the max HTLC value in flight our peer will accept ({})", self.their_max_htlc_value_in_flight_msat)));
3704                 }
3705
3706                 if !self.channel_outbound {
3707                         // Check that we won't violate the remote channel reserve by adding this HTLC.
3708
3709                         let remote_balance_msat = self.channel_value_satoshis * 1000 - self.value_to_self_msat;
3710                         let remote_chan_reserve_msat = Channel::<ChanSigner>::get_remote_channel_reserve_satoshis(self.channel_value_satoshis);
3711                         // 1 additional HTLC corresponding to this HTLC.
3712                         let remote_commit_tx_fee_msat = self.next_remote_commit_tx_fee_msat(1);
3713                         if remote_balance_msat < remote_chan_reserve_msat + remote_commit_tx_fee_msat {
3714                                 return Err(ChannelError::Ignore("Cannot send value that would put them under remote channel reserve value".to_owned()));
3715                         }
3716                 }
3717
3718                 let pending_value_to_self_msat = self.value_to_self_msat - htlc_outbound_value_msat;
3719                 if pending_value_to_self_msat < amount_msat {
3720                         return Err(ChannelError::Ignore(format!("Cannot send value that would overdraw remaining funds. Amount: {}, pending value to self {}", amount_msat, pending_value_to_self_msat)));
3721                 }
3722
3723                 // The `+1` is for the HTLC currently being added to the commitment tx and
3724                 // the `2 *` and `+1` are for the fee spike buffer.
3725                 let local_commit_tx_fee_msat = if self.channel_outbound {
3726                         2 * self.next_local_commit_tx_fee_msat(1 + 1)
3727                 } else { 0 };
3728                 if pending_value_to_self_msat - amount_msat < local_commit_tx_fee_msat {
3729                         return Err(ChannelError::Ignore(format!("Cannot send value that would not leave enough to pay for fees. Pending value to self: {}. local_commit_tx_fee {}", pending_value_to_self_msat, local_commit_tx_fee_msat)));
3730                 }
3731
3732                 // Check self.local_channel_reserve_satoshis (the amount we must keep as
3733                 // reserve for the remote to have something to claim if we misbehave)
3734                 let chan_reserve_msat = self.local_channel_reserve_satoshis * 1000;
3735                 if pending_value_to_self_msat - amount_msat - local_commit_tx_fee_msat < chan_reserve_msat {
3736                         return Err(ChannelError::Ignore(format!("Cannot send value that would put us under local channel reserve value ({})", chan_reserve_msat)));
3737                 }
3738
3739                 // Now update local state:
3740                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3741                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3742                                 amount_msat,
3743                                 payment_hash,
3744                                 cltv_expiry,
3745                                 source,
3746                                 onion_routing_packet,
3747                         });
3748                         return Ok(None);
3749                 }
3750
3751                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3752                         htlc_id: self.next_local_htlc_id,
3753                         amount_msat,
3754                         payment_hash: payment_hash.clone(),
3755                         cltv_expiry,
3756                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3757                         source,
3758                 });
3759
3760                 let res = msgs::UpdateAddHTLC {
3761                         channel_id: self.channel_id,
3762                         htlc_id: self.next_local_htlc_id,
3763                         amount_msat,
3764                         payment_hash,
3765                         cltv_expiry,
3766                         onion_routing_packet,
3767                 };
3768                 self.next_local_htlc_id += 1;
3769
3770                 Ok(Some(res))
3771         }
3772
3773         /// Creates a signed commitment transaction to send to the remote peer.
3774         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3775         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3776         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3777         pub fn send_commitment<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3778                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3779                         panic!("Cannot create commitment tx until channel is fully established");
3780                 }
3781                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3782                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3783                 }
3784                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3785                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3786                 }
3787                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3788                         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");
3789                 }
3790                 let mut have_updates = self.pending_update_fee.is_some();
3791                 for htlc in self.pending_outbound_htlcs.iter() {
3792                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3793                                 have_updates = true;
3794                         }
3795                         if have_updates { break; }
3796                 }
3797                 for htlc in self.pending_inbound_htlcs.iter() {
3798                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3799                                 have_updates = true;
3800                         }
3801                         if have_updates { break; }
3802                 }
3803                 if !have_updates {
3804                         panic!("Cannot create commitment tx until we have some updates to send");
3805                 }
3806                 self.send_commitment_no_status_check(logger)
3807         }
3808         /// Only fails in case of bad keys
3809         fn send_commitment_no_status_check<L: Deref>(&mut self, logger: &L) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> where L::Target: Logger {
3810                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3811                 // fail to generate this, we still are at least at a position where upgrading their status
3812                 // is acceptable.
3813                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3814                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3815                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3816                         } else { None };
3817                         if let Some(state) = new_state {
3818                                 htlc.state = state;
3819                         }
3820                 }
3821                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3822                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3823                                 Some(fail_reason.take())
3824                         } else { None } {
3825                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3826                         }
3827                 }
3828                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3829
3830                 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update(logger) {
3831                         Ok((res, (remote_commitment_tx, mut htlcs))) => {
3832                                 // Update state now that we've passed all the can-fail calls...
3833                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3834                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3835                                 (res, remote_commitment_tx, htlcs_no_ref)
3836                         },
3837                         Err(e) => return Err(e),
3838                 };
3839
3840                 self.latest_monitor_update_id += 1;
3841                 let monitor_update = ChannelMonitorUpdate {
3842                         update_id: self.latest_monitor_update_id,
3843                         updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3844                                 unsigned_commitment_tx: remote_commitment_tx.clone(),
3845                                 htlc_outputs: htlcs.clone(),
3846                                 commitment_number: self.cur_remote_commitment_transaction_number,
3847                                 their_revocation_point: self.their_cur_commitment_point.unwrap()
3848                         }]
3849                 };
3850                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3851                 Ok((res, monitor_update))
3852         }
3853
3854         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3855         /// when we shouldn't change HTLC/channel state.
3856         fn send_commitment_no_state_update<L: Deref>(&self, logger: &L) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> where L::Target: Logger {
3857                 let mut feerate_per_kw = self.feerate_per_kw;
3858                 if let Some(feerate) = self.pending_update_fee {
3859                         if self.channel_outbound {
3860                                 feerate_per_kw = feerate;
3861                         }
3862                 }
3863
3864                 let remote_keys = self.build_remote_transaction_keys()?;
3865                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw, logger);
3866                 let (signature, htlc_signatures);
3867
3868                 {
3869                         let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3870                         for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3871                                 htlcs.push(htlc);
3872                         }
3873
3874                         let pre_remote_keys = PreCalculatedTxCreationKeys::new(remote_keys);
3875                         let res = self.local_keys.sign_remote_commitment(feerate_per_kw, &remote_commitment_tx.0, &pre_remote_keys, &htlcs, &self.secp_ctx)
3876                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed".to_owned()))?;
3877                         signature = res.0;
3878                         htlc_signatures = res.1;
3879                         let remote_keys = pre_remote_keys.trust_key_derivation();
3880
3881                         log_trace!(logger, "Signed remote commitment tx {} with redeemscript {} -> {}",
3882                                 encode::serialize_hex(&remote_commitment_tx.0),
3883                                 encode::serialize_hex(&self.get_funding_redeemscript()),
3884                                 log_bytes!(signature.serialize_compact()[..]));
3885
3886                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3887                                 log_trace!(logger, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3888                                         encode::serialize_hex(&chan_utils::build_htlc_transaction(&remote_commitment_tx.0.txid(), feerate_per_kw, self.our_to_self_delay, htlc, &remote_keys.a_delayed_payment_key, &remote_keys.revocation_key)),
3889                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, remote_keys)),
3890                                         log_bytes!(remote_keys.a_htlc_key.serialize()),
3891                                         log_bytes!(htlc_sig.serialize_compact()[..]));
3892                         }
3893                 }
3894
3895                 Ok((msgs::CommitmentSigned {
3896                         channel_id: self.channel_id,
3897                         signature,
3898                         htlc_signatures,
3899                 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3900         }
3901
3902         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3903         /// to send to the remote peer in one go.
3904         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3905         /// more info.
3906         pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
3907                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3908                         Some(update_add_htlc) => {
3909                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check(logger)?;
3910                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3911                         },
3912                         None => Ok(None)
3913                 }
3914         }
3915
3916         /// Begins the shutdown process, getting a message for the remote peer and returning all
3917         /// holding cell HTLCs for payment failure.
3918         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3919                 for htlc in self.pending_outbound_htlcs.iter() {
3920                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3921                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first".to_owned()});
3922                         }
3923                 }
3924                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3925                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3926                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress".to_owned()});
3927                         }
3928                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3929                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote".to_owned()});
3930                         }
3931                 }
3932                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3933                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3934                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?".to_owned()});
3935                 }
3936
3937                 let our_closing_script = self.get_closing_scriptpubkey();
3938
3939                 // From here on out, we may not fail!
3940                 if self.channel_state < ChannelState::FundingSent as u32 {
3941                         self.channel_state = ChannelState::ShutdownComplete as u32;
3942                 } else {
3943                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3944                 }
3945                 self.update_time_counter += 1;
3946
3947                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3948                 // our shutdown until we've committed all of the pending changes.
3949                 self.holding_cell_update_fee = None;
3950                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3951                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3952                         match htlc_update {
3953                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3954                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3955                                         false
3956                                 },
3957                                 _ => true
3958                         }
3959                 });
3960
3961                 Ok((msgs::Shutdown {
3962                         channel_id: self.channel_id,
3963                         scriptpubkey: our_closing_script,
3964                 }, dropped_outbound_htlcs))
3965         }
3966
3967         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3968         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3969         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3970         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3971         /// immediately (others we will have to allow to time out).
3972         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>) {
3973                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3974
3975                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3976                 // return them to fail the payment.
3977                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3978                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3979                         match htlc_update {
3980                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3981                                         dropped_outbound_htlcs.push((source, payment_hash));
3982                                 },
3983                                 _ => {}
3984                         }
3985                 }
3986
3987                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3988                         //TODO: Do something with the remaining HTLCs
3989                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3990                         //which correspond)
3991                 }
3992
3993                 self.channel_state = ChannelState::ShutdownComplete as u32;
3994                 self.update_time_counter += 1;
3995                 self.latest_monitor_update_id += 1;
3996                 (self.funding_txo.clone(), ChannelMonitorUpdate {
3997                         update_id: self.latest_monitor_update_id,
3998                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3999                 }, dropped_outbound_htlcs)
4000         }
4001 }
4002
4003 const SERIALIZATION_VERSION: u8 = 1;
4004 const MIN_SERIALIZATION_VERSION: u8 = 1;
4005
4006 impl Writeable for InboundHTLCRemovalReason {
4007         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4008                 match self {
4009                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
4010                                 0u8.write(writer)?;
4011                                 error_packet.write(writer)?;
4012                         },
4013                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
4014                                 1u8.write(writer)?;
4015                                 onion_hash.write(writer)?;
4016                                 err_code.write(writer)?;
4017                         },
4018                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
4019                                 2u8.write(writer)?;
4020                                 payment_preimage.write(writer)?;
4021                         },
4022                 }
4023                 Ok(())
4024         }
4025 }
4026
4027 impl Readable for InboundHTLCRemovalReason {
4028         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4029                 Ok(match <u8 as Readable>::read(reader)? {
4030                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
4031                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
4032                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
4033                         _ => return Err(DecodeError::InvalidValue),
4034                 })
4035         }
4036 }
4037
4038 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
4039         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4040                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
4041                 // called but include holding cell updates (and obviously we don't modify self).
4042
4043                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4044                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4045
4046                 self.user_id.write(writer)?;
4047                 self.config.write(writer)?;
4048
4049                 self.channel_id.write(writer)?;
4050                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
4051                 self.channel_outbound.write(writer)?;
4052                 self.channel_value_satoshis.write(writer)?;
4053
4054                 self.latest_monitor_update_id.write(writer)?;
4055
4056                 self.local_keys.write(writer)?;
4057                 self.shutdown_pubkey.write(writer)?;
4058                 self.destination_script.write(writer)?;
4059
4060                 self.cur_local_commitment_transaction_number.write(writer)?;
4061                 self.cur_remote_commitment_transaction_number.write(writer)?;
4062                 self.value_to_self_msat.write(writer)?;
4063
4064                 let mut dropped_inbound_htlcs = 0;
4065                 for htlc in self.pending_inbound_htlcs.iter() {
4066                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
4067                                 dropped_inbound_htlcs += 1;
4068                         }
4069                 }
4070                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
4071                 for htlc in self.pending_inbound_htlcs.iter() {
4072                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
4073                                 continue; // Drop
4074                         }
4075                         htlc.htlc_id.write(writer)?;
4076                         htlc.amount_msat.write(writer)?;
4077                         htlc.cltv_expiry.write(writer)?;
4078                         htlc.payment_hash.write(writer)?;
4079                         match &htlc.state {
4080                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
4081                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
4082                                         1u8.write(writer)?;
4083                                         htlc_state.write(writer)?;
4084                                 },
4085                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
4086                                         2u8.write(writer)?;
4087                                         htlc_state.write(writer)?;
4088                                 },
4089                                 &InboundHTLCState::Committed => {
4090                                         3u8.write(writer)?;
4091                                 },
4092                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
4093                                         4u8.write(writer)?;
4094                                         removal_reason.write(writer)?;
4095                                 },
4096                         }
4097                 }
4098
4099                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
4100                 for htlc in self.pending_outbound_htlcs.iter() {
4101                         htlc.htlc_id.write(writer)?;
4102                         htlc.amount_msat.write(writer)?;
4103                         htlc.cltv_expiry.write(writer)?;
4104                         htlc.payment_hash.write(writer)?;
4105                         htlc.source.write(writer)?;
4106                         match &htlc.state {
4107                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
4108                                         0u8.write(writer)?;
4109                                         onion_packet.write(writer)?;
4110                                 },
4111                                 &OutboundHTLCState::Committed => {
4112                                         1u8.write(writer)?;
4113                                 },
4114                                 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
4115                                         2u8.write(writer)?;
4116                                         fail_reason.write(writer)?;
4117                                 },
4118                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
4119                                         3u8.write(writer)?;
4120                                         fail_reason.write(writer)?;
4121                                 },
4122                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
4123                                         4u8.write(writer)?;
4124                                         fail_reason.write(writer)?;
4125                                 },
4126                         }
4127                 }
4128
4129                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
4130                 for update in self.holding_cell_htlc_updates.iter() {
4131                         match update {
4132                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
4133                                         0u8.write(writer)?;
4134                                         amount_msat.write(writer)?;
4135                                         cltv_expiry.write(writer)?;
4136                                         payment_hash.write(writer)?;
4137                                         source.write(writer)?;
4138                                         onion_routing_packet.write(writer)?;
4139                                 },
4140                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
4141                                         1u8.write(writer)?;
4142                                         payment_preimage.write(writer)?;
4143                                         htlc_id.write(writer)?;
4144                                 },
4145                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
4146                                         2u8.write(writer)?;
4147                                         htlc_id.write(writer)?;
4148                                         err_packet.write(writer)?;
4149                                 }
4150                         }
4151                 }
4152
4153                 match self.resend_order {
4154                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
4155                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
4156                 }
4157
4158                 self.monitor_pending_funding_locked.write(writer)?;
4159                 self.monitor_pending_revoke_and_ack.write(writer)?;
4160                 self.monitor_pending_commitment_signed.write(writer)?;
4161
4162                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
4163                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
4164                         pending_forward.write(writer)?;
4165                         htlc_id.write(writer)?;
4166                 }
4167
4168                 (self.monitor_pending_failures.len() as u64).write(writer)?;
4169                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
4170                         htlc_source.write(writer)?;
4171                         payment_hash.write(writer)?;
4172                         fail_reason.write(writer)?;
4173                 }
4174
4175                 self.pending_update_fee.write(writer)?;
4176                 self.holding_cell_update_fee.write(writer)?;
4177
4178                 self.next_local_htlc_id.write(writer)?;
4179                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
4180                 self.update_time_counter.write(writer)?;
4181                 self.feerate_per_kw.write(writer)?;
4182
4183                 match self.last_sent_closing_fee {
4184                         Some((feerate, fee, sig)) => {
4185                                 1u8.write(writer)?;
4186                                 feerate.write(writer)?;
4187                                 fee.write(writer)?;
4188                                 sig.write(writer)?;
4189                         },
4190                         None => 0u8.write(writer)?,
4191                 }
4192
4193                 self.funding_txo.write(writer)?;
4194                 self.funding_tx_confirmed_in.write(writer)?;
4195                 self.short_channel_id.write(writer)?;
4196
4197                 self.last_block_connected.write(writer)?;
4198                 self.funding_tx_confirmations.write(writer)?;
4199
4200                 self.their_dust_limit_satoshis.write(writer)?;
4201                 self.our_dust_limit_satoshis.write(writer)?;
4202                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4203                 self.local_channel_reserve_satoshis.write(writer)?;
4204                 self.their_htlc_minimum_msat.write(writer)?;
4205                 self.our_htlc_minimum_msat.write(writer)?;
4206                 self.their_to_self_delay.write(writer)?;
4207                 self.our_to_self_delay.write(writer)?;
4208                 self.their_max_accepted_htlcs.write(writer)?;
4209                 self.minimum_depth.write(writer)?;
4210
4211                 self.their_pubkeys.write(writer)?;
4212                 self.their_cur_commitment_point.write(writer)?;
4213
4214                 self.their_prev_commitment_point.write(writer)?;
4215                 self.their_node_id.write(writer)?;
4216
4217                 self.their_shutdown_scriptpubkey.write(writer)?;
4218
4219                 self.commitment_secrets.write(writer)?;
4220                 Ok(())
4221         }
4222 }
4223
4224 impl<ChanSigner: ChannelKeys + Readable> Readable for Channel<ChanSigner> {
4225         fn read<R : ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4226                 let _ver: u8 = Readable::read(reader)?;
4227                 let min_ver: u8 = Readable::read(reader)?;
4228                 if min_ver > SERIALIZATION_VERSION {
4229                         return Err(DecodeError::UnknownVersion);
4230                 }
4231
4232                 let user_id = Readable::read(reader)?;
4233                 let config: ChannelConfig = Readable::read(reader)?;
4234
4235                 let channel_id = Readable::read(reader)?;
4236                 let channel_state = Readable::read(reader)?;
4237                 let channel_outbound = Readable::read(reader)?;
4238                 let channel_value_satoshis = Readable::read(reader)?;
4239
4240                 let latest_monitor_update_id = Readable::read(reader)?;
4241
4242                 let local_keys = Readable::read(reader)?;
4243                 let shutdown_pubkey = Readable::read(reader)?;
4244                 let destination_script = Readable::read(reader)?;
4245
4246                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4247                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4248                 let value_to_self_msat = Readable::read(reader)?;
4249
4250                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4251                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4252                 for _ in 0..pending_inbound_htlc_count {
4253                         pending_inbound_htlcs.push(InboundHTLCOutput {
4254                                 htlc_id: Readable::read(reader)?,
4255                                 amount_msat: Readable::read(reader)?,
4256                                 cltv_expiry: Readable::read(reader)?,
4257                                 payment_hash: Readable::read(reader)?,
4258                                 state: match <u8 as Readable>::read(reader)? {
4259                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4260                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4261                                         3 => InboundHTLCState::Committed,
4262                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4263                                         _ => return Err(DecodeError::InvalidValue),
4264                                 },
4265                         });
4266                 }
4267
4268                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4269                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4270                 for _ in 0..pending_outbound_htlc_count {
4271                         pending_outbound_htlcs.push(OutboundHTLCOutput {
4272                                 htlc_id: Readable::read(reader)?,
4273                                 amount_msat: Readable::read(reader)?,
4274                                 cltv_expiry: Readable::read(reader)?,
4275                                 payment_hash: Readable::read(reader)?,
4276                                 source: Readable::read(reader)?,
4277                                 state: match <u8 as Readable>::read(reader)? {
4278                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4279                                         1 => OutboundHTLCState::Committed,
4280                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4281                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4282                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4283                                         _ => return Err(DecodeError::InvalidValue),
4284                                 },
4285                         });
4286                 }
4287
4288                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4289                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4290                 for _ in 0..holding_cell_htlc_update_count {
4291                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4292                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
4293                                         amount_msat: Readable::read(reader)?,
4294                                         cltv_expiry: Readable::read(reader)?,
4295                                         payment_hash: Readable::read(reader)?,
4296                                         source: Readable::read(reader)?,
4297                                         onion_routing_packet: Readable::read(reader)?,
4298                                 },
4299                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4300                                         payment_preimage: Readable::read(reader)?,
4301                                         htlc_id: Readable::read(reader)?,
4302                                 },
4303                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
4304                                         htlc_id: Readable::read(reader)?,
4305                                         err_packet: Readable::read(reader)?,
4306                                 },
4307                                 _ => return Err(DecodeError::InvalidValue),
4308                         });
4309                 }
4310
4311                 let resend_order = match <u8 as Readable>::read(reader)? {
4312                         0 => RAACommitmentOrder::CommitmentFirst,
4313                         1 => RAACommitmentOrder::RevokeAndACKFirst,
4314                         _ => return Err(DecodeError::InvalidValue),
4315                 };
4316
4317                 let monitor_pending_funding_locked = Readable::read(reader)?;
4318                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4319                 let monitor_pending_commitment_signed = Readable::read(reader)?;
4320
4321                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4322                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4323                 for _ in 0..monitor_pending_forwards_count {
4324                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4325                 }
4326
4327                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4328                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4329                 for _ in 0..monitor_pending_failures_count {
4330                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4331                 }
4332
4333                 let pending_update_fee = Readable::read(reader)?;
4334                 let holding_cell_update_fee = Readable::read(reader)?;
4335
4336                 let next_local_htlc_id = Readable::read(reader)?;
4337                 let next_remote_htlc_id = Readable::read(reader)?;
4338                 let update_time_counter = Readable::read(reader)?;
4339                 let feerate_per_kw = Readable::read(reader)?;
4340
4341                 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4342                         0 => None,
4343                         1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4344                         _ => return Err(DecodeError::InvalidValue),
4345                 };
4346
4347                 let funding_txo = Readable::read(reader)?;
4348                 let funding_tx_confirmed_in = Readable::read(reader)?;
4349                 let short_channel_id = Readable::read(reader)?;
4350
4351                 let last_block_connected = Readable::read(reader)?;
4352                 let funding_tx_confirmations = Readable::read(reader)?;
4353
4354                 let their_dust_limit_satoshis = Readable::read(reader)?;
4355                 let our_dust_limit_satoshis = Readable::read(reader)?;
4356                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4357                 let local_channel_reserve_satoshis = Readable::read(reader)?;
4358                 let their_htlc_minimum_msat = Readable::read(reader)?;
4359                 let our_htlc_minimum_msat = Readable::read(reader)?;
4360                 let their_to_self_delay = Readable::read(reader)?;
4361                 let our_to_self_delay = Readable::read(reader)?;
4362                 let their_max_accepted_htlcs = Readable::read(reader)?;
4363                 let minimum_depth = Readable::read(reader)?;
4364
4365                 let their_pubkeys = Readable::read(reader)?;
4366                 let their_cur_commitment_point = Readable::read(reader)?;
4367
4368                 let their_prev_commitment_point = Readable::read(reader)?;
4369                 let their_node_id = Readable::read(reader)?;
4370
4371                 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4372                 let commitment_secrets = Readable::read(reader)?;
4373
4374                 Ok(Channel {
4375                         user_id,
4376
4377                         config,
4378                         channel_id,
4379                         channel_state,
4380                         channel_outbound,
4381                         secp_ctx: Secp256k1::new(),
4382                         channel_value_satoshis,
4383
4384                         latest_monitor_update_id,
4385
4386                         local_keys,
4387                         shutdown_pubkey,
4388                         destination_script,
4389
4390                         cur_local_commitment_transaction_number,
4391                         cur_remote_commitment_transaction_number,
4392                         value_to_self_msat,
4393
4394                         pending_inbound_htlcs,
4395                         pending_outbound_htlcs,
4396                         holding_cell_htlc_updates,
4397
4398                         resend_order,
4399
4400                         monitor_pending_funding_locked,
4401                         monitor_pending_revoke_and_ack,
4402                         monitor_pending_commitment_signed,
4403                         monitor_pending_forwards,
4404                         monitor_pending_failures,
4405
4406                         pending_update_fee,
4407                         holding_cell_update_fee,
4408                         next_local_htlc_id,
4409                         next_remote_htlc_id,
4410                         update_time_counter,
4411                         feerate_per_kw,
4412
4413                         #[cfg(debug_assertions)]
4414                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4415                         #[cfg(debug_assertions)]
4416                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4417
4418                         last_sent_closing_fee,
4419
4420                         funding_txo,
4421                         funding_tx_confirmed_in,
4422                         short_channel_id,
4423                         last_block_connected,
4424                         funding_tx_confirmations,
4425
4426                         their_dust_limit_satoshis,
4427                         our_dust_limit_satoshis,
4428                         their_max_htlc_value_in_flight_msat,
4429                         local_channel_reserve_satoshis,
4430                         their_htlc_minimum_msat,
4431                         our_htlc_minimum_msat,
4432                         their_to_self_delay,
4433                         our_to_self_delay,
4434                         their_max_accepted_htlcs,
4435                         minimum_depth,
4436
4437                         their_pubkeys,
4438                         their_cur_commitment_point,
4439
4440                         their_prev_commitment_point,
4441                         their_node_id,
4442
4443                         their_shutdown_scriptpubkey,
4444
4445                         commitment_secrets,
4446
4447                         network_sync: UpdateStatus::Fresh,
4448                 })
4449         }
4450 }
4451
4452 #[cfg(test)]
4453 mod tests {
4454         use bitcoin::BitcoinHash;
4455         use bitcoin::util::bip143;
4456         use bitcoin::consensus::encode::serialize;
4457         use bitcoin::blockdata::script::{Script, Builder};
4458         use bitcoin::blockdata::transaction::{Transaction, TxOut};
4459         use bitcoin::blockdata::constants::genesis_block;
4460         use bitcoin::blockdata::opcodes;
4461         use bitcoin::network::constants::Network;
4462         use bitcoin::hashes::hex::FromHex;
4463         use hex;
4464         use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4465         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4466         use ln::channel::MAX_FUNDING_SATOSHIS;
4467         use ln::features::InitFeatures;
4468         use ln::msgs::{OptionalField, DataLossProtect};
4469         use ln::chan_utils;
4470         use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4471         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4472         use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4473         use chain::transaction::OutPoint;
4474         use util::config::UserConfig;
4475         use util::enforcing_trait_impls::EnforcingChannelKeys;
4476         use util::test_utils;
4477         use util::logger::Logger;
4478         use bitcoin::secp256k1::{Secp256k1, Message, Signature, All};
4479         use bitcoin::secp256k1::key::{SecretKey,PublicKey};
4480         use bitcoin::hashes::sha256::Hash as Sha256;
4481         use bitcoin::hashes::Hash;
4482         use bitcoin::hash_types::{Txid, WPubkeyHash};
4483         use std::sync::Arc;
4484
4485         struct TestFeeEstimator {
4486                 fee_est: u32
4487         }
4488         impl FeeEstimator for TestFeeEstimator {
4489                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u32 {
4490                         self.fee_est
4491                 }
4492         }
4493
4494         #[test]
4495         fn test_max_funding_satoshis() {
4496                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4497                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4498         }
4499
4500         struct Keys {
4501                 chan_keys: InMemoryChannelKeys,
4502         }
4503         impl KeysInterface for Keys {
4504                 type ChanKeySigner = InMemoryChannelKeys;
4505
4506                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4507                 fn get_destination_script(&self) -> Script {
4508                         let secp_ctx = Secp256k1::signing_only();
4509                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4510                         let our_channel_monitor_claim_key_hash = WPubkeyHash::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4511                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4512                 }
4513
4514                 fn get_shutdown_pubkey(&self) -> PublicKey {
4515                         let secp_ctx = Secp256k1::signing_only();
4516                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4517                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4518                 }
4519
4520                 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4521                         self.chan_keys.clone()
4522                 }
4523                 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
4524         }
4525
4526         fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4527                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4528         }
4529
4530         // Check that, during channel creation, we use the same feerate in the open channel message
4531         // as we do in the Channel object creation itself.
4532         #[test]
4533         fn test_open_channel_msg_fee() {
4534                 let original_fee = 253;
4535                 let mut fee_est = TestFeeEstimator{fee_est: original_fee };
4536                 let secp_ctx = Secp256k1::new();
4537                 let seed = [42; 32];
4538                 let network = Network::Testnet;
4539                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4540
4541                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4542                 let config = UserConfig::default();
4543                 let node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&fee_est, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4544
4545                 // Now change the fee so we can check that the fee in the open_channel message is the
4546                 // same as the old fee.
4547                 fee_est.fee_est = 500;
4548                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash());
4549                 assert_eq!(open_channel_msg.feerate_per_kw, original_fee);
4550         }
4551
4552         #[test]
4553         fn channel_reestablish_no_updates() {
4554                 let feeest = TestFeeEstimator{fee_est: 15000};
4555                 let logger = test_utils::TestLogger::new();
4556                 let secp_ctx = Secp256k1::new();
4557                 let seed = [42; 32];
4558                 let network = Network::Testnet;
4559                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
4560
4561                 // Go through the flow of opening a channel between two nodes.
4562
4563                 // Create Node A's channel
4564                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4565                 let config = UserConfig::default();
4566                 let mut node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&feeest, &&keys_provider, node_a_node_id, 10000000, 100000, 42, &config).unwrap();
4567
4568                 // Create Node B's channel by receiving Node A's open_channel message
4569                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash());
4570                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4571                 let mut node_b_chan = Channel::<EnforcingChannelKeys>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::known(), &open_channel_msg, 7, &config).unwrap();
4572
4573                 // Node B --> Node A: accept channel
4574                 let accept_channel_msg = node_b_chan.get_accept_channel();
4575                 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::known()).unwrap();
4576
4577                 // Node A --> Node B: funding created
4578                 let output_script = node_a_chan.get_funding_redeemscript();
4579                 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4580                         value: 10000000, script_pubkey: output_script.clone(),
4581                 }]};
4582                 let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
4583                 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint, &&logger).unwrap();
4584                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, &&logger).unwrap();
4585
4586                 // Node B --> Node A: funding signed
4587                 let _ = node_a_chan.funding_signed(&funding_signed_msg, &&logger);
4588
4589                 // Now disconnect the two nodes and check that the commitment point in
4590                 // Node B's channel_reestablish message is sane.
4591                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4592                 let msg = node_b_chan.get_channel_reestablish(&&logger);
4593                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4594                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4595                 match msg.data_loss_protect {
4596                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4597                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4598                         },
4599                         _ => panic!()
4600                 }
4601
4602                 // Check that the commitment point in Node A's channel_reestablish message
4603                 // is sane.
4604                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused(&&logger);
4605                 let msg = node_a_chan.get_channel_reestablish(&&logger);
4606                 assert_eq!(msg.next_local_commitment_number, 1); // now called next_commitment_number
4607                 assert_eq!(msg.next_remote_commitment_number, 0); // now called next_revocation_number
4608                 match msg.data_loss_protect {
4609                         OptionalField::Present(DataLossProtect { your_last_per_commitment_secret, .. }) => {
4610                                 assert_eq!(your_last_per_commitment_secret, [0; 32]);
4611                         },
4612                         _ => panic!()
4613                 }
4614         }
4615
4616         #[test]
4617         fn outbound_commitment_test() {
4618                 // Test vectors from BOLT 3 Appendix C:
4619                 let feeest = TestFeeEstimator{fee_est: 15000};
4620                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4621                 let secp_ctx = Secp256k1::new();
4622
4623                 let mut chan_keys = InMemoryChannelKeys::new(
4624                         &secp_ctx,
4625                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4626                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4627                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4628                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4629                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4630
4631                         // These aren't set in the test vectors:
4632                         [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],
4633                         10_000_000,
4634                         (0, 0)
4635                 );
4636
4637                 assert_eq!(chan_keys.pubkeys().funding_pubkey.serialize()[..],
4638                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4639                 let keys_provider = Keys { chan_keys: chan_keys.clone() };
4640
4641                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4642                 let mut config = UserConfig::default();
4643                 config.channel_options.announced_channel = false;
4644                 let mut chan = Channel::<InMemoryChannelKeys>::new_outbound(&&feeest, &&keys_provider, their_node_id, 10_000_000, 100000, 42, &config).unwrap(); // Nothing uses their network key in this test
4645                 chan.their_to_self_delay = 144;
4646                 chan.our_dust_limit_satoshis = 546;
4647
4648                 let funding_info = OutPoint{ txid: Txid::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), index: 0 };
4649                 chan.funding_txo = Some(funding_info);
4650
4651                 let their_pubkeys = ChannelPublicKeys {
4652                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4653                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4654                         payment_point: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4655                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4656                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4657                 };
4658                 chan_keys.on_accept(&their_pubkeys, chan.their_to_self_delay, chan.our_to_self_delay);
4659
4660                 assert_eq!(their_pubkeys.payment_point.serialize()[..],
4661                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4662
4663                 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4664                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4665
4666                 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4667                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4668
4669                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4670                 // derived from a commitment_seed, so instead we copy it here and call
4671                 // build_commitment_transaction.
4672                 let delayed_payment_base = &chan.local_keys.pubkeys().delayed_payment_basepoint;
4673                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4674                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4675                 let htlc_basepoint = &chan.local_keys.pubkeys().htlc_basepoint;
4676                 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &their_pubkeys.revocation_basepoint, &their_pubkeys.htlc_basepoint).unwrap();
4677
4678                 chan.their_pubkeys = Some(their_pubkeys);
4679
4680                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4681
4682                 let mut localtx;
4683                 macro_rules! test_commitment {
4684                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr, {
4685                                 $( { $htlc_idx: expr, $their_htlc_sig_hex: expr, $our_htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
4686                         } ) => { {
4687                                 unsigned_tx = {
4688                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw, &logger);
4689                                         let htlcs = res.2.drain(..)
4690                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4691                                                 .collect();
4692                                         (res.0, htlcs)
4693                                 };
4694                                 let redeemscript = chan.get_funding_redeemscript();
4695                                 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4696                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4697                                 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4698
4699                                 let mut per_htlc = Vec::new();
4700                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
4701                                 $({
4702                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4703                                         per_htlc.push((unsigned_tx.1[$htlc_idx].clone(), Some(remote_signature)));
4704                                 })*
4705                                 assert_eq!(unsigned_tx.1.len(), per_htlc.len());
4706
4707                                 localtx = LocalCommitmentTransaction::new_missing_local_sig(unsigned_tx.0.clone(), their_signature.clone(), &chan_keys.pubkeys().funding_pubkey, chan.their_funding_pubkey(), keys.clone(), chan.feerate_per_kw, per_htlc);
4708                                 let local_sig = chan_keys.sign_local_commitment(&localtx, &chan.secp_ctx).unwrap();
4709                                 assert_eq!(Signature::from_der(&hex::decode($our_sig_hex).unwrap()[..]).unwrap(), local_sig);
4710
4711                                 assert_eq!(serialize(&localtx.add_local_sig(&redeemscript, local_sig))[..],
4712                                                 hex::decode($tx_hex).unwrap()[..]);
4713
4714                                 let htlc_sigs = chan_keys.sign_local_commitment_htlc_transactions(&localtx, &chan.secp_ctx).unwrap();
4715                                 let mut htlc_sig_iter = localtx.per_htlc.iter().zip(htlc_sigs.iter().enumerate());
4716
4717                                 $({
4718                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4719
4720                                         let ref htlc = unsigned_tx.1[$htlc_idx];
4721                                         let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4722                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4723                                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4724                                         secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4725
4726                                         let mut preimage: Option<PaymentPreimage> = None;
4727                                         if !htlc.offered {
4728                                                 for i in 0..5 {
4729                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4730                                                         if out == htlc.payment_hash {
4731                                                                 preimage = Some(PaymentPreimage([i; 32]));
4732                                                         }
4733                                                 }
4734
4735                                                 assert!(preimage.is_some());
4736                                         }
4737
4738                                         let mut htlc_sig = htlc_sig_iter.next().unwrap();
4739                                         while (htlc_sig.1).1.is_none() { htlc_sig = htlc_sig_iter.next().unwrap(); }
4740                                         assert_eq!((htlc_sig.0).0.transaction_output_index, Some($htlc_idx));
4741
4742                                         let our_signature = Signature::from_der(&hex::decode($our_htlc_sig_hex).unwrap()[..]).unwrap();
4743                                         assert_eq!(Some(our_signature), *(htlc_sig.1).1);
4744                                         assert_eq!(serialize(&localtx.get_signed_htlc_tx((htlc_sig.1).0, &(htlc_sig.1).1.unwrap(), &preimage, chan.their_to_self_delay))[..],
4745                                                         hex::decode($htlc_tx_hex).unwrap()[..]);
4746                                 })*
4747                                 loop {
4748                                         let htlc_sig = htlc_sig_iter.next();
4749                                         if htlc_sig.is_none() { break; }
4750                                         assert!((htlc_sig.unwrap().1).1.is_none());
4751                                 }
4752                         } }
4753                 }
4754
4755                 // simple commitment tx with no HTLCs
4756                 chan.value_to_self_msat = 7000000000;
4757
4758                 test_commitment!("3045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b0",
4759                                                  "30440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae055647142",
4760                                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48454a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220616210b2cc4d3afb601013c373bbd8aac54febd9f15400379a8cb65ce7deca60022034236c010991beb7ff770510561ae8dc885b8d38d1947248c38f2ae05564714201483045022100c3127b33dcc741dd6b05b1e63cbd1a9a7d816f37af9b6756fa2376b056f032370220408b96279808fe57eb7e463710804cdf4f108388bc5cf722d8c848d2c7f9f3b001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4761
4762                 chan.pending_inbound_htlcs.push({
4763                         let mut out = InboundHTLCOutput{
4764                                 htlc_id: 0,
4765                                 amount_msat: 1000000,
4766                                 cltv_expiry: 500,
4767                                 payment_hash: PaymentHash([0; 32]),
4768                                 state: InboundHTLCState::Committed,
4769                         };
4770                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4771                         out
4772                 });
4773                 chan.pending_inbound_htlcs.push({
4774                         let mut out = InboundHTLCOutput{
4775                                 htlc_id: 1,
4776                                 amount_msat: 2000000,
4777                                 cltv_expiry: 501,
4778                                 payment_hash: PaymentHash([0; 32]),
4779                                 state: InboundHTLCState::Committed,
4780                         };
4781                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4782                         out
4783                 });
4784                 chan.pending_outbound_htlcs.push({
4785                         let mut out = OutboundHTLCOutput{
4786                                 htlc_id: 2,
4787                                 amount_msat: 2000000,
4788                                 cltv_expiry: 502,
4789                                 payment_hash: PaymentHash([0; 32]),
4790                                 state: OutboundHTLCState::Committed,
4791                                 source: HTLCSource::dummy(),
4792                         };
4793                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4794                         out
4795                 });
4796                 chan.pending_outbound_htlcs.push({
4797                         let mut out = OutboundHTLCOutput{
4798                                 htlc_id: 3,
4799                                 amount_msat: 3000000,
4800                                 cltv_expiry: 503,
4801                                 payment_hash: PaymentHash([0; 32]),
4802                                 state: OutboundHTLCState::Committed,
4803                                 source: HTLCSource::dummy(),
4804                         };
4805                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4806                         out
4807                 });
4808                 chan.pending_inbound_htlcs.push({
4809                         let mut out = InboundHTLCOutput{
4810                                 htlc_id: 4,
4811                                 amount_msat: 4000000,
4812                                 cltv_expiry: 504,
4813                                 payment_hash: PaymentHash([0; 32]),
4814                                 state: InboundHTLCState::Committed,
4815                         };
4816                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4817                         out
4818                 });
4819
4820                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4821                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4822                 chan.feerate_per_kw = 0;
4823
4824                 test_commitment!("3044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e5",
4825                                  "304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea",
4826                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206fc2d1f10ea59951eefac0b4b7c396a3c3d87b71ff0b019796ef4535beaf36f902201765b0181e514d04f4c8ad75659d7037be26cdb3f8bb6f78fe61decef484c3ea01473044022009b048187705a8cbc9ad73adbe5af148c3d012e1f067961486c822c7af08158c022006d66f3704cfab3eb2dc49dae24e4aa22a6910fc9b424007583204e3621af2e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4827
4828                                   { 0,
4829                                   "3045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b",
4830                                   "30440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce",
4831                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b00000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d9e29616b8f3959f1d3d7f7ce893ffedcdc407717d0de8e37d808c91d3a7c50d022078c3033f6d00095c8720a4bc943c1b45727818c082e4e3ddbc6d3116435b624b014730440220636de5682ef0c5b61f124ec74e8aa2461a69777521d6998295dcea36bc3338110220165285594b23c50b28b82df200234566628a27bcd17f7f14404bd865354eb3ce012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4832
4833                                   { 1,
4834                                   "30440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f896004",
4835                                   "3045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f",
4836                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b01000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220649fe8b20e67e46cbb0d09b4acea87dbec001b39b08dee7bdd0b1f03922a8640022037c462dff79df501cecfdb12ea7f4de91f99230bb544726f6e04527b1f89600401483045022100803159dee7935dba4a1d36a61055ce8fd62caa528573cc221ae288515405a252022029c59e7cffce374fe860100a4a63787e105c3cf5156d40b12dd53ff55ac8cf3f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4837
4838                                   { 2,
4839                                   "30440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d43352",
4840                                   "3045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa",
4841                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b02000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220770fc321e97a19f38985f2e7732dd9fe08d16a2efa4bcbc0429400a447faf49102204d40b417f3113e1b0944ae0986f517564ab4acd3d190503faf97a6e420d4335201483045022100a437cc2ce77400ecde441b3398fea3c3ad8bdad8132be818227fe3c5b8345989022069d45e7fa0ae551ec37240845e2c561ceb2567eacf3076a6a43a502d05865faa012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4842
4843                                   { 3,
4844                                   "304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c1363",
4845                                   "304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac7487",
4846                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b03000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207bcbf4f60a9829b05d2dbab84ed593e0291836be715dc7db6b72a64caf646af802201e489a5a84f7c5cc130398b841d138d031a5137ac8f4c49c770a4959dc3c13630147304402203121d9b9c055f354304b016a36662ee99e1110d9501cb271b087ddb6f382c2c80220549882f3f3b78d9c492de47543cb9a697cecc493174726146536c5954dac748701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4847
4848                                   { 4,
4849                                   "3044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b87",
4850                                   "3045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95",
4851                                   "02000000000101ab84ff284f162cfbfef241f853b47d4368d171f9e2a1445160cd591c4c7d882b04000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022076dca5cb81ba7e466e349b7128cdba216d4d01659e29b96025b9524aaf0d1899022060de85697b88b21c749702b7d2cfa7dfeaa1f472c8f1d7d9c23f2bf968464b8701483045022100d9080f103cc92bac15ec42464a95f070c7fb6925014e673ee2ea1374d36a7f7502200c65294d22eb20d48564954d5afe04a385551919d8b2ddb4ae2459daaeee1d95012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4852                 } );
4853
4854                 // commitment tx with seven outputs untrimmed (maximum feerate)
4855                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4856                 chan.feerate_per_kw = 647;
4857
4858                 test_commitment!("3045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee",
4859                                  "30450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb7",
4860                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221009ec15c687898bb4da8b3a833e5ab8bfc51ec6e9202aaa8e66611edfd4a85ed1102203d7183e45078b9735c93450bc3415d3e5a8c576141a711ec6ddcb4a893926bb701483045022100a135f9e8a5ed25f7277446c67956b00ce6f610ead2bdec2c2f686155b7814772022059f1f6e1a8b336a68efcc1af3fe4d422d4827332b5b067501b099c47b7b5b5ee01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4861
4862                                   { 0,
4863                                   "30450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f",
4864                                   "30440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b",
4865                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008437627f9ad84ac67052e2a414a4367b8556fd1f94d8b02590f89f50525cd33502205b9c21ff6e7fc864f2352746ad8ba59182510819acb644e25b8a12fc37bbf24f014730440220344b0deb055230d01703e6c7acd45853c4af2328b49b5d8af4f88a060733406602202ea64f2a43d5751edfe75503cbc35a62e3141b5ed032fa03360faf4ca66f670b012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000" },
4866
4867                                   { 1,
4868                                   "304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c",
4869                                   "30450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f",
4870                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe0100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205a67f92bf6845cf2892b48d874ac1daf88a36495cf8a06f93d83180d930a6f75022031da1621d95c3f335cc06a3056cf960199dae600b7cf89088f65fc53cdbef28c014830450221009e5e3822b0185c6799a95288c597b671d6cc69ab80f43740f00c6c3d0752bdda02206da947a74bd98f3175324dc56fdba86cc783703a120a6f0297537e60632f4c7f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4871
4872                                   { 2,
4873                                   "30440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c8",
4874                                   "3045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673",
4875                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220437e21766054a3eef7f65690c5bcfa9920babbc5af92b819f772f6ea96df6c7402207173622024bd97328cfb26c6665e25c2f5d67c319443ccdc60c903217005d8c801483045022100fcfc47e36b712624677626cef3dc1d67f6583bd46926a6398fe6b00b0c9a37760220525788257b187fc775c6370d04eadf34d06f3650a63f8df851cee0ecb47a1673012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4876
4877                                   { 3,
4878                                   "304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c64",
4879                                   "3045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee",
4880                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207436e10737e4df499fc051686d3e11a5bb2310e4d1f1e691d287cef66514791202207cb58e71a6b7a42dd001b7e3ae672ea4f71ea3e1cd412b742e9124abb0739c6401483045022100e78211b8409afb7255ffe37337da87f38646f1faebbdd61bc1920d69e3ead67a02201a626305adfcd16bfb7e9340928d9b6305464eab4aa4c4a3af6646e9b9f69dee01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4881
4882                                   { 4,
4883                                   "30450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca",
4884                                   "3044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9",
4885                                   "020000000001012cfb3e4788c206881d38f2996b6cb2109b5935acb527d14bdaa7b908afa9b2fe04000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009acd6a827a76bfee50806178dfe0495cd4e1d9c58279c194c7b01520fe68cb8d022024d439047c368883e570997a7d40f0b430cb5a742f507965e7d3063ae3feccca01473044022048762cf546bbfe474f1536365ea7c416e3c0389d60558bc9412cb148fb6ab68202207215d7083b75c96ff9d2b08c59c34e287b66820f530b486a9aa4cdd9c347d5b9012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4886                 } );
4887
4888                 // commitment tx with six outputs untrimmed (minimum feerate)
4889                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4890                 chan.feerate_per_kw = 648;
4891
4892                 test_commitment!("304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e5",
4893                                  "3045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e9",
4894                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4844e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100b15f72908ba3382a34ca5b32519240a22300cc6015b6f9418635fb41f3d01d8802207adb331b9ed1575383dca0f2355e86c173802feecf8298fbea53b9d4610583e90147304402203948f900a5506b8de36a4d8502f94f21dd84fd9c2314ab427d52feaa7a0a19f2022059b6a37a4adaa2c5419dc8aea63c6e2a2ec4c4bde46207f6dc1fcd22152fc6e501475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4895
4896                                   { 0,
4897                                   "3045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e0",
4898                                   "304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec6",
4899                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a031202f3be94678f0e998622ee95ebb6ada8da1e9a5110228b5e04a747351e4022010ca6a21e18314ed53cfaae3b1f51998552a61a468e596368829a50ce40110e00148304502210097e1873b57267730154595187a34949d3744f52933070c74757005e61ce2112e02204ecfba2aa42d4f14bdf8bad4206bb97217b702e6c433e0e1b0ce6587e6d46ec601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4900
4901                                   { 1,
4902                                   "304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d384124",
4903                                   "3044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae",
4904                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402202361012a634aee7835c5ecdd6413dcffa8f404b7e77364c792cff984e4ee71e90220715c5e90baa08daa45a7439b1ee4fa4843ed77b19c058240b69406606d38412401473044022019de73b00f1d818fb388e83b2c8c31f6bce35ac624e215bc12f88f9dc33edf48022006ff814bb9f700ee6abc3294e146fac3efd4f13f0005236b41c0a946ee00c9ae012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4905
4906                                   { 2,
4907                                   "304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc625532989",
4908                                   "3045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e2260796",
4909                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e8e82cd71ed4febeb593732c260456836e97d81896153ecd2b3cf320ca6861702202dd4a30f68f98ced7cc56a36369ac1fdd978248c5ff4ed204fc00cc62553298901483045022100bd0be6100c4fd8f102ec220e1b053e4c4e2ecca25615490150007b40d314dc3902201a1e0ea266965b43164d9e6576f58fa6726d42883dd1c3996d2925c2e226079601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4910
4911                                   { 3,
4912                                   "3044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be",
4913                                   "3045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6",
4914                                   "020000000001010f44041fdfba175987cf4e6135ba2a154e3b7fb96483dc0ed5efc0678e5b6bf103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022024cd52e4198c8ae0e414a86d86b5a65ea7450f2eb4e783096736d93395eca5ce022078f0094745b45be4d4b2b04dd5978c9e66ba49109e5704403e84aaf5f387d6be01483045022100bbfb9d0a946d420807c86e985d636cceb16e71c3694ed186316251a00cbd807202207773223f9a337e145f64673825be9b30d07ef1542c82188b264bedcf7cda78c6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4915                 } );
4916
4917                 // commitment tx with six outputs untrimmed (maximum feerate)
4918                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4919                 chan.feerate_per_kw = 2069;
4920
4921                 test_commitment!("304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc",
4922                                  "3045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e33",
4923                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48477956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100ad9a9bbbb75d506ca3b716b336ee3cf975dd7834fcf129d7dd188146eb58a8b4022061a759ee417339f7fe2ea1e8deb83abb6a74db31a09b7648a932a639cda23e330148304502210090b96a2498ce0c0f2fadbec2aab278fed54c1a7838df793ec4d2c78d96ec096202204fdd439c50f90d483baa7b68feeef4bd33bc277695405447bcd0bfb2ca34d7bc01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4924
4925                                   { 0,
4926                                   "3045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f699",
4927                                   "3045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d",
4928                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f33513ee38abf1c582876f921f8fddc06acff48e04515532a32d3938de938ffd02203aa308a2c1863b7d6fdf53159a1465bf2e115c13152546cc5d74483ceaa7f69901483045022100a637902a5d4c9ba9e7c472a225337d5aac9e2e3f6744f76e237132e7619ba0400220035c60d784a031c0d9f6df66b7eab8726a5c25397399ee4aa960842059eb3f9d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4929
4930                                   { 1,
4931                                   "3045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df",
4932                                   "3045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61",
4933                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ce07682cf4b90093c22dc2d9ab2a77ad6803526b655ef857221cc96af5c9e0bf02200f501cee22e7a268af40b555d15a8237c9f36ad67ef1841daf9f6a0267b1e6df01483045022100e57e46234f8782d3ff7aa593b4f7446fb5316c842e693dc63ee324fd49f6a1c302204a2f7b44c48bd26e1554422afae13153eb94b29d3687b733d18930615fb2db61012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000" },
4934
4935                                   { 2,
4936                                   "3045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e0",
4937                                   "3044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c18",
4938                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e3e35492e55f82ec0bc2f317ffd7a486d1f7024330fe9743c3559fc39f32ef0c02203d1d4db651fc388a91d5ad8ecdd8e83673063bc8eefe27cfd8c189090e3a23e001473044022068613fb1b98eb3aec7f44c5b115b12343c2f066c4277c82b5f873dfe68f37f50022028109b4650f3f528ca4bfe9a467aff2e3e43893b61b5159157119d5d95cf1c1801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4939
4940                                   { 3,
4941                                   "304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df",
4942                                   "3045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33",
4943                                   "02000000000101adbe717a63fb658add30ada1e6e12ed257637581898abe475c11d7bbcd65bd4d03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207475aeb0212ef9bf5130b60937817ad88c9a87976988ef1f323f026148cc4a850220739fea17ad3257dcad72e509c73eebe86bee30b178467b9fdab213d631b109df01483045022100d315522e09e7d53d2a659a79cb67fef56d6c4bddf3f46df6772d0d20a7beb7c8022070bcc17e288607b6a72be0bd83368bb6d53488db266c1cdb4d72214e4f02ac33012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4944                 } );
4945
4946                 // commitment tx with five outputs untrimmed (minimum feerate)
4947                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4948                 chan.feerate_per_kw = 2070;
4949
4950                 test_commitment!("304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c",
4951                                  "3044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c1",
4952                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022001014419b5ba00e083ac4e0a85f19afc848aacac2d483b4b525d15e2ae5adbfe022015ebddad6ee1e72b47cb09f3e78459da5be01ccccd95dceca0e056a00cc773c10147304402204ca1ba260dee913d318271d86e10ca0f5883026fb5653155cff600fb40895223022037b145204b7054a40e08bb1fefbd826f827b40838d3e501423bcc57924bcb50c01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4953
4954                                   { 0,
4955                                   "304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b",
4956                                   "30440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e5",
4957                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff0000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402205f6b6d12d8d2529fb24f4445630566cf4abbd0f9330ab6c2bdb94222d6a2a0c502202f556258ae6f05b193749e4c541dfcc13b525a5422f6291f073f15617ba8579b014730440220150b11069454da70caf2492ded9e0065c9a57f25ac2a4c52657b1d15b6c6ed85022068a38833b603c8892717206383611bad210f1cbb4b1f87ea29c6c65b9e1cb3e501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4958
4959                                   { 1,
4960                                   "3045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546",
4961                                   "30450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c6",
4962                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f960dfb1c9aee7ce1437efa65b523e399383e8149790e05d8fed27ff6e42fe0002202fe8613e062ffe0b0c518cc4101fba1c6de70f64a5bcc7ae663f2efae43b8546014830450221009a6ed18e6873bc3644332a6ee21c152a5b102821865350df7a8c74451a51f9f2022050d801fb4895d7d7fbf452824c0168347f5c0cbe821cf6a97a63af5b8b2563c601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4963
4964                                   { 2,
4965                                   "3045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504",
4966                                   "30440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502",
4967                                   "02000000000101403ad7602b43293497a3a2235a12ecefda4f3a1f1d06e49b1786d945685de1ff02000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ae5fc7717ae684bc1fcf9020854e5dbe9842c9e7472879ac06ff95ac2bb10e4e022057728ada4c00083a3e65493fb5d50a232165948a1a0f530ef63185c2c8c56504014730440220408ad3009827a8fccf774cb285587686bfb2ed041f89a89453c311ce9c8ee0f902203c7392d9f8306d3a46522a66bd2723a7eb2628cb2d9b34d4c104f1766bf37502012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4968                 } );
4969
4970                 // commitment tx with five outputs untrimmed (maximum feerate)
4971                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4972                 chan.feerate_per_kw = 2194;
4973
4974                 test_commitment!("304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb3",
4975                                  "3044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d398",
4976                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e48440966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022072c2e2b1c899b2242656a537dde2892fa3801be0d6df0a87836c550137acde8302201654aa1974d37a829083c3ba15088689f30b56d6a4f6cb14c7bad0ee3116d3980147304402204bb3d6e279d71d9da414c82de42f1f954267c762b2e2eb8b76bc3be4ea07d4b0022014febc009c5edc8c3fc5d94015de163200f780046f1c293bfed8568f08b70fb301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4977
4978                                   { 0,
4979                                   "3045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de8450",
4980                                   "304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e0154301",
4981                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100939726680351a7856c1bc386d4a1f422c7d29bd7b56afc139570f508474e6c40022023175a799ccf44c017fbaadb924c40b2a12115a5b7d0dfd3228df803a2de84500148304502210099c98c2edeeee6ec0fb5f3bea8b79bb016a2717afa9b5072370f34382de281d302206f5e2980a995e045cf90a547f0752a7ee99d48547bc135258fe7bc07e015430101008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000" },
4982
4983                                   { 1,
4984                                   "3044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a0",
4985                                   "3045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b77",
4986                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022021bb883bf324553d085ba2e821cad80c28ef8b303dbead8f98e548783c02d1600220638f9ef2a9bba25869afc923f4b5dc38be3bb459f9efa5d869392d5f7779a4a001483045022100fd85bd7697b89c08ec12acc8ba89b23090637d83abd26ca37e01ae93e67c367302202b551fe69386116c47f984aab9c8dfd25d864dcde5d3389cfbef2447a85c4b7701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
4987
4988                                   { 2,
4989                                   "3045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b",
4990                                   "30450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3",
4991                                   "02000000000101153cd825fdb3aa624bfe513e8031d5d08c5e582fb3d1d1fe8faf27d3eed410cd020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9e6f0454aa598b905a35e641a70cc9f67b5f38cc4b00843a041238c4a9f1c4a0220260a2822a62da97e44583e837245995ca2e36781769c52f19e498efbdcca262b014830450221008a9f2ea24cd455c2b64c1472a5fa83865b0a5f49a62b661801e884cf2849af8302204d44180e50bf6adfcf1c1e581d75af91aba4e28681ce4a5ee5f3cbf65eca10f3012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4992                 } );
4993
4994                 // commitment tx with four outputs untrimmed (minimum feerate)
4995                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4996                 chan.feerate_per_kw = 2195;
4997
4998                 test_commitment!("304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce403",
4999                                  "3044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d1767",
5000                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022044d592025b610c0d678f65032e87035cdfe89d1598c522cc32524ae8172417c30220749fef9d5b2ae8cdd91ece442ba8809bc891efedae2291e578475f97715d17670147304402201a8c1b1f9671cd9e46c7323a104d7047cc48d3ee80d40d4512e0c72b8dc65666022066d7f9a2ce18c9eb22d2739ffcce05721c767f9b607622a31b6ea5793ddce40301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5001
5002                                   { 0,
5003                                   "3045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e",
5004                                   "3045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d76",
5005                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e57b845066a06ee7c2cbfc29eabffe52daa9bf6f6de760066d04df9f9b250e0002202ffb197f0e6e0a77a75a9aff27014bd3de83b7f748d7efef986abe655e1dd50e01483045022100ecc8c6529d0b2316d046f0f0757c1e1c25a636db168ec4f3aa1b9278df685dc0022067ae6b65e936f1337091f7b18a15935b608c5f2cdddb2f892ed0babfdd376d7601008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5006
5007                                   { 1,
5008                                   "3045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a",
5009                                   "3044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82",
5010                                   "020000000001018130a10f09b13677ba2885a8bca32860f3a952e5912b829a473639b5a2c07b900100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d193b7ecccad8057571620a0b1ffa6c48e9483311723b59cf536043b20bc51550220546d4bd37b3b101ecda14f6c907af46ec391abce1cd9c7ce22b1a62b534f2f2a01473044022014d66f11f9cacf923807eba49542076c5fe5cccf252fb08fe98c78ef3ca6ab5402201b290dbe043cc512d9d78de074a5a129b8759bc6a6c546b190d120b690bd6e82012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5011                 } );
5012
5013                 // commitment tx with four outputs untrimmed (maximum feerate)
5014                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5015                 chan.feerate_per_kw = 3702;
5016
5017                 test_commitment!("304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee40169",
5018                                  "3045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf75",
5019                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4846f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100e5efb73c32d32da2d79702299b6317de6fb24a60476e3855926d78484dd1b3c802203557cb66a42c944ef06e00bcc4da35a5bcb2f185aab0f8e403e519e1d66aaf750148304502210092a587aeb777f869e7ff0d7898ea619ee26a3dacd1f3672b945eea600be431100220077ee9eae3528d15251f2a52b607b189820e57a6ccfac8d1af502b132ee4016901475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5020
5021                                   { 0,
5022                                   "304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb89",
5023                                   "304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f",
5024                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206fa54c11f98c3bae1e93df43fc7affeb05b476bf8060c03e29c377c69bc08e8b0220672701cce50d5c379ff45a5d2cfe48ac44973adb066ac32608e21221d869bb890147304402206e36c683ebf2cb16bcef3d5439cf8b53cd97280a365ed8acd7abb85a8ba5f21c02206e8621edfc2a5766cbc96eb67fd501127ff163eb6b85518a39f7d4974aef126f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000" },
5025
5026                                   { 1,
5027                                   "3044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb5817",
5028                                   "304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc",
5029                                   "020000000001018db483bff65c70ee71d8282aeec5a880e2e2b39e45772bda5460403095c62e3f0100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022057649739b0eb74d541ead0dfdb3d4b2c15aa192720031044c3434c67812e5ca902201e5ede42d960ae551707f4a6b34b09393cf4dee2418507daa022e3550dbb58170147304402207faad26678c8850e01b4a0696d60841f7305e1832b786110ee9075cb92ed14a30220516ef8ee5dfa80824ea28cbcec0dd95f8b847146257c16960db98507db15ffdc012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5030                 } );
5031
5032                 // commitment tx with three outputs untrimmed (minimum feerate)
5033                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5034                 chan.feerate_per_kw = 3703;
5035
5036                 test_commitment!("3045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e",
5037                                  "304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e1",
5038                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402201b736d1773a124c745586217a75bed5f66c05716fbe8c7db4fdb3c3069741cdd02205083f39c321c1bcadfc8d97e3c791a66273d936abac0c6a2fde2ed46019508e101483045022100b495d239772a237ff2cf354b1b11be152fd852704cb184e7356d13f2fb1e5e430220723db5cdb9cbd6ead7bfd3deb419cf41053a932418cbb22a67b581f40bc1f13e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5039
5040                                   { 0,
5041                                   "3045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a",
5042                                   "3045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05",
5043                                   "0200000000010120060e4a29579d429f0f27c17ee5f1ee282f20d706d6f90b63d35946d8f3029a0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c34c61735f93f2e324cc873c3b248111ccf8f6db15d5969583757010d4ad2b4602207867bb919b2ddd6387873e425345c9b7fd18d1d66aba41f3607bc2896ef3c30a01483045022100988c143e2110067117d2321bdd4bd16ca1734c98b29290d129384af0962b634e02206c1b02478878c5f547018b833986578f90c3e9be669fe5788ad0072a55acbb05012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5044                 } );
5045
5046                 // commitment tx with three outputs untrimmed (maximum feerate)
5047                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5048                 chan.feerate_per_kw = 4914;
5049
5050                 test_commitment!("3045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c95244",
5051                                  "3045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c19",
5052                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100d72638bc6308b88bb6d45861aae83e5b9ff6e10986546e13bce769c70036e2620220320be7c6d66d22f30b9fcd52af66531505b1310ca3b848c19285b38d8a1a8c1901483045022100b4b16d5f8cc9fc4c1aff48831e832a0d8990e133978a66e302c133550954a44d022073573ce127e2200d316f6b612803a5c0c97b8d20e1e44dbe2ac0dd2fb8c9524401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
5053
5054                                   { 0,
5055                                   "3045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374",
5056                                   "30440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10",
5057                                   "02000000000101a9172908eace869cc35128c31fc2ab502f72e4dff31aab23e0244c4b04b11ab00000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100f43591c156038ba217756006bb3c55f7d113a325cdd7d9303c82115372858d68022016355b5aadf222bc8d12e426c75f4a03423917b2443a103eb2a498a3a2234374014730440220585dee80fafa264beac535c3c0bb5838ac348b156fdc982f86adc08dfc9bfd250220130abb82f9f295cc9ef423dcfef772fde2acd85d9df48cc538981d26a10a9c10012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
5058                 } );
5059
5060                 // commitment tx with two outputs untrimmed (minimum feerate)
5061                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5062                 chan.feerate_per_kw = 4915;
5063
5064                 test_commitment!("304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a720",
5065                                  "30450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf5",
5066                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004830450221008a953551f4d67cb4df3037207fc082ddaf6be84d417b0bd14c80aab66f1b01a402207508796dc75034b2dee876fe01dc05a08b019f3e5d689ac8842ade2f1befccf50147304402203a286936e74870ca1459c700c71202af0381910a6bfab687ef494ef1bc3e02c902202506c362d0e3bee15e802aa729bf378e051644648253513f1c085b264cc2a72001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5067
5068                 // commitment tx with two outputs untrimmed (maximum feerate)
5069                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5070                 chan.feerate_per_kw = 9651180;
5071
5072                 test_commitment!("304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd3",
5073                                  "3045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de",
5074                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e4840400483045022100e11b638c05c650c2f63a421d36ef8756c5ce82f2184278643520311cdf50aa200220259565fb9c8e4a87ccaf17f27a3b9ca4f20625754a0920d9c6c239d8156a11de0147304402200a8544eba1d216f5c5e530597665fa9bec56943c0f66d98fc3d028df52d84f7002201e45fa5c6bc3a506cc2553e7d1c0043a9811313fc39c954692c0d47cfce2bbd301475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5075
5076                 // commitment tx with one output untrimmed (minimum feerate)
5077                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5078                 chan.feerate_per_kw = 9651181;
5079
5080                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5081                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5082                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5083
5084                 // commitment tx with fee greater than funder amount
5085                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
5086                 chan.feerate_per_kw = 9651936;
5087
5088                 test_commitment!("304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a2",
5089                                  "304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a379",
5090                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014cc1b07838e387deacd0e5232e1e8b49f4c29e484040047304402207e8d51e0c570a5868a78414f4e0cbfaed1106b171b9581542c30718ee4eb95ba02203af84194c97adf98898c9afe2f2ed4a7f8dba05a2dfab28ac9d9c604aa49a3790147304402202ade0142008309eb376736575ad58d03e5b115499709c6db0b46e36ff394b492022037b63d78d66404d6504d4c4ac13be346f3d1802928a6d3ad95a6a944227161a201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
5091         }
5092
5093         #[test]
5094         fn test_per_commitment_secret_gen() {
5095                 // Test vectors from BOLT 3 Appendix D:
5096
5097                 let mut seed = [0; 32];
5098                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
5099                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5100                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
5101
5102                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
5103                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
5104                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
5105
5106                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
5107                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
5108
5109                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
5110                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
5111
5112                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
5113                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
5114                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
5115         }
5116
5117         #[test]
5118         fn test_key_derivation() {
5119                 // Test vectors from BOLT 3 Appendix E:
5120                 let secp_ctx = Secp256k1::new();
5121
5122                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
5123                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
5124
5125                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
5126                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
5127
5128                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
5129                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
5130
5131                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5132                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
5133
5134                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
5135                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
5136
5137                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
5138                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
5139
5140                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
5141                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
5142         }
5143 }