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

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