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

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