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

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