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