_ 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_hashes::hash160::Hash as Hash160;
  12 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  13
  14 use secp256k1::key::{PublicKey,SecretKey};
  15 use secp256k1::{Secp256k1,Signature};
  16 use secp256k1;
  17
  18 use ln::features::{ChannelFeatures, InitFeatures};
  19 use ln::msgs;
  20 use ln::msgs::{DecodeError, OptionalField, DataLossProtect};
  21 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep};
  22 use ln::channelmanager::{PendingHTLCStatus, HTLCSource, HTLCFailReason, HTLCFailureMsg, PendingHTLCInfo, RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT, MAX_LOCAL_BREAKDOWN_TIMEOUT};
  23 use ln::chan_utils::{CounterpartyCommitmentSecrets, LocalCommitmentTransaction, TxCreationKeys, HTLCOutputInCommitment, HTLC_SUCCESS_TX_WEIGHT, HTLC_TIMEOUT_TX_WEIGHT, make_funding_redeemscript, ChannelPublicKeys};
  24 use ln::chan_utils;
  25 use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
  26 use chain::transaction::OutPoint;
  27 use chain::keysinterface::{ChannelKeys, KeysInterface};
  28 use util::transaction_utils;
  29 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
  30 use util::logger::{Logger, LogHolder};
  31 use util::errors::APIError;
  32 use util::config::{UserConfig,ChannelConfig};
  33
  34 use std;
  35 use std::default::Default;
  36 use std::{cmp,mem,fmt};
  37 use std::sync::{Arc};
  38 use std::ops::Deref;
  39
  40 #[cfg(test)]
  41 pub struct ChannelValueStat {
  42         pub value_to_self_msat: u64,
  43         pub channel_value_msat: u64,
  44         pub channel_reserve_msat: u64,
  45         pub pending_outbound_htlcs_amount_msat: u64,
  46         pub pending_inbound_htlcs_amount_msat: u64,
  47         pub holding_cell_outbound_amount_msat: u64,
  48         pub their_max_htlc_value_in_flight_msat: u64, // outgoing
  49 }
  50
  51 enum InboundHTLCRemovalReason {
  52         FailRelay(msgs::OnionErrorPacket),
  53         FailMalformed(([u8; 32], u16)),
  54         Fulfill(PaymentPreimage),
  55 }
  56
  57 enum InboundHTLCState {
  58         /// Added by remote, to be included in next local commitment tx.
  59         RemoteAnnounced(PendingHTLCStatus),
  60         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
  61         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
  62         /// accept this HTLC. Implies AwaitingRemoteRevoke.
  63         /// We also have not yet included this HTLC in a commitment_signed message, and are waiting on
  64         /// a remote revoke_and_ack on a previous state before we can do so.
  65         AwaitingRemoteRevokeToAnnounce(PendingHTLCStatus),
  66         /// Included in a received commitment_signed message (implying we've revoke_and_ack'ed it), but
  67         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
  68         /// accept this HTLC. Implies AwaitingRemoteRevoke.
  69         /// We have included this HTLC in our latest commitment_signed and are now just waiting on a
  70         /// revoke_and_ack.
  71         AwaitingAnnouncedRemoteRevoke(PendingHTLCStatus),
  72         Committed,
  73         /// Removed by us and a new commitment_signed was sent (if we were AwaitingRemoteRevoke when we
  74         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
  75         /// we'll drop it.
  76         /// Note that we have to keep an eye on the HTLC until we've received a broadcastable
  77         /// commitment transaction without it as otherwise we'll have to force-close the channel to
  78         /// claim it before the timeout (obviously doesn't apply to revoked HTLCs that we can't claim
  79         /// anyway). That said, ChannelMonitor does this for us (see
  80         /// ChannelMonitor::would_broadcast_at_height) so we actually remove the HTLC from our own
  81         /// local state before then, once we're sure that the next commitment_signed and
  82         /// ChannelMonitor::provide_latest_local_commitment_tx_info will not include this HTLC.
  83         LocalRemoved(InboundHTLCRemovalReason),
  84 }
  85
  86 struct InboundHTLCOutput {
  87         htlc_id: u64,
  88         amount_msat: u64,
  89         cltv_expiry: u32,
  90         payment_hash: PaymentHash,
  91         state: InboundHTLCState,
  92 }
  93
  94 enum OutboundHTLCState {
  95         /// Added by us and included in a commitment_signed (if we were AwaitingRemoteRevoke when we
  96         /// created it we would have put it in the holding cell instead). When they next revoke_and_ack
  97         /// we will promote to Committed (note that they may not accept it until the next time we
  98         /// revoke, but we don't really care about that:
  99         ///  * they've revoked, so worst case we can announce an old state and get our (option on)
 100         ///    money back (though we won't), and,
 101         ///  * we'll send them a revoke when they send a commitment_signed, and since only they're
 102         ///    allowed to remove it, the "can only be removed once committed on both sides" requirement
 103         ///    doesn't matter to us and it's up to them to enforce it, worst-case they jump ahead but
 104         ///    we'll never get out of sync).
 105         /// Note that we Box the OnionPacket as it's rather large and we don't want to blow up
 106         /// OutboundHTLCOutput's size just for a temporary bit
 107         LocalAnnounced(Box<msgs::OnionPacket>),
 108         Committed,
 109         /// Remote removed this (outbound) HTLC. We're waiting on their commitment_signed to finalize
 110         /// the change (though they'll need to revoke before we fail the payment).
 111         RemoteRemoved(Option<HTLCFailReason>),
 112         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 113         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 114         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 115         /// We also have not yet removed this HTLC in a commitment_signed message, and are waiting on a
 116         /// remote revoke_and_ack on a previous state before we can do so.
 117         AwaitingRemoteRevokeToRemove(Option<HTLCFailReason>),
 118         /// Remote removed this and sent a commitment_signed (implying we've revoke_and_ack'ed it), but
 119         /// the remote side hasn't yet revoked their previous state, which we need them to do before we
 120         /// can do any backwards failing. Implies AwaitingRemoteRevoke.
 121         /// We have removed this HTLC in our latest commitment_signed and are now just waiting on a
 122         /// revoke_and_ack to drop completely.
 123         AwaitingRemovedRemoteRevoke(Option<HTLCFailReason>),
 124 }
 125
 126 struct OutboundHTLCOutput {
 127         htlc_id: u64,
 128         amount_msat: u64,
 129         cltv_expiry: u32,
 130         payment_hash: PaymentHash,
 131         state: OutboundHTLCState,
 132         source: HTLCSource,
 133 }
 134
 135 /// See AwaitingRemoteRevoke ChannelState for more info
 136 enum HTLCUpdateAwaitingACK {
 137         AddHTLC { // TODO: Time out if we're getting close to cltv_expiry
 138                 // always outbound
 139                 amount_msat: u64,
 140                 cltv_expiry: u32,
 141                 payment_hash: PaymentHash,
 142                 source: HTLCSource,
 143                 onion_routing_packet: msgs::OnionPacket,
 144         },
 145         ClaimHTLC {
 146                 payment_preimage: PaymentPreimage,
 147                 htlc_id: u64,
 148         },
 149         FailHTLC {
 150                 htlc_id: u64,
 151                 err_packet: msgs::OnionErrorPacket,
 152         },
 153 }
 154
 155 /// There are a few "states" and then a number of flags which can be applied:
 156 /// We first move through init with OurInitSent -> TheirInitSent -> FundingCreated -> FundingSent.
 157 /// TheirFundingLocked and OurFundingLocked then get set on FundingSent, and when both are set we
 158 /// move on to ChannelFunded.
 159 /// Note that PeerDisconnected can be set on both ChannelFunded and FundingSent.
 160 /// ChannelFunded can then get all remaining flags set on it, until we finish shutdown, then we
 161 /// move on to ShutdownComplete, at which point most calls into this channel are disallowed.
 162 enum ChannelState {
 163         /// Implies we have (or are prepared to) send our open_channel/accept_channel message
 164         OurInitSent = (1 << 0),
 165         /// Implies we have received their open_channel/accept_channel message
 166         TheirInitSent = (1 << 1),
 167         /// We have sent funding_created and are awaiting a funding_signed to advance to FundingSent.
 168         /// Note that this is nonsense for an inbound channel as we immediately generate funding_signed
 169         /// upon receipt of funding_created, so simply skip this state.
 170         FundingCreated = 4,
 171         /// Set when we have received/sent funding_created and funding_signed and are thus now waiting
 172         /// on the funding transaction to confirm. The FundingLocked flags are set to indicate when we
 173         /// and our counterparty consider the funding transaction confirmed.
 174         FundingSent = 8,
 175         /// Flag which can be set on FundingSent to indicate they sent us a funding_locked message.
 176         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 177         TheirFundingLocked = (1 << 4),
 178         /// Flag which can be set on FundingSent to indicate we sent them a funding_locked message.
 179         /// Once both TheirFundingLocked and OurFundingLocked are set, state moves on to ChannelFunded.
 180         OurFundingLocked = (1 << 5),
 181         ChannelFunded = 64,
 182         /// Flag which is set on ChannelFunded and FundingSent indicating remote side is considered
 183         /// "disconnected" and no updates are allowed until after we've done a channel_reestablish
 184         /// dance.
 185         PeerDisconnected = (1 << 7),
 186         /// Flag which is set on ChannelFunded, FundingCreated, and FundingSent indicating the user has
 187         /// told us they failed to update our ChannelMonitor somewhere and we should pause sending any
 188         /// outbound messages until they've managed to do so.
 189         MonitorUpdateFailed = (1 << 8),
 190         /// Flag which implies that we have sent a commitment_signed but are awaiting the responding
 191         /// revoke_and_ack message. During this time period, we can't generate new commitment_signed
 192         /// messages as then we will be unable to determine which HTLCs they included in their
 193         /// revoke_and_ack implicit ACK, so instead we have to hold them away temporarily to be sent
 194         /// later.
 195         /// Flag is set on ChannelFunded.
 196         AwaitingRemoteRevoke = (1 << 9),
 197         /// Flag which is set on ChannelFunded or FundingSent after receiving a shutdown message from
 198         /// the remote end. If set, they may not add any new HTLCs to the channel, and we are expected
 199         /// to respond with our own shutdown message when possible.
 200         RemoteShutdownSent = (1 << 10),
 201         /// Flag which is set on ChannelFunded or FundingSent after sending a shutdown message. At this
 202         /// point, we may not add any new HTLCs to the channel.
 203         /// TODO: Investigate some kind of timeout mechanism by which point the remote end must provide
 204         /// us their shutdown.
 205         LocalShutdownSent = (1 << 11),
 206         /// We've successfully negotiated a closing_signed dance. At this point ChannelManager is about
 207         /// to drop us, but we store this anyway.
 208         ShutdownComplete = 4096,
 209 }
 210 const BOTH_SIDES_SHUTDOWN_MASK: u32 = (ChannelState::LocalShutdownSent as u32 | ChannelState::RemoteShutdownSent as u32);
 211 const MULTI_STATE_FLAGS: u32 = (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32);
 212
 213 const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
 214
 215 /// Liveness is called to fluctuate given peer disconnecton/monitor failures/closing.
 216 /// If channel is public, network should have a liveness view announced by us on a
 217 /// best-effort, which means we may filter out some status transitions to avoid spam.
 218 /// See further timer_chan_freshness_every_min.
 219 #[derive(PartialEq)]
 220 enum UpdateStatus {
 221         /// Status has been gossiped.
 222         Fresh,
 223         /// Status has been changed.
 224         DisabledMarked,
 225         /// Status has been marked to be gossiped at next flush
 226         DisabledStaged,
 227 }
 228
 229 // TODO: We should refactor this to be an Inbound/OutboundChannel until initial setup handshaking
 230 // has been completed, and then turn into a Channel to get compiler-time enforcement of things like
 231 // calling channel_id() before we're set up or things like get_outbound_funding_signed on an
 232 // inbound channel.
 233 pub(super) struct Channel<ChanSigner: ChannelKeys> {
 234         config: ChannelConfig,
 235
 236         user_id: u64,
 237
 238         channel_id: [u8; 32],
 239         channel_state: u32,
 240         channel_outbound: bool,
 241         secp_ctx: Secp256k1<secp256k1::All>,
 242         channel_value_satoshis: u64,
 243
 244         latest_monitor_update_id: u64,
 245
 246         #[cfg(not(test))]
 247         local_keys: ChanSigner,
 248         #[cfg(test)]
 249         pub(super) local_keys: ChanSigner,
 250         shutdown_pubkey: PublicKey,
 251         destination_script: Script,
 252
 253         // Our commitment numbers start at 2^48-1 and count down, whereas the ones used in transaction
 254         // generation start at 0 and count up...this simplifies some parts of implementation at the
 255         // cost of others, but should really just be changed.
 256
 257         cur_local_commitment_transaction_number: u64,
 258         cur_remote_commitment_transaction_number: u64,
 259         value_to_self_msat: u64, // Excluding all pending_htlcs, excluding fees
 260         pending_inbound_htlcs: Vec<InboundHTLCOutput>,
 261         pending_outbound_htlcs: Vec<OutboundHTLCOutput>,
 262         holding_cell_htlc_updates: Vec<HTLCUpdateAwaitingACK>,
 263
 264         /// When resending CS/RAA messages on channel monitor restoration or on reconnect, we always
 265         /// need to ensure we resend them in the order we originally generated them. Note that because
 266         /// there can only ever be one in-flight CS and/or one in-flight RAA at any time, it is
 267         /// sufficient to simply set this to the opposite of any message we are generating as we
 268         /// generate it. ie when we generate a CS, we set this to RAAFirst as, if there is a pending
 269         /// in-flight RAA to resend, it will have been the first thing we generated, and thus we should
 270         /// send it first.
 271         resend_order: RAACommitmentOrder,
 272
 273         monitor_pending_funding_locked: bool,
 274         monitor_pending_revoke_and_ack: bool,
 275         monitor_pending_commitment_signed: bool,
 276         monitor_pending_forwards: Vec<(PendingHTLCInfo, u64)>,
 277         monitor_pending_failures: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
 278
 279         // pending_update_fee is filled when sending and receiving update_fee
 280         // For outbound channel, feerate_per_kw is updated with the value from
 281         // pending_update_fee when revoke_and_ack is received
 282         //
 283         // For inbound channel, feerate_per_kw is updated when it receives
 284         // commitment_signed and revoke_and_ack is generated
 285         // The pending value is kept when another pair of update_fee and commitment_signed
 286         // is received during AwaitingRemoteRevoke and relieved when the expected
 287         // revoke_and_ack is received and new commitment_signed is generated to be
 288         // sent to the funder. Otherwise, the pending value is removed when receiving
 289         // commitment_signed.
 290         pending_update_fee: Option<u64>,
 291         // update_fee() during ChannelState::AwaitingRemoteRevoke is hold in
 292         // holdina_cell_update_fee then moved to pending_udpate_fee when revoke_and_ack
 293         // is received. holding_cell_update_fee is updated when there are additional
 294         // update_fee() during ChannelState::AwaitingRemoteRevoke.
 295         holding_cell_update_fee: Option<u64>,
 296         next_local_htlc_id: u64,
 297         next_remote_htlc_id: u64,
 298         update_time_counter: u32,
 299         feerate_per_kw: u64,
 300
 301         #[cfg(debug_assertions)]
 302         /// Max to_local and to_remote outputs in a locally-generated commitment transaction
 303         max_commitment_tx_output_local: ::std::sync::Mutex<(u64, u64)>,
 304         #[cfg(debug_assertions)]
 305         /// Max to_local and to_remote outputs in a remote-generated commitment transaction
 306         max_commitment_tx_output_remote: ::std::sync::Mutex<(u64, u64)>,
 307
 308         last_sent_closing_fee: Option<(u64, u64, Signature)>, // (feerate, fee, our_sig)
 309
 310         funding_txo: Option<OutPoint>,
 311
 312         /// The hash of the block in which the funding transaction reached our CONF_TARGET. We use this
 313         /// to detect unconfirmation after a serialize-unserialize roundtrip where we may not see a full
 314         /// series of block_connected/block_disconnected calls. Obviously this is not a guarantee as we
 315         /// could miss the funding_tx_confirmed_in block as well, but it serves as a useful fallback.
 316         funding_tx_confirmed_in: Option<Sha256dHash>,
 317         short_channel_id: Option<u64>,
 318         /// Used to deduplicate block_connected callbacks, also used to verify consistency during
 319         /// ChannelManager deserialization (hence pub(super))
 320         pub(super) last_block_connected: Sha256dHash,
 321         funding_tx_confirmations: u64,
 322
 323         their_dust_limit_satoshis: u64,
 324         #[cfg(test)]
 325         pub(super) our_dust_limit_satoshis: u64,
 326         #[cfg(not(test))]
 327         our_dust_limit_satoshis: u64,
 328         #[cfg(test)]
 329         pub(super) their_max_htlc_value_in_flight_msat: u64,
 330         #[cfg(not(test))]
 331         their_max_htlc_value_in_flight_msat: u64,
 332         //get_our_max_htlc_value_in_flight_msat(): u64,
 333         /// minimum channel reserve for **self** to maintain - set by them.
 334         their_channel_reserve_satoshis: u64,
 335         //get_our_channel_reserve_satoshis(): u64,
 336         their_htlc_minimum_msat: u64,
 337         our_htlc_minimum_msat: u64,
 338         their_to_self_delay: u16,
 339         our_to_self_delay: u16,
 340         #[cfg(test)]
 341         pub their_max_accepted_htlcs: u16,
 342         #[cfg(not(test))]
 343         their_max_accepted_htlcs: u16,
 344         //implied by OUR_MAX_HTLCS: our_max_accepted_htlcs: u16,
 345         minimum_depth: u32,
 346
 347         their_pubkeys: Option<ChannelPublicKeys>,
 348
 349         their_cur_commitment_point: Option<PublicKey>,
 350
 351         their_prev_commitment_point: Option<PublicKey>,
 352         their_node_id: PublicKey,
 353
 354         their_shutdown_scriptpubkey: Option<Script>,
 355
 356         /// Used exclusively to broadcast the latest local state, mostly a historical quirk that this
 357         /// is here:
 358         channel_monitor: Option<ChannelMonitor<ChanSigner>>,
 359         commitment_secrets: CounterpartyCommitmentSecrets,
 360
 361         network_sync: UpdateStatus,
 362
 363         logger: Arc<Logger>,
 364 }
 365
 366 pub const OUR_MAX_HTLCS: u16 = 50; //TODO
 367 /// Confirmation count threshold at which we close a channel. Ideally we'd keep the channel around
 368 /// on ice until the funding transaction gets more confirmations, but the LN protocol doesn't
 369 /// really allow for this, so instead we're stuck closing it out at that point.
 370 const UNCONF_THRESHOLD: u32 = 6;
 371 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
 372 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?)
 373
 374 #[cfg(not(test))]
 375 const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 376 #[cfg(test)]
 377 pub const COMMITMENT_TX_BASE_WEIGHT: u64 = 724;
 378 #[cfg(not(test))]
 379 const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 380 #[cfg(test)]
 381 pub const COMMITMENT_TX_WEIGHT_PER_HTLC: u64 = 172;
 382
 383 /// Maximmum `funding_satoshis` value, according to the BOLT #2 specification
 384 /// it's 2^24.
 385 pub const MAX_FUNDING_SATOSHIS: u64 = (1 << 24);
 386
 387 /// Used to return a simple Error back to ChannelManager. Will get converted to a
 388 /// msgs::ErrorAction::SendErrorMessage or msgs::ErrorAction::IgnoreError as appropriate with our
 389 /// channel_id in ChannelManager.
 390 pub(super) enum ChannelError {
 391         Ignore(&'static str),
 392         Close(&'static str),
 393         CloseDelayBroadcast {
 394                 msg: &'static str,
 395                 update: ChannelMonitorUpdate,
 396         },
 397 }
 398
 399 impl fmt::Debug for ChannelError {
 400         fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 401                 match self {
 402                         &ChannelError::Ignore(e) => write!(f, "Ignore : {}", e),
 403                         &ChannelError::Close(e) => write!(f, "Close : {}", e),
 404                         &ChannelError::CloseDelayBroadcast { msg, .. } => write!(f, "CloseDelayBroadcast : {}", msg)
 405                 }
 406         }
 407 }
 408
 409 macro_rules! secp_check {
 410         ($res: expr, $err: expr) => {
 411                 match $res {
 412                         Ok(thing) => thing,
 413                         Err(_) => return Err(ChannelError::Close($err)),
 414                 }
 415         };
 416 }
 417
 418 impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
 419         // Convert constants + channel value to limits:
 420         fn get_our_max_htlc_value_in_flight_msat(channel_value_satoshis: u64) -> u64 {
 421                 channel_value_satoshis * 1000 / 10 //TODO
 422         }
 423
 424         /// Returns a minimum channel reserve value **they** need to maintain
 425         ///
 426         /// Guaranteed to return a value no larger than channel_value_satoshis
 427         pub(crate) fn get_our_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_our_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                         their_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 our_channel_reserve_satoshis = Channel::<ChanSigner>::get_our_channel_reserve_satoshis(msg.funding_satoshis);
 643                 if our_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 our_channel_reserve_satoshis < msg.dust_limit_satoshis {
 650                         return Err(ChannelError::Close("Dust limit too high for our channel reserve"));
 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 <= our_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                         their_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.their_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_our_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(&Hash160::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 = Hash160::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: &Sha256dHash, 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_our_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.their_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, &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, &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 our_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_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 + removed_outbound_total_msat {
1721                         return Err(ChannelError::Close("Remote HTLC add would put them over 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                 //TODO: Check msg.cltv_expiry further? Do this in channel manager?
1731
1732                 if self.channel_state & ChannelState::LocalShutdownSent as u32 != 0 {
1733                         if let PendingHTLCStatus::Forward(_) = pending_forward_state {
1734                                 panic!("ChannelManager shouldn't be trying to add a forwardable HTLC after we've started closing");
1735                         }
1736                 }
1737
1738                 // Now update local state:
1739                 self.next_remote_htlc_id += 1;
1740                 self.pending_inbound_htlcs.push(InboundHTLCOutput {
1741                         htlc_id: msg.htlc_id,
1742                         amount_msat: msg.amount_msat,
1743                         payment_hash: msg.payment_hash,
1744                         cltv_expiry: msg.cltv_expiry,
1745                         state: InboundHTLCState::RemoteAnnounced(pending_forward_state),
1746                 });
1747                 Ok(())
1748         }
1749
1750         /// Marks an outbound HTLC which we have received update_fail/fulfill/malformed
1751         #[inline]
1752         fn mark_outbound_htlc_removed(&mut self, htlc_id: u64, check_preimage: Option<PaymentHash>, fail_reason: Option<HTLCFailReason>) -> Result<&HTLCSource, ChannelError> {
1753                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1754                         if htlc.htlc_id == htlc_id {
1755                                 match check_preimage {
1756                                         None => {},
1757                                         Some(payment_hash) =>
1758                                                 if payment_hash != htlc.payment_hash {
1759                                                         return Err(ChannelError::Close("Remote tried to fulfill HTLC with an incorrect preimage"));
1760                                                 }
1761                                 };
1762                                 match htlc.state {
1763                                         OutboundHTLCState::LocalAnnounced(_) =>
1764                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC before it had been committed")),
1765                                         OutboundHTLCState::Committed => {
1766                                                 htlc.state = OutboundHTLCState::RemoteRemoved(fail_reason);
1767                                         },
1768                                         OutboundHTLCState::AwaitingRemoteRevokeToRemove(_) | OutboundHTLCState::AwaitingRemovedRemoteRevoke(_) | OutboundHTLCState::RemoteRemoved(_) =>
1769                                                 return Err(ChannelError::Close("Remote tried to fulfill/fail HTLC that they'd already fulfilled/failed")),
1770                                 }
1771                                 return Ok(&htlc.source);
1772                         }
1773                 }
1774                 Err(ChannelError::Close("Remote tried to fulfill/fail an HTLC we couldn't find"))
1775         }
1776
1777         pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result<HTLCSource, ChannelError> {
1778                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1779                         return Err(ChannelError::Close("Got fulfill HTLC message when channel was not in an operational state"));
1780                 }
1781                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1782                         return Err(ChannelError::Close("Peer sent update_fulfill_htlc when we needed a channel_reestablish"));
1783                 }
1784
1785                 let payment_hash = PaymentHash(Sha256::hash(&msg.payment_preimage.0[..]).into_inner());
1786                 self.mark_outbound_htlc_removed(msg.htlc_id, Some(payment_hash), None).map(|source| source.clone())
1787         }
1788
1789         pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1790                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1791                         return Err(ChannelError::Close("Got fail HTLC message when channel was not in an operational state"));
1792                 }
1793                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1794                         return Err(ChannelError::Close("Peer sent update_fail_htlc when we needed a channel_reestablish"));
1795                 }
1796
1797                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1798                 Ok(())
1799         }
1800
1801         pub fn update_fail_malformed_htlc<'a>(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), ChannelError> {
1802                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1803                         return Err(ChannelError::Close("Got fail malformed HTLC message when channel was not in an operational state"));
1804                 }
1805                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1806                         return Err(ChannelError::Close("Peer sent update_fail_malformed_htlc when we needed a channel_reestablish"));
1807                 }
1808
1809                 self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?;
1810                 Ok(())
1811         }
1812
1813         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 {
1814                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
1815                         return Err((None, ChannelError::Close("Got commitment signed message when channel was not in an operational state")));
1816                 }
1817                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
1818                         return Err((None, ChannelError::Close("Peer sent commitment_signed when we needed a channel_reestablish")));
1819                 }
1820                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
1821                         return Err((None, ChannelError::Close("Peer sent commitment_signed after we'd started exchanging closing_signeds")));
1822                 }
1823
1824                 let funding_script = self.get_funding_redeemscript();
1825
1826                 let local_keys = self.build_local_transaction_keys(self.cur_local_commitment_transaction_number).map_err(|e| (None, e))?;
1827
1828                 let mut update_fee = false;
1829                 let feerate_per_kw = if !self.channel_outbound && self.pending_update_fee.is_some() {
1830                         update_fee = true;
1831                         self.pending_update_fee.unwrap()
1832                 } else {
1833                         self.feerate_per_kw
1834                 };
1835
1836                 let mut local_commitment_tx = {
1837                         let mut commitment_tx = self.build_commitment_transaction(self.cur_local_commitment_transaction_number, &local_keys, true, false, feerate_per_kw);
1838                         let htlcs_cloned: Vec<_> = commitment_tx.2.drain(..).map(|htlc| (htlc.0, htlc.1.map(|h| h.clone()))).collect();
1839                         (commitment_tx.0, commitment_tx.1, htlcs_cloned)
1840                 };
1841                 let local_commitment_txid = local_commitment_tx.0.txid();
1842                 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)[..]);
1843                 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));
1844                 if let Err(_) = self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey()) {
1845                         return Err((None, ChannelError::Close("Invalid commitment tx signature from peer")));
1846                 }
1847
1848                 //If channel fee was updated by funder confirm funder can afford the new fee rate when applied to the current local commitment transaction
1849                 if update_fee {
1850                         let num_htlcs = local_commitment_tx.1;
1851                         let total_fee: u64 = feerate_per_kw as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
1852
1853                         if self.channel_value_satoshis - self.value_to_self_msat / 1000 < total_fee + self.their_channel_reserve_satoshis {
1854                                 return Err((None, ChannelError::Close("Funding remote cannot afford proposed new fee")));
1855                         }
1856                 }
1857
1858                 if msg.htlc_signatures.len() != local_commitment_tx.1 {
1859                         return Err((None, ChannelError::Close("Got wrong number of HTLC signatures from remote")));
1860                 }
1861
1862                 // TODO: Merge these two, sadly they are currently both required to be passed separately to
1863                 // ChannelMonitor:
1864                 let mut htlcs_without_source = Vec::with_capacity(local_commitment_tx.2.len());
1865                 let mut htlcs_and_sigs = Vec::with_capacity(local_commitment_tx.2.len());
1866                 for (idx, (htlc, source)) in local_commitment_tx.2.drain(..).enumerate() {
1867                         if let Some(_) = htlc.transaction_output_index {
1868                                 let htlc_tx = self.build_htlc_transaction(&local_commitment_txid, &htlc, true, &local_keys, feerate_per_kw);
1869                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &local_keys);
1870                                 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));
1871                                 let htlc_sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]);
1872                                 if let Err(_) = self.secp_ctx.verify(&htlc_sighash, &msg.htlc_signatures[idx], &local_keys.b_htlc_key) {
1873                                         return Err((None, ChannelError::Close("Invalid HTLC tx signature from peer")));
1874                                 }
1875                                 htlcs_without_source.push((htlc.clone(), Some(msg.htlc_signatures[idx])));
1876                                 htlcs_and_sigs.push((htlc, Some(msg.htlc_signatures[idx]), source));
1877                         } else {
1878                                 htlcs_without_source.push((htlc.clone(), None));
1879                                 htlcs_and_sigs.push((htlc, None, source));
1880                         }
1881                 }
1882
1883                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number - 1));
1884                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 1);
1885
1886                 // Update state now that we've passed all the can-fail calls...
1887                 let mut need_our_commitment = false;
1888                 if !self.channel_outbound {
1889                         if let Some(fee_update) = self.pending_update_fee {
1890                                 self.feerate_per_kw = fee_update;
1891                                 // We later use the presence of pending_update_fee to indicate we should generate a
1892                                 // commitment_signed upon receipt of revoke_and_ack, so we can only set it to None
1893                                 // if we're not awaiting a revoke (ie will send a commitment_signed now).
1894                                 if (self.channel_state & ChannelState::AwaitingRemoteRevoke as u32) == 0 {
1895                                         need_our_commitment = true;
1896                                         self.pending_update_fee = None;
1897                                 }
1898                         }
1899                 }
1900
1901                 let their_funding_pubkey = self.their_pubkeys.as_ref().unwrap().funding_pubkey;
1902
1903                 self.latest_monitor_update_id += 1;
1904                 let mut monitor_update = ChannelMonitorUpdate {
1905                         update_id: self.latest_monitor_update_id,
1906                         updates: vec![ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
1907                                 commitment_tx: LocalCommitmentTransaction::new_missing_local_sig(local_commitment_tx.0, &msg.signature, &PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()), &their_funding_pubkey, local_keys, self.feerate_per_kw, htlcs_without_source),
1908                                 htlc_outputs: htlcs_and_sigs
1909                         }]
1910                 };
1911                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
1912
1913                 for htlc in self.pending_inbound_htlcs.iter_mut() {
1914                         let new_forward = if let &InboundHTLCState::RemoteAnnounced(ref forward_info) = &htlc.state {
1915                                 Some(forward_info.clone())
1916                         } else { None };
1917                         if let Some(forward_info) = new_forward {
1918                                 htlc.state = InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info);
1919                                 need_our_commitment = true;
1920                         }
1921                 }
1922                 for htlc in self.pending_outbound_htlcs.iter_mut() {
1923                         if let Some(fail_reason) = if let &mut OutboundHTLCState::RemoteRemoved(ref mut fail_reason) = &mut htlc.state {
1924                                 Some(fail_reason.take())
1925                         } else { None } {
1926                                 htlc.state = OutboundHTLCState::AwaitingRemoteRevokeToRemove(fail_reason);
1927                                 need_our_commitment = true;
1928                         }
1929                 }
1930
1931                 self.cur_local_commitment_transaction_number -= 1;
1932                 // Note that if we need_our_commitment & !AwaitingRemoteRevoke we'll call
1933                 // send_commitment_no_status_check() next which will reset this to RAAFirst.
1934                 self.resend_order = RAACommitmentOrder::CommitmentFirst;
1935
1936                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0 {
1937                         // In case we initially failed monitor updating without requiring a response, we need
1938                         // to make sure the RAA gets sent first.
1939                         self.monitor_pending_revoke_and_ack = true;
1940                         if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1941                                 // If we were going to send a commitment_signed after the RAA, go ahead and do all
1942                                 // the corresponding HTLC status updates so that get_last_commitment_update
1943                                 // includes the right HTLCs.
1944                                 self.monitor_pending_commitment_signed = true;
1945                                 let (_, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1946                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1947                                 // strictly increasing by one, so decrement it here.
1948                                 self.latest_monitor_update_id = monitor_update.update_id;
1949                                 monitor_update.updates.append(&mut additional_update.updates);
1950                         }
1951                         // TODO: Call maybe_propose_first_closing_signed on restoration (or call it here and
1952                         // re-send the message on restoration)
1953                         return Err((Some(monitor_update), ChannelError::Ignore("Previous monitor update failure prevented generation of RAA")));
1954                 }
1955
1956                 let (our_commitment_signed, closing_signed) = if need_our_commitment && (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == 0 {
1957                         // If we're AwaitingRemoteRevoke we can't send a new commitment here, but that's ok -
1958                         // we'll send one right away when we get the revoke_and_ack when we
1959                         // free_holding_cell_htlcs().
1960                         let (msg, mut additional_update) = self.send_commitment_no_status_check().map_err(|e| (None, e))?;
1961                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
1962                         // strictly increasing by one, so decrement it here.
1963                         self.latest_monitor_update_id = monitor_update.update_id;
1964                         monitor_update.updates.append(&mut additional_update.updates);
1965                         (Some(msg), None)
1966                 } else if !need_our_commitment {
1967                         (None, self.maybe_propose_first_closing_signed(fee_estimator))
1968                 } else { (None, None) };
1969
1970                 Ok((msgs::RevokeAndACK {
1971                         channel_id: self.channel_id,
1972                         per_commitment_secret: per_commitment_secret,
1973                         next_per_commitment_point: next_per_commitment_point,
1974                 }, our_commitment_signed, closing_signed, monitor_update))
1975         }
1976
1977         /// Used to fulfill holding_cell_htlcs when we get a remote ack (or implicitly get it by them
1978         /// fulfilling or failing the last pending HTLC)
1979         fn free_holding_cell_htlcs(&mut self) -> Result<Option<(msgs::CommitmentUpdate, ChannelMonitorUpdate)>, ChannelError> {
1980                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
1981                 if self.holding_cell_htlc_updates.len() != 0 || self.holding_cell_update_fee.is_some() {
1982                         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 { "" });
1983
1984                         let mut monitor_update = ChannelMonitorUpdate {
1985                                 update_id: self.latest_monitor_update_id + 1, // We don't increment this yet!
1986                                 updates: Vec::new(),
1987                         };
1988
1989                         let mut htlc_updates = Vec::new();
1990                         mem::swap(&mut htlc_updates, &mut self.holding_cell_htlc_updates);
1991                         let mut update_add_htlcs = Vec::with_capacity(htlc_updates.len());
1992                         let mut update_fulfill_htlcs = Vec::with_capacity(htlc_updates.len());
1993                         let mut update_fail_htlcs = Vec::with_capacity(htlc_updates.len());
1994                         let mut err = None;
1995                         for htlc_update in htlc_updates.drain(..) {
1996                                 // Note that this *can* fail, though it should be due to rather-rare conditions on
1997                                 // fee races with adding too many outputs which push our total payments just over
1998                                 // the limit. In case it's less rare than I anticipate, we may want to revisit
1999                                 // handling this case better and maybe fulfilling some of the HTLCs while attempting
2000                                 // to rebalance channels.
2001                                 if err.is_some() { // We're back to AwaitingRemoteRevoke (or are about to fail the channel)
2002                                         self.holding_cell_htlc_updates.push(htlc_update);
2003                                 } else {
2004                                         match &htlc_update {
2005                                                 &HTLCUpdateAwaitingACK::AddHTLC {amount_msat, cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet, ..} => {
2006                                                         match self.send_htlc(amount_msat, *payment_hash, cltv_expiry, source.clone(), onion_routing_packet.clone()) {
2007                                                                 Ok(update_add_msg_option) => update_add_htlcs.push(update_add_msg_option.unwrap()),
2008                                                                 Err(e) => {
2009                                                                         match e {
2010                                                                                 ChannelError::Ignore(ref msg) => {
2011                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} due to {}", log_bytes!(payment_hash.0), msg);
2012                                                                                 },
2013                                                                                 _ => {
2014                                                                                         log_info!(self, "Failed to send HTLC with payment_hash {} resulting in a channel closure during holding_cell freeing", log_bytes!(payment_hash.0));
2015                                                                                 },
2016                                                                         }
2017                                                                         err = Some(e);
2018                                                                 }
2019                                                         }
2020                                                 },
2021                                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, htlc_id, .. } => {
2022                                                         match self.get_update_fulfill_htlc(htlc_id, *payment_preimage) {
2023                                                                 Ok((update_fulfill_msg_option, additional_monitor_update_opt)) => {
2024                                                                         update_fulfill_htlcs.push(update_fulfill_msg_option.unwrap());
2025                                                                         if let Some(mut additional_monitor_update) = additional_monitor_update_opt {
2026                                                                                 monitor_update.updates.append(&mut additional_monitor_update.updates);
2027                                                                         }
2028                                                                 },
2029                                                                 Err(e) => {
2030                                                                         if let ChannelError::Ignore(_) = e {}
2031                                                                         else {
2032                                                                                 panic!("Got a non-IgnoreError action trying to fulfill holding cell HTLC");
2033                                                                         }
2034                                                                 }
2035                                                         }
2036                                                 },
2037                                                 &HTLCUpdateAwaitingACK::FailHTLC { htlc_id, ref err_packet } => {
2038                                                         match self.get_update_fail_htlc(htlc_id, err_packet.clone()) {
2039                                                                 Ok(update_fail_msg_option) => update_fail_htlcs.push(update_fail_msg_option.unwrap()),
2040                                                                 Err(e) => {
2041                                                                         if let ChannelError::Ignore(_) = e {}
2042                                                                         else {
2043                                                                                 panic!("Got a non-IgnoreError action trying to fail holding cell HTLC");
2044                                                                         }
2045                                                                 }
2046                                                         }
2047                                                 },
2048                                         }
2049                                         if err.is_some() {
2050                                                 self.holding_cell_htlc_updates.push(htlc_update);
2051                                                 if let Some(ChannelError::Ignore(_)) = err {
2052                                                         // If we failed to add the HTLC, but got an Ignore error, we should
2053                                                         // still send the new commitment_signed, so reset the err to None.
2054                                                         err = None;
2055                                                 }
2056                                         }
2057                                 }
2058                         }
2059                         //TODO: Need to examine the type of err - if it's a fee issue or similar we may want to
2060                         //fail it back the route, if it's a temporary issue we can ignore it...
2061                         match err {
2062                                 None => {
2063                                         if update_add_htlcs.is_empty() && update_fulfill_htlcs.is_empty() && update_fail_htlcs.is_empty() && self.holding_cell_update_fee.is_none() {
2064                                                 // This should never actually happen and indicates we got some Errs back
2065                                                 // from update_fulfill_htlc/update_fail_htlc, but we handle it anyway in
2066                                                 // case there is some strange way to hit duplicate HTLC removes.
2067                                                 return Ok(None);
2068                                         }
2069                                         let update_fee = if let Some(feerate) = self.holding_cell_update_fee {
2070                                                         self.pending_update_fee = self.holding_cell_update_fee.take();
2071                                                         Some(msgs::UpdateFee {
2072                                                                 channel_id: self.channel_id,
2073                                                                 feerate_per_kw: feerate as u32,
2074                                                         })
2075                                                 } else {
2076                                                         None
2077                                                 };
2078
2079                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2080                                         // send_commitment_no_status_check and get_update_fulfill_htlc may bump latest_monitor_id
2081                                         // but we want them to be strictly increasing by one, so reset it here.
2082                                         self.latest_monitor_update_id = monitor_update.update_id;
2083                                         monitor_update.updates.append(&mut additional_update.updates);
2084
2085                                         Ok(Some((msgs::CommitmentUpdate {
2086                                                 update_add_htlcs,
2087                                                 update_fulfill_htlcs,
2088                                                 update_fail_htlcs,
2089                                                 update_fail_malformed_htlcs: Vec::new(),
2090                                                 update_fee: update_fee,
2091                                                 commitment_signed,
2092                                         }, monitor_update)))
2093                                 },
2094                                 Some(e) => Err(e)
2095                         }
2096                 } else {
2097                         Ok(None)
2098                 }
2099         }
2100
2101         /// Handles receiving a remote's revoke_and_ack. Note that we may return a new
2102         /// commitment_signed message here in case we had pending outbound HTLCs to add which were
2103         /// waiting on this revoke_and_ack. The generation of this new commitment_signed may also fail,
2104         /// generating an appropriate error *after* the channel state has been updated based on the
2105         /// revoke_and_ack message.
2106         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>
2107                 where F::Target: FeeEstimator
2108         {
2109                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
2110                         return Err(ChannelError::Close("Got revoke/ACK message when channel was not in an operational state"));
2111                 }
2112                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2113                         return Err(ChannelError::Close("Peer sent revoke_and_ack when we needed a channel_reestablish"));
2114                 }
2115                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK == BOTH_SIDES_SHUTDOWN_MASK && self.last_sent_closing_fee.is_some() {
2116                         return Err(ChannelError::Close("Peer sent revoke_and_ack after we'd started exchanging closing_signeds"));
2117                 }
2118
2119                 if let Some(their_prev_commitment_point) = self.their_prev_commitment_point {
2120                         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 {
2121                                 return Err(ChannelError::Close("Got a revoke commitment secret which didn't correspond to their current pubkey"));
2122                         }
2123                 }
2124
2125                 if self.channel_state & ChannelState::AwaitingRemoteRevoke as u32 == 0 {
2126                         // Our counterparty seems to have burned their coins to us (by revoking a state when we
2127                         // haven't given them a new commitment transaction to broadcast). We should probably
2128                         // take advantage of this by updating our channel monitor, sending them an error, and
2129                         // waiting for them to broadcast their latest (now-revoked claim). But, that would be a
2130                         // lot of work, and there's some chance this is all a misunderstanding anyway.
2131                         // We have to do *something*, though, since our signer may get mad at us for otherwise
2132                         // jumping a remote commitment number, so best to just force-close and move on.
2133                         return Err(ChannelError::Close("Received an unexpected revoke_and_ack"));
2134                 }
2135
2136                 self.commitment_secrets.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret)
2137                         .map_err(|_| ChannelError::Close("Previous secrets did not match new one"))?;
2138                 self.latest_monitor_update_id += 1;
2139                 let mut monitor_update = ChannelMonitorUpdate {
2140                         update_id: self.latest_monitor_update_id,
2141                         updates: vec![ChannelMonitorUpdateStep::CommitmentSecret {
2142                                 idx: self.cur_remote_commitment_transaction_number + 1,
2143                                 secret: msg.per_commitment_secret,
2144                         }],
2145                 };
2146                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
2147
2148                 // Update state now that we've passed all the can-fail calls...
2149                 // (note that we may still fail to generate the new commitment_signed message, but that's
2150                 // OK, we step the channel here and *then* if the new generation fails we can fail the
2151                 // channel based on that, but stepping stuff here should be safe either way.
2152                 self.channel_state &= !(ChannelState::AwaitingRemoteRevoke as u32);
2153                 self.their_prev_commitment_point = self.their_cur_commitment_point;
2154                 self.their_cur_commitment_point = Some(msg.next_per_commitment_point);
2155                 self.cur_remote_commitment_transaction_number -= 1;
2156
2157                 log_trace!(self, "Updating HTLCs on receipt of RAA...");
2158                 let mut to_forward_infos = Vec::new();
2159                 let mut revoked_htlcs = Vec::new();
2160                 let mut update_fail_htlcs = Vec::new();
2161                 let mut update_fail_malformed_htlcs = Vec::new();
2162                 let mut require_commitment = false;
2163                 let mut value_to_self_msat_diff: i64 = 0;
2164
2165                 {
2166                         // Take references explicitly so that we can hold multiple references to self.
2167                         let pending_inbound_htlcs: &mut Vec<_> = &mut self.pending_inbound_htlcs;
2168                         let pending_outbound_htlcs: &mut Vec<_> = &mut self.pending_outbound_htlcs;
2169                         let logger = LogHolder { logger: &self.logger };
2170
2171                         // We really shouldnt have two passes here, but retain gives a non-mutable ref (Rust bug)
2172                         pending_inbound_htlcs.retain(|htlc| {
2173                                 if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2174                                         log_trace!(logger, " ...removing inbound LocalRemoved {}", log_bytes!(htlc.payment_hash.0));
2175                                         if let &InboundHTLCRemovalReason::Fulfill(_) = reason {
2176                                                 value_to_self_msat_diff += htlc.amount_msat as i64;
2177                                         }
2178                                         false
2179                                 } else { true }
2180                         });
2181                         pending_outbound_htlcs.retain(|htlc| {
2182                                 if let &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) = &htlc.state {
2183                                         log_trace!(logger, " ...removing outbound AwaitingRemovedRemoteRevoke {}", log_bytes!(htlc.payment_hash.0));
2184                                         if let Some(reason) = fail_reason.clone() { // We really want take() here, but, again, non-mut ref :(
2185                                                 revoked_htlcs.push((htlc.source.clone(), htlc.payment_hash, reason));
2186                                         } else {
2187                                                 // They fulfilled, so we sent them money
2188                                                 value_to_self_msat_diff -= htlc.amount_msat as i64;
2189                                         }
2190                                         false
2191                                 } else { true }
2192                         });
2193                         for htlc in pending_inbound_htlcs.iter_mut() {
2194                                 let swap = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_) = &htlc.state {
2195                                         log_trace!(logger, " ...promoting inbound AwaitingRemoteRevokeToAnnounce {} to Committed", log_bytes!(htlc.payment_hash.0));
2196                                         true
2197                                 } else if let &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) = &htlc.state {
2198                                         log_trace!(logger, " ...promoting inbound AwaitingAnnouncedRemoteRevoke {} to Committed", log_bytes!(htlc.payment_hash.0));
2199                                         true
2200                                 } else { false };
2201                                 if swap {
2202                                         let mut state = InboundHTLCState::Committed;
2203                                         mem::swap(&mut state, &mut htlc.state);
2204
2205                                         if let InboundHTLCState::AwaitingRemoteRevokeToAnnounce(forward_info) = state {
2206                                                 htlc.state = InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info);
2207                                                 require_commitment = true;
2208                                         } else if let InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info) = state {
2209                                                 match forward_info {
2210                                                         PendingHTLCStatus::Fail(fail_msg) => {
2211                                                                 require_commitment = true;
2212                                                                 match fail_msg {
2213                                                                         HTLCFailureMsg::Relay(msg) => {
2214                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailRelay(msg.reason.clone()));
2215                                                                                 update_fail_htlcs.push(msg)
2216                                                                         },
2217                                                                         HTLCFailureMsg::Malformed(msg) => {
2218                                                                                 htlc.state = InboundHTLCState::LocalRemoved(InboundHTLCRemovalReason::FailMalformed((msg.sha256_of_onion, msg.failure_code)));
2219                                                                                 update_fail_malformed_htlcs.push(msg)
2220                                                                         },
2221                                                                 }
2222                                                         },
2223                                                         PendingHTLCStatus::Forward(forward_info) => {
2224                                                                 to_forward_infos.push((forward_info, htlc.htlc_id));
2225                                                                 htlc.state = InboundHTLCState::Committed;
2226                                                         }
2227                                                 }
2228                                         }
2229                                 }
2230                         }
2231                         for htlc in pending_outbound_htlcs.iter_mut() {
2232                                 if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
2233                                         log_trace!(logger, " ...promoting outbound LocalAnnounced {} to Committed", log_bytes!(htlc.payment_hash.0));
2234                                         htlc.state = OutboundHTLCState::Committed;
2235                                 }
2236                                 if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
2237                                         Some(fail_reason.take())
2238                                 } else { None } {
2239                                         log_trace!(logger, " ...promoting outbound AwaitingRemoteRevokeToRemove {} to AwaitingRemovedRemoteRevoke", log_bytes!(htlc.payment_hash.0));
2240                                         htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
2241                                         require_commitment = true;
2242                                 }
2243                         }
2244                 }
2245                 self.value_to_self_msat = (self.value_to_self_msat as i64 + value_to_self_msat_diff) as u64;
2246
2247                 if self.channel_outbound {
2248                         if let Some(feerate) = self.pending_update_fee.take() {
2249                                 self.feerate_per_kw = feerate;
2250                         }
2251                 } else {
2252                         if let Some(feerate) = self.pending_update_fee {
2253                                 // Because a node cannot send two commitment_signeds in a row without getting a
2254                                 // revoke_and_ack from us (as it would otherwise not know the per_commitment_point
2255                                 // it should use to create keys with) and because a node can't send a
2256                                 // commitment_signed without changes, checking if the feerate is equal to the
2257                                 // pending feerate update is sufficient to detect require_commitment.
2258                                 if feerate == self.feerate_per_kw {
2259                                         require_commitment = true;
2260                                         self.pending_update_fee = None;
2261                                 }
2262                         }
2263                 }
2264
2265                 if (self.channel_state & ChannelState::MonitorUpdateFailed as u32) == ChannelState::MonitorUpdateFailed as u32 {
2266                         // We can't actually generate a new commitment transaction (incl by freeing holding
2267                         // cells) while we can't update the monitor, so we just return what we have.
2268                         if require_commitment {
2269                                 self.monitor_pending_commitment_signed = true;
2270                                 // When the monitor updating is restored we'll call get_last_commitment_update(),
2271                                 // which does not update state, but we're definitely now awaiting a remote revoke
2272                                 // before we can step forward any more, so set it here.
2273                                 let (_, mut additional_update) = self.send_commitment_no_status_check()?;
2274                                 // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2275                                 // strictly increasing by one, so decrement it here.
2276                                 self.latest_monitor_update_id = monitor_update.update_id;
2277                                 monitor_update.updates.append(&mut additional_update.updates);
2278                         }
2279                         self.monitor_pending_forwards.append(&mut to_forward_infos);
2280                         self.monitor_pending_failures.append(&mut revoked_htlcs);
2281                         return Ok((None, Vec::new(), Vec::new(), None, monitor_update))
2282                 }
2283
2284                 match self.free_holding_cell_htlcs()? {
2285                         Some((mut commitment_update, mut additional_update)) => {
2286                                 commitment_update.update_fail_htlcs.reserve(update_fail_htlcs.len());
2287                                 for fail_msg in update_fail_htlcs.drain(..) {
2288                                         commitment_update.update_fail_htlcs.push(fail_msg);
2289                                 }
2290                                 commitment_update.update_fail_malformed_htlcs.reserve(update_fail_malformed_htlcs.len());
2291                                 for fail_msg in update_fail_malformed_htlcs.drain(..) {
2292                                         commitment_update.update_fail_malformed_htlcs.push(fail_msg);
2293                                 }
2294
2295                                 // free_holding_cell_htlcs may bump latest_monitor_id multiple times but we want them to be
2296                                 // strictly increasing by one, so decrement it here.
2297                                 self.latest_monitor_update_id = monitor_update.update_id;
2298                                 monitor_update.updates.append(&mut additional_update.updates);
2299
2300                                 Ok((Some(commitment_update), to_forward_infos, revoked_htlcs, None, monitor_update))
2301                         },
2302                         None => {
2303                                 if require_commitment {
2304                                         let (commitment_signed, mut additional_update) = self.send_commitment_no_status_check()?;
2305
2306                                         // send_commitment_no_status_check may bump latest_monitor_id but we want them to be
2307                                         // strictly increasing by one, so decrement it here.
2308                                         self.latest_monitor_update_id = monitor_update.update_id;
2309                                         monitor_update.updates.append(&mut additional_update.updates);
2310
2311                                         Ok((Some(msgs::CommitmentUpdate {
2312                                                 update_add_htlcs: Vec::new(),
2313                                                 update_fulfill_htlcs: Vec::new(),
2314                                                 update_fail_htlcs,
2315                                                 update_fail_malformed_htlcs,
2316                                                 update_fee: None,
2317                                                 commitment_signed
2318                                         }), to_forward_infos, revoked_htlcs, None, monitor_update))
2319                                 } else {
2320                                         Ok((None, to_forward_infos, revoked_htlcs, self.maybe_propose_first_closing_signed(fee_estimator), monitor_update))
2321                                 }
2322                         }
2323                 }
2324
2325         }
2326
2327         /// Adds a pending update to this channel. See the doc for send_htlc for
2328         /// further details on the optionness of the return value.
2329         /// You MUST call send_commitment prior to any other calls on this Channel
2330         fn send_update_fee(&mut self, feerate_per_kw: u64) -> Option<msgs::UpdateFee> {
2331                 if !self.channel_outbound {
2332                         panic!("Cannot send fee from inbound channel");
2333                 }
2334                 if !self.is_usable() {
2335                         panic!("Cannot update fee until channel is fully established and we haven't started shutting down");
2336                 }
2337                 if !self.is_live() {
2338                         panic!("Cannot update fee while peer is disconnected/we're awaiting a monitor update (ChannelManager should have caught this)");
2339                 }
2340
2341                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
2342                         self.holding_cell_update_fee = Some(feerate_per_kw);
2343                         return None;
2344                 }
2345
2346                 debug_assert!(self.pending_update_fee.is_none());
2347                 self.pending_update_fee = Some(feerate_per_kw);
2348
2349                 Some(msgs::UpdateFee {
2350                         channel_id: self.channel_id,
2351                         feerate_per_kw: feerate_per_kw as u32,
2352                 })
2353         }
2354
2355         pub fn send_update_fee_and_commit(&mut self, feerate_per_kw: u64) -> Result<Option<(msgs::UpdateFee, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> {
2356                 match self.send_update_fee(feerate_per_kw) {
2357                         Some(update_fee) => {
2358                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
2359                                 Ok(Some((update_fee, commitment_signed, monitor_update)))
2360                         },
2361                         None => Ok(None)
2362                 }
2363         }
2364
2365         /// Removes any uncommitted HTLCs, to be used on peer disconnection, including any pending
2366         /// HTLCs that we intended to add but haven't as we were waiting on a remote revoke.
2367         /// Returns the set of PendingHTLCStatuses from remote uncommitted HTLCs (which we're
2368         /// implicitly dropping) and the payment_hashes of HTLCs we tried to add but are dropping.
2369         /// No further message handling calls may be made until a channel_reestablish dance has
2370         /// completed.
2371         pub fn remove_uncommitted_htlcs_and_mark_paused(&mut self) -> Vec<(HTLCSource, PaymentHash)> {
2372                 let mut outbound_drops = Vec::new();
2373
2374                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2375                 if self.channel_state < ChannelState::FundingSent as u32 {
2376                         self.channel_state = ChannelState::ShutdownComplete as u32;
2377                         return outbound_drops;
2378                 }
2379                 // Upon reconnect we have to start the closing_signed dance over, but shutdown messages
2380                 // will be retransmitted.
2381                 self.last_sent_closing_fee = None;
2382
2383                 let mut inbound_drop_count = 0;
2384                 self.pending_inbound_htlcs.retain(|htlc| {
2385                         match htlc.state {
2386                                 InboundHTLCState::RemoteAnnounced(_) => {
2387                                         // They sent us an update_add_htlc but we never got the commitment_signed.
2388                                         // We'll tell them what commitment_signed we're expecting next and they'll drop
2389                                         // this HTLC accordingly
2390                                         inbound_drop_count += 1;
2391                                         false
2392                                 },
2393                                 InboundHTLCState::AwaitingRemoteRevokeToAnnounce(_)|InboundHTLCState::AwaitingAnnouncedRemoteRevoke(_) => {
2394                                         // We received a commitment_signed updating this HTLC and (at least hopefully)
2395                                         // sent a revoke_and_ack (which we can re-transmit) and have heard nothing
2396                                         // in response to it yet, so don't touch it.
2397                                         true
2398                                 },
2399                                 InboundHTLCState::Committed => true,
2400                                 InboundHTLCState::LocalRemoved(_) => {
2401                                         // We (hopefully) sent a commitment_signed updating this HTLC (which we can
2402                                         // re-transmit if needed) and they may have even sent a revoke_and_ack back
2403                                         // (that we missed). Keep this around for now and if they tell us they missed
2404                                         // the commitment_signed we can re-transmit the update then.
2405                                         true
2406                                 },
2407                         }
2408                 });
2409                 self.next_remote_htlc_id -= inbound_drop_count;
2410
2411                 for htlc in self.pending_outbound_htlcs.iter_mut() {
2412                         if let OutboundHTLCState::RemoteRemoved(_) = htlc.state {
2413                                 // They sent us an update to remove this but haven't yet sent the corresponding
2414                                 // commitment_signed, we need to move it back to Committed and they can re-send
2415                                 // the update upon reconnection.
2416                                 htlc.state = OutboundHTLCState::Committed;
2417                         }
2418                 }
2419
2420                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2421                         match htlc_update {
2422                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2423                                         outbound_drops.push((source.clone(), payment_hash.clone()));
2424                                         false
2425                                 },
2426                                 &HTLCUpdateAwaitingACK::ClaimHTLC {..} | &HTLCUpdateAwaitingACK::FailHTLC {..} => true,
2427                         }
2428                 });
2429                 self.channel_state |= ChannelState::PeerDisconnected as u32;
2430                 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()));
2431                 outbound_drops
2432         }
2433
2434         /// Indicates that a ChannelMonitor update failed to be stored by the client and further
2435         /// updates are partially paused.
2436         /// This must be called immediately after the call which generated the ChannelMonitor update
2437         /// which failed. The messages which were generated from that call which generated the
2438         /// monitor update failure must *not* have been sent to the remote end, and must instead
2439         /// have been dropped. They will be regenerated when monitor_updating_restored is called.
2440         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)>) {
2441                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, 0);
2442                 self.monitor_pending_revoke_and_ack = resend_raa;
2443                 self.monitor_pending_commitment_signed = resend_commitment;
2444                 assert!(self.monitor_pending_forwards.is_empty());
2445                 mem::swap(&mut pending_forwards, &mut self.monitor_pending_forwards);
2446                 assert!(self.monitor_pending_failures.is_empty());
2447                 mem::swap(&mut pending_fails, &mut self.monitor_pending_failures);
2448                 self.channel_state |= ChannelState::MonitorUpdateFailed as u32;
2449         }
2450
2451         /// Indicates that the latest ChannelMonitor update has been committed by the client
2452         /// successfully and we should restore normal operation. Returns messages which should be sent
2453         /// to the remote side.
2454         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>) {
2455                 assert_eq!(self.channel_state & ChannelState::MonitorUpdateFailed as u32, ChannelState::MonitorUpdateFailed as u32);
2456                 self.channel_state &= !(ChannelState::MonitorUpdateFailed as u32);
2457
2458                 let needs_broadcast_safe = self.channel_state & (ChannelState::FundingSent as u32) != 0 && self.channel_outbound;
2459
2460                 // Because we will never generate a FundingBroadcastSafe event when we're in
2461                 // MonitorUpdateFailed, if we assume the user only broadcast the funding transaction when
2462                 // they received the FundingBroadcastSafe event, we can only ever hit
2463                 // monitor_pending_funding_locked when we're an inbound channel which failed to persist the
2464                 // monitor on funding_created, and we even got the funding transaction confirmed before the
2465                 // monitor was persisted.
2466                 let funding_locked = if self.monitor_pending_funding_locked {
2467                         assert!(!self.channel_outbound, "Funding transaction broadcast without FundingBroadcastSafe!");
2468                         self.monitor_pending_funding_locked = false;
2469                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2470                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2471                         Some(msgs::FundingLocked {
2472                                 channel_id: self.channel_id(),
2473                                 next_per_commitment_point: next_per_commitment_point,
2474                         })
2475                 } else { None };
2476
2477                 let mut forwards = Vec::new();
2478                 mem::swap(&mut forwards, &mut self.monitor_pending_forwards);
2479                 let mut failures = Vec::new();
2480                 mem::swap(&mut failures, &mut self.monitor_pending_failures);
2481
2482                 if self.channel_state & (ChannelState::PeerDisconnected as u32) != 0 {
2483                         self.monitor_pending_revoke_and_ack = false;
2484                         self.monitor_pending_commitment_signed = false;
2485                         return (None, None, RAACommitmentOrder::RevokeAndACKFirst, forwards, failures, needs_broadcast_safe, funding_locked);
2486                 }
2487
2488                 let raa = if self.monitor_pending_revoke_and_ack {
2489                         Some(self.get_last_revoke_and_ack())
2490                 } else { None };
2491                 let commitment_update = if self.monitor_pending_commitment_signed {
2492                         Some(self.get_last_commitment_update())
2493                 } else { None };
2494
2495                 self.monitor_pending_revoke_and_ack = false;
2496                 self.monitor_pending_commitment_signed = false;
2497                 let order = self.resend_order.clone();
2498                 log_trace!(self, "Restored monitor updating resulting in {}{} commitment update and {} RAA, with {} first",
2499                         if needs_broadcast_safe { "a funding broadcast safe, " } else { "" },
2500                         if commitment_update.is_some() { "a" } else { "no" },
2501                         if raa.is_some() { "an" } else { "no" },
2502                         match order { RAACommitmentOrder::CommitmentFirst => "commitment", RAACommitmentOrder::RevokeAndACKFirst => "RAA"});
2503                 (raa, commitment_update, order, forwards, failures, needs_broadcast_safe, funding_locked)
2504         }
2505
2506         pub fn update_fee<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::UpdateFee) -> Result<(), ChannelError>
2507                 where F::Target: FeeEstimator
2508         {
2509                 if self.channel_outbound {
2510                         return Err(ChannelError::Close("Non-funding remote tried to update channel fee"));
2511                 }
2512                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2513                         return Err(ChannelError::Close("Peer sent update_fee when we needed a channel_reestablish"));
2514                 }
2515                 Channel::<ChanSigner>::check_remote_fee(fee_estimator, msg.feerate_per_kw)?;
2516                 self.pending_update_fee = Some(msg.feerate_per_kw as u64);
2517                 self.update_time_counter += 1;
2518                 Ok(())
2519         }
2520
2521         fn get_last_revoke_and_ack(&self) -> msgs::RevokeAndACK {
2522                 let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number));
2523                 let per_commitment_secret = chan_utils::build_commitment_secret(self.local_keys.commitment_seed(), self.cur_local_commitment_transaction_number + 2);
2524                 msgs::RevokeAndACK {
2525                         channel_id: self.channel_id,
2526                         per_commitment_secret,
2527                         next_per_commitment_point,
2528                 }
2529         }
2530
2531         fn get_last_commitment_update(&self) -> msgs::CommitmentUpdate {
2532                 let mut update_add_htlcs = Vec::new();
2533                 let mut update_fulfill_htlcs = Vec::new();
2534                 let mut update_fail_htlcs = Vec::new();
2535                 let mut update_fail_malformed_htlcs = Vec::new();
2536
2537                 for htlc in self.pending_outbound_htlcs.iter() {
2538                         if let &OutboundHTLCState::LocalAnnounced(ref onion_packet) = &htlc.state {
2539                                 update_add_htlcs.push(msgs::UpdateAddHTLC {
2540                                         channel_id: self.channel_id(),
2541                                         htlc_id: htlc.htlc_id,
2542                                         amount_msat: htlc.amount_msat,
2543                                         payment_hash: htlc.payment_hash,
2544                                         cltv_expiry: htlc.cltv_expiry,
2545                                         onion_routing_packet: (**onion_packet).clone(),
2546                                 });
2547                         }
2548                 }
2549
2550                 for htlc in self.pending_inbound_htlcs.iter() {
2551                         if let &InboundHTLCState::LocalRemoved(ref reason) = &htlc.state {
2552                                 match reason {
2553                                         &InboundHTLCRemovalReason::FailRelay(ref err_packet) => {
2554                                                 update_fail_htlcs.push(msgs::UpdateFailHTLC {
2555                                                         channel_id: self.channel_id(),
2556                                                         htlc_id: htlc.htlc_id,
2557                                                         reason: err_packet.clone()
2558                                                 });
2559                                         },
2560                                         &InboundHTLCRemovalReason::FailMalformed((ref sha256_of_onion, ref failure_code)) => {
2561                                                 update_fail_malformed_htlcs.push(msgs::UpdateFailMalformedHTLC {
2562                                                         channel_id: self.channel_id(),
2563                                                         htlc_id: htlc.htlc_id,
2564                                                         sha256_of_onion: sha256_of_onion.clone(),
2565                                                         failure_code: failure_code.clone(),
2566                                                 });
2567                                         },
2568                                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
2569                                                 update_fulfill_htlcs.push(msgs::UpdateFulfillHTLC {
2570                                                         channel_id: self.channel_id(),
2571                                                         htlc_id: htlc.htlc_id,
2572                                                         payment_preimage: payment_preimage.clone(),
2573                                                 });
2574                                         },
2575                                 }
2576                         }
2577                 }
2578
2579                 log_trace!(self, "Regenerated latest commitment update with {} update_adds, {} update_fulfills, {} update_fails, and {} update_fail_malformeds",
2580                                 update_add_htlcs.len(), update_fulfill_htlcs.len(), update_fail_htlcs.len(), update_fail_malformed_htlcs.len());
2581                 msgs::CommitmentUpdate {
2582                         update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs,
2583                         update_fee: None,
2584                         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,
2585                 }
2586         }
2587
2588         /// May panic if some calls other than message-handling calls (which will all Err immediately)
2589         /// have been called between remove_uncommitted_htlcs_and_mark_paused and this call.
2590         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> {
2591                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == 0 {
2592                         // While BOLT 2 doesn't indicate explicitly we should error this channel here, it
2593                         // almost certainly indicates we are going to end up out-of-sync in some way, so we
2594                         // just close here instead of trying to recover.
2595                         return Err(ChannelError::Close("Peer sent a loose channel_reestablish not after reconnect"));
2596                 }
2597
2598                 if msg.next_local_commitment_number >= INITIAL_COMMITMENT_NUMBER || msg.next_remote_commitment_number >= INITIAL_COMMITMENT_NUMBER ||
2599                         msg.next_local_commitment_number == 0 {
2600                         return Err(ChannelError::Close("Peer sent a garbage channel_reestablish"));
2601                 }
2602
2603                 if msg.next_remote_commitment_number > 0 {
2604                         match msg.data_loss_protect {
2605                                 OptionalField::Present(ref data_loss) => {
2606                                         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 {
2607                                                 return Err(ChannelError::Close("Peer sent a garbage channel_reestablish with secret key not matching the commitment height provided"));
2608                                         }
2609                                         if msg.next_remote_commitment_number > INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2610                                                 self.latest_monitor_update_id += 1;
2611                                                 let monitor_update = ChannelMonitorUpdate {
2612                                                         update_id: self.latest_monitor_update_id,
2613                                                         updates: vec![ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo {
2614                                                                 their_current_per_commitment_point: data_loss.my_current_per_commitment_point
2615                                                         }]
2616                                                 };
2617                                                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
2618                                                 return Err(ChannelError::CloseDelayBroadcast {
2619                                                         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",
2620                                                         update: monitor_update
2621                                                 });
2622                                         }
2623                                 },
2624                                 OptionalField::Absent => {}
2625                         }
2626                 }
2627
2628                 // Go ahead and unmark PeerDisconnected as various calls we may make check for it (and all
2629                 // remaining cases either succeed or ErrorMessage-fail).
2630                 self.channel_state &= !(ChannelState::PeerDisconnected as u32);
2631
2632                 let shutdown_msg = if self.channel_state & (ChannelState::LocalShutdownSent as u32) != 0 {
2633                         Some(msgs::Shutdown {
2634                                 channel_id: self.channel_id,
2635                                 scriptpubkey: self.get_closing_scriptpubkey(),
2636                         })
2637                 } else { None };
2638
2639                 if self.channel_state & (ChannelState::FundingSent as u32) == ChannelState::FundingSent as u32 {
2640                         // If we're waiting on a monitor update, we shouldn't re-send any funding_locked's.
2641                         if self.channel_state & (ChannelState::OurFundingLocked as u32) == 0 ||
2642                                         self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2643                                 if msg.next_remote_commitment_number != 0 {
2644                                         return Err(ChannelError::Close("Peer claimed they saw a revoke_and_ack but we haven't sent funding_locked yet"));
2645                                 }
2646                                 // Short circuit the whole handler as there is nothing we can resend them
2647                                 return Ok((None, None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2648                         }
2649
2650                         // We have OurFundingLocked set!
2651                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2652                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2653                         return Ok((Some(msgs::FundingLocked {
2654                                 channel_id: self.channel_id(),
2655                                 next_per_commitment_point: next_per_commitment_point,
2656                         }), None, None, None, RAACommitmentOrder::CommitmentFirst, shutdown_msg));
2657                 }
2658
2659                 let required_revoke = if msg.next_remote_commitment_number + 1 == INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number {
2660                         // Remote isn't waiting on any RevokeAndACK from us!
2661                         // Note that if we need to repeat our FundingLocked we'll do that in the next if block.
2662                         None
2663                 } else if msg.next_remote_commitment_number + 1 == (INITIAL_COMMITMENT_NUMBER - 1) - self.cur_local_commitment_transaction_number {
2664                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2665                                 self.monitor_pending_revoke_and_ack = true;
2666                                 None
2667                         } else {
2668                                 Some(self.get_last_revoke_and_ack())
2669                         }
2670                 } else {
2671                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old local commitment transaction"));
2672                 };
2673
2674                 // We increment cur_remote_commitment_transaction_number only upon receipt of
2675                 // revoke_and_ack, not on sending commitment_signed, so we add one if have
2676                 // AwaitingRemoteRevoke set, which indicates we sent a commitment_signed but haven't gotten
2677                 // the corresponding revoke_and_ack back yet.
2678                 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 };
2679
2680                 let resend_funding_locked = if msg.next_local_commitment_number == 1 && INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number == 1 {
2681                         // We should never have to worry about MonitorUpdateFailed resending FundingLocked
2682                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
2683                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
2684                         Some(msgs::FundingLocked {
2685                                 channel_id: self.channel_id(),
2686                                 next_per_commitment_point: next_per_commitment_point,
2687                         })
2688                 } else { None };
2689
2690                 if msg.next_local_commitment_number == our_next_remote_commitment_number {
2691                         if required_revoke.is_some() {
2692                                 log_debug!(self, "Reconnected channel {} with only lost outbound RAA", log_bytes!(self.channel_id()));
2693                         } else {
2694                                 log_debug!(self, "Reconnected channel {} with no loss", log_bytes!(self.channel_id()));
2695                         }
2696
2697                         if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32 | ChannelState::MonitorUpdateFailed as u32)) == 0 {
2698                                 // We're up-to-date and not waiting on a remote revoke (if we are our
2699                                 // channel_reestablish should result in them sending a revoke_and_ack), but we may
2700                                 // have received some updates while we were disconnected. Free the holding cell
2701                                 // now!
2702                                 match self.free_holding_cell_htlcs() {
2703                                         Err(ChannelError::Close(msg)) => return Err(ChannelError::Close(msg)),
2704                                         Err(ChannelError::Ignore(_)) | Err(ChannelError::CloseDelayBroadcast { .. }) => panic!("Got non-channel-failing result from free_holding_cell_htlcs"),
2705                                         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)),
2706                                         Ok(None) => return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg)),
2707                                 }
2708                         } else {
2709                                 return Ok((resend_funding_locked, required_revoke, None, None, self.resend_order.clone(), shutdown_msg));
2710                         }
2711                 } else if msg.next_local_commitment_number == our_next_remote_commitment_number - 1 {
2712                         if required_revoke.is_some() {
2713                                 log_debug!(self, "Reconnected channel {} with lost outbound RAA and lost remote commitment tx", log_bytes!(self.channel_id()));
2714                         } else {
2715                                 log_debug!(self, "Reconnected channel {} with only lost remote commitment tx", log_bytes!(self.channel_id()));
2716                         }
2717
2718                         if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) != 0 {
2719                                 self.monitor_pending_commitment_signed = true;
2720                                 return Ok((resend_funding_locked, None, None, None, self.resend_order.clone(), shutdown_msg));
2721                         }
2722
2723                         return Ok((resend_funding_locked, required_revoke, Some(self.get_last_commitment_update()), None, self.resend_order.clone(), shutdown_msg));
2724                 } else {
2725                         return Err(ChannelError::Close("Peer attempted to reestablish channel with a very old remote commitment transaction"));
2726                 }
2727         }
2728
2729         fn maybe_propose_first_closing_signed<F: Deref>(&mut self, fee_estimator: &F) -> Option<msgs::ClosingSigned>
2730                 where F::Target: FeeEstimator
2731         {
2732                 if !self.channel_outbound || !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() ||
2733                                 self.channel_state & (BOTH_SIDES_SHUTDOWN_MASK | ChannelState::AwaitingRemoteRevoke as u32) != BOTH_SIDES_SHUTDOWN_MASK ||
2734                                 self.last_sent_closing_fee.is_some() || self.pending_update_fee.is_some() {
2735                         return None;
2736                 }
2737
2738                 let mut proposed_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2739                 if self.feerate_per_kw > proposed_feerate {
2740                         proposed_feerate = self.feerate_per_kw;
2741                 }
2742                 let tx_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2743                 let proposed_total_fee_satoshis = proposed_feerate * tx_weight / 1000;
2744
2745                 let (closing_tx, total_fee_satoshis) = self.build_closing_transaction(proposed_total_fee_satoshis, false);
2746                 let our_sig = self.local_keys
2747                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2748                         .ok();
2749                 if our_sig.is_none() { return None; }
2750
2751                 self.last_sent_closing_fee = Some((proposed_feerate, total_fee_satoshis, our_sig.clone().unwrap()));
2752                 Some(msgs::ClosingSigned {
2753                         channel_id: self.channel_id,
2754                         fee_satoshis: total_fee_satoshis,
2755                         signature: our_sig.unwrap(),
2756                 })
2757         }
2758
2759         pub fn shutdown<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>, Vec<(HTLCSource, PaymentHash)>), ChannelError>
2760                 where F::Target: FeeEstimator
2761         {
2762                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2763                         return Err(ChannelError::Close("Peer sent shutdown when we needed a channel_reestablish"));
2764                 }
2765                 if self.channel_state < ChannelState::FundingSent as u32 {
2766                         // Spec says we should fail the connection, not the channel, but that's nonsense, there
2767                         // are plenty of reasons you may want to fail a channel pre-funding, and spec says you
2768                         // can do that via error message without getting a connection fail anyway...
2769                         return Err(ChannelError::Close("Peer sent shutdown pre-funding generation"));
2770                 }
2771                 for htlc in self.pending_inbound_htlcs.iter() {
2772                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
2773                                 return Err(ChannelError::Close("Got shutdown with remote pending HTLCs"));
2774                         }
2775                 }
2776                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
2777
2778                 // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to
2779                 // 34 bytes in length, so don't let the remote peer feed us some super fee-heavy script.
2780                 if self.channel_outbound && msg.scriptpubkey.len() > 34 {
2781                         return Err(ChannelError::Close("Got shutdown_scriptpubkey of absurd length from remote peer"));
2782                 }
2783
2784                 //Check shutdown_scriptpubkey form as BOLT says we must
2785                 if !msg.scriptpubkey.is_p2pkh() && !msg.scriptpubkey.is_p2sh() && !msg.scriptpubkey.is_v0_p2wpkh() && !msg.scriptpubkey.is_v0_p2wsh() {
2786                         return Err(ChannelError::Close("Got a nonstandard scriptpubkey from remote peer"));
2787                 }
2788
2789                 if self.their_shutdown_scriptpubkey.is_some() {
2790                         if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() {
2791                                 return Err(ChannelError::Close("Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey"));
2792                         }
2793                 } else {
2794                         self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone());
2795                 }
2796
2797                 // From here on out, we may not fail!
2798
2799                 self.channel_state |= ChannelState::RemoteShutdownSent as u32;
2800                 self.update_time_counter += 1;
2801
2802                 // We can't send our shutdown until we've committed all of our pending HTLCs, but the
2803                 // remote side is unlikely to accept any new HTLCs, so we go ahead and "free" any holding
2804                 // cell HTLCs and return them to fail the payment.
2805                 self.holding_cell_update_fee = None;
2806                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
2807                 self.holding_cell_htlc_updates.retain(|htlc_update| {
2808                         match htlc_update {
2809                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
2810                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
2811                                         false
2812                                 },
2813                                 _ => true
2814                         }
2815                 });
2816                 // If we have any LocalAnnounced updates we'll probably just get back a update_fail_htlc
2817                 // immediately after the commitment dance, but we can send a Shutdown cause we won't send
2818                 // any further commitment updates after we set LocalShutdownSent.
2819
2820                 let our_shutdown = if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
2821                         None
2822                 } else {
2823                         Some(msgs::Shutdown {
2824                                 channel_id: self.channel_id,
2825                                 scriptpubkey: self.get_closing_scriptpubkey(),
2826                         })
2827                 };
2828
2829                 self.channel_state |= ChannelState::LocalShutdownSent as u32;
2830                 self.update_time_counter += 1;
2831
2832                 Ok((our_shutdown, self.maybe_propose_first_closing_signed(fee_estimator), dropped_outbound_htlcs))
2833         }
2834
2835         fn build_signed_closing_transaction(&self, tx: &mut Transaction, their_sig: &Signature, our_sig: &Signature) {
2836                 if tx.input.len() != 1 { panic!("Tried to sign closing transaction that had input count != 1!"); }
2837                 if tx.input[0].witness.len() != 0 { panic!("Tried to re-sign closing transaction"); }
2838                 if tx.output.len() > 2 { panic!("Tried to sign bogus closing transaction"); }
2839
2840                 tx.input[0].witness.push(Vec::new()); // First is the multisig dummy
2841
2842                 let our_funding_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()).serialize();
2843                 let their_funding_key = self.their_funding_pubkey().serialize();
2844                 if our_funding_key[..] < their_funding_key[..] {
2845                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2846                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2847                 } else {
2848                         tx.input[0].witness.push(their_sig.serialize_der().to_vec());
2849                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
2850                 }
2851                 tx.input[0].witness[1].push(SigHashType::All as u8);
2852                 tx.input[0].witness[2].push(SigHashType::All as u8);
2853
2854                 tx.input[0].witness.push(self.get_funding_redeemscript().into_bytes());
2855         }
2856
2857         pub fn closing_signed<F: Deref>(&mut self, fee_estimator: &F, msg: &msgs::ClosingSigned) -> Result<(Option<msgs::ClosingSigned>, Option<Transaction>), ChannelError>
2858                 where F::Target: FeeEstimator
2859         {
2860                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK {
2861                         return Err(ChannelError::Close("Remote end sent us a closing_signed before both sides provided a shutdown"));
2862                 }
2863                 if self.channel_state & (ChannelState::PeerDisconnected as u32) == ChannelState::PeerDisconnected as u32 {
2864                         return Err(ChannelError::Close("Peer sent closing_signed when we needed a channel_reestablish"));
2865                 }
2866                 if !self.pending_inbound_htlcs.is_empty() || !self.pending_outbound_htlcs.is_empty() {
2867                         return Err(ChannelError::Close("Remote end sent us a closing_signed while there were still pending HTLCs"));
2868                 }
2869                 if msg.fee_satoshis > 21000000 * 10000000 { //this is required to stop potential overflow in build_closing_transaction
2870                         return Err(ChannelError::Close("Remote tried to send us a closing tx with > 21 million BTC fee"));
2871                 }
2872
2873                 let funding_redeemscript = self.get_funding_redeemscript();
2874                 let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false);
2875                 if used_total_fee != msg.fee_satoshis {
2876                         return Err(ChannelError::Close("Remote sent us a closing_signed with a fee greater than the value they can claim"));
2877                 }
2878                 let mut sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2879
2880                 let their_funding_pubkey = &self.their_pubkeys.as_ref().unwrap().funding_pubkey;
2881
2882                 match self.secp_ctx.verify(&sighash, &msg.signature, their_funding_pubkey) {
2883                         Ok(_) => {},
2884                         Err(_e) => {
2885                                 // The remote end may have decided to revoke their output due to inconsistent dust
2886                                 // limits, so check for that case by re-checking the signature here.
2887                                 closing_tx = self.build_closing_transaction(msg.fee_satoshis, true).0;
2888                                 sighash = hash_to_message!(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]);
2889                                 secp_check!(self.secp_ctx.verify(&sighash, &msg.signature, self.their_funding_pubkey()), "Invalid closing tx signature from peer");
2890                         },
2891                 };
2892
2893                 if let Some((_, last_fee, our_sig)) = self.last_sent_closing_fee {
2894                         if last_fee == msg.fee_satoshis {
2895                                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2896                                 self.channel_state = ChannelState::ShutdownComplete as u32;
2897                                 self.update_time_counter += 1;
2898                                 return Ok((None, Some(closing_tx)));
2899                         }
2900                 }
2901
2902                 macro_rules! propose_new_feerate {
2903                         ($new_feerate: expr) => {
2904                                 let closing_tx_max_weight = Self::get_closing_transaction_weight(&self.get_closing_scriptpubkey(), self.their_shutdown_scriptpubkey.as_ref().unwrap());
2905                                 let (closing_tx, used_total_fee) = self.build_closing_transaction($new_feerate * closing_tx_max_weight / 1000, false);
2906                                 let our_sig = self.local_keys
2907                                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2908                                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2909                                 self.last_sent_closing_fee = Some(($new_feerate, used_total_fee, our_sig.clone()));
2910                                 return Ok((Some(msgs::ClosingSigned {
2911                                         channel_id: self.channel_id,
2912                                         fee_satoshis: used_total_fee,
2913                                         signature: our_sig,
2914                                 }), None))
2915                         }
2916                 }
2917
2918                 let proposed_sat_per_kw = msg.fee_satoshis * 1000 / closing_tx.get_weight() as u64;
2919                 if self.channel_outbound {
2920                         let our_max_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2921                         if proposed_sat_per_kw > our_max_feerate {
2922                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2923                                         if our_max_feerate <= last_feerate {
2924                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate"));
2925                                         }
2926                                 }
2927                                 propose_new_feerate!(our_max_feerate);
2928                         }
2929                 } else {
2930                         let our_min_feerate = fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
2931                         if proposed_sat_per_kw < our_min_feerate {
2932                                 if let Some((last_feerate, _, _)) = self.last_sent_closing_fee {
2933                                         if our_min_feerate >= last_feerate {
2934                                                 return Err(ChannelError::Close("Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate"));
2935                                         }
2936                                 }
2937                                 propose_new_feerate!(our_min_feerate);
2938                         }
2939                 }
2940
2941                 let our_sig = self.local_keys
2942                         .sign_closing_transaction(&closing_tx, &self.secp_ctx)
2943                         .map_err(|_| ChannelError::Close("External signer refused to sign closing transaction"))?;
2944                 self.build_signed_closing_transaction(&mut closing_tx, &msg.signature, &our_sig);
2945
2946                 self.channel_state = ChannelState::ShutdownComplete as u32;
2947                 self.update_time_counter += 1;
2948
2949                 Ok((Some(msgs::ClosingSigned {
2950                         channel_id: self.channel_id,
2951                         fee_satoshis: msg.fee_satoshis,
2952                         signature: our_sig,
2953                 }), Some(closing_tx)))
2954         }
2955
2956         // Public utilities:
2957
2958         pub fn channel_id(&self) -> [u8; 32] {
2959                 self.channel_id
2960         }
2961
2962         /// Gets the "user_id" value passed into the construction of this channel. It has no special
2963         /// meaning and exists only to allow users to have a persistent identifier of a channel.
2964         pub fn get_user_id(&self) -> u64 {
2965                 self.user_id
2966         }
2967
2968         /// May only be called after funding has been initiated (ie is_funding_initiated() is true)
2969         pub fn channel_monitor(&mut self) -> &mut ChannelMonitor<ChanSigner> {
2970                 if self.channel_state < ChannelState::FundingSent as u32 {
2971                         panic!("Can't get a channel monitor until funding has been created");
2972                 }
2973                 self.channel_monitor.as_mut().unwrap()
2974         }
2975
2976         /// Guaranteed to be Some after both FundingLocked messages have been exchanged (and, thus,
2977         /// is_usable() returns true).
2978         /// Allowed in any state (including after shutdown)
2979         pub fn get_short_channel_id(&self) -> Option<u64> {
2980                 self.short_channel_id
2981         }
2982
2983         /// Returns the funding_txo we either got from our peer, or were given by
2984         /// get_outbound_funding_created.
2985         pub fn get_funding_txo(&self) -> Option<OutPoint> {
2986                 self.funding_txo
2987         }
2988
2989         /// Allowed in any state (including after shutdown)
2990         pub fn get_their_node_id(&self) -> PublicKey {
2991                 self.their_node_id
2992         }
2993
2994         /// Allowed in any state (including after shutdown)
2995         pub fn get_our_htlc_minimum_msat(&self) -> u64 {
2996                 self.our_htlc_minimum_msat
2997         }
2998
2999         /// Allowed in any state (including after shutdown)
3000         pub fn get_their_htlc_minimum_msat(&self) -> u64 {
3001                 self.our_htlc_minimum_msat
3002         }
3003
3004         pub fn get_value_satoshis(&self) -> u64 {
3005                 self.channel_value_satoshis
3006         }
3007
3008         pub fn get_fee_proportional_millionths(&self) -> u32 {
3009                 self.config.fee_proportional_millionths
3010         }
3011
3012         #[cfg(test)]
3013         pub fn get_feerate(&self) -> u64 {
3014                 self.feerate_per_kw
3015         }
3016
3017         pub fn get_cur_local_commitment_transaction_number(&self) -> u64 {
3018                 self.cur_local_commitment_transaction_number + 1
3019         }
3020
3021         pub fn get_cur_remote_commitment_transaction_number(&self) -> u64 {
3022                 self.cur_remote_commitment_transaction_number + 1 - if self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32) != 0 { 1 } else { 0 }
3023         }
3024
3025         pub fn get_revoked_remote_commitment_transaction_number(&self) -> u64 {
3026                 self.cur_remote_commitment_transaction_number + 2
3027         }
3028
3029         #[cfg(test)]
3030         pub fn get_local_keys(&self) -> &ChanSigner {
3031                 &self.local_keys
3032         }
3033
3034         #[cfg(test)]
3035         pub fn get_value_stat(&self) -> ChannelValueStat {
3036                 ChannelValueStat {
3037                         value_to_self_msat: self.value_to_self_msat,
3038                         channel_value_msat: self.channel_value_satoshis * 1000,
3039                         channel_reserve_msat: self.their_channel_reserve_satoshis * 1000,
3040                         pending_outbound_htlcs_amount_msat: self.pending_outbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3041                         pending_inbound_htlcs_amount_msat: self.pending_inbound_htlcs.iter().map(|ref h| h.amount_msat).sum::<u64>(),
3042                         holding_cell_outbound_amount_msat: {
3043                                 let mut res = 0;
3044                                 for h in self.holding_cell_htlc_updates.iter() {
3045                                         match h {
3046                                                 &HTLCUpdateAwaitingACK::AddHTLC{amount_msat, .. } => {
3047                                                         res += amount_msat;
3048                                                 }
3049                                                 _ => {}
3050                                         }
3051                                 }
3052                                 res
3053                         },
3054                         their_max_htlc_value_in_flight_msat: self.their_max_htlc_value_in_flight_msat,
3055                 }
3056         }
3057
3058         /// Allowed in any state (including after shutdown)
3059         pub fn get_update_time_counter(&self) -> u32 {
3060                 self.update_time_counter
3061         }
3062
3063         pub fn get_latest_monitor_update_id(&self) -> u64 {
3064                 self.latest_monitor_update_id
3065         }
3066
3067         pub fn should_announce(&self) -> bool {
3068                 self.config.announced_channel
3069         }
3070
3071         pub fn is_outbound(&self) -> bool {
3072                 self.channel_outbound
3073         }
3074
3075         /// Gets the fee we'd want to charge for adding an HTLC output to this Channel
3076         /// Allowed in any state (including after shutdown)
3077         pub fn get_our_fee_base_msat<F: Deref>(&self, fee_estimator: &F) -> u32
3078                 where F::Target: FeeEstimator
3079         {
3080                 // For lack of a better metric, we calculate what it would cost to consolidate the new HTLC
3081                 // output value back into a transaction with the regular channel output:
3082
3083                 // the fee cost of the HTLC-Success/HTLC-Timeout transaction:
3084                 let mut res = self.feerate_per_kw * cmp::max(HTLC_TIMEOUT_TX_WEIGHT, HTLC_SUCCESS_TX_WEIGHT) / 1000;
3085
3086                 if self.channel_outbound {
3087                         // + the marginal fee increase cost to us in the commitment transaction:
3088                         res += self.feerate_per_kw * COMMITMENT_TX_WEIGHT_PER_HTLC / 1000;
3089                 }
3090
3091                 // + the marginal cost of an input which spends the HTLC-Success/HTLC-Timeout output:
3092                 res += fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal) * SPENDING_INPUT_FOR_A_OUTPUT_WEIGHT / 1000;
3093
3094                 res as u32
3095         }
3096
3097         /// Returns true if we've ever received a message from the remote end for this Channel
3098         pub fn have_received_message(&self) -> bool {
3099                 self.channel_state > (ChannelState::OurInitSent as u32)
3100         }
3101
3102         /// Returns true if this channel is fully established and not known to be closing.
3103         /// Allowed in any state (including after shutdown)
3104         pub fn is_usable(&self) -> bool {
3105                 let mask = ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK;
3106                 (self.channel_state & mask) == (ChannelState::ChannelFunded as u32)
3107         }
3108
3109         /// Returns true if this channel is currently available for use. This is a superset of
3110         /// is_usable() and considers things like the channel being temporarily disabled.
3111         /// Allowed in any state (including after shutdown)
3112         pub fn is_live(&self) -> bool {
3113                 self.is_usable() && (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) == 0)
3114         }
3115
3116         /// Returns true if this channel has been marked as awaiting a monitor update to move forward.
3117         /// Allowed in any state (including after shutdown)
3118         pub fn is_awaiting_monitor_update(&self) -> bool {
3119                 (self.channel_state & ChannelState::MonitorUpdateFailed as u32) != 0
3120         }
3121
3122         /// Returns true if funding_created was sent/received.
3123         pub fn is_funding_initiated(&self) -> bool {
3124                 self.channel_state >= ChannelState::FundingSent as u32
3125         }
3126
3127         /// Returns true if this channel is fully shut down. True here implies that no further actions
3128         /// may/will be taken on this channel, and thus this object should be freed. Any future changes
3129         /// will be handled appropriately by the chain monitor.
3130         pub fn is_shutdown(&self) -> bool {
3131                 if (self.channel_state & ChannelState::ShutdownComplete as u32) == ChannelState::ShutdownComplete as u32  {
3132                         assert!(self.channel_state == ChannelState::ShutdownComplete as u32);
3133                         true
3134                 } else { false }
3135         }
3136
3137         pub fn to_disabled_staged(&mut self) {
3138                 self.network_sync = UpdateStatus::DisabledStaged;
3139         }
3140
3141         pub fn to_disabled_marked(&mut self) {
3142                 self.network_sync = UpdateStatus::DisabledMarked;
3143         }
3144
3145         pub fn to_fresh(&mut self) {
3146                 self.network_sync = UpdateStatus::Fresh;
3147         }
3148
3149         pub fn is_disabled_staged(&self) -> bool {
3150                 self.network_sync == UpdateStatus::DisabledStaged
3151         }
3152
3153         pub fn is_disabled_marked(&self) -> bool {
3154                 self.network_sync == UpdateStatus::DisabledMarked
3155         }
3156
3157         /// Called by channelmanager based on chain blocks being connected.
3158         /// Note that we only need to use this to detect funding_signed, anything else is handled by
3159         /// the channel_monitor.
3160         /// In case of Err, the channel may have been closed, at which point the standard requirements
3161         /// apply - no calls may be made except those explicitly stated to be allowed post-shutdown.
3162         /// Only returns an ErrorAction of DisconnectPeer, if Err.
3163         pub fn block_connected(&mut self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) -> Result<Option<msgs::FundingLocked>, msgs::ErrorMessage> {
3164                 let non_shutdown_state = self.channel_state & (!MULTI_STATE_FLAGS);
3165                 if header.bitcoin_hash() != self.last_block_connected {
3166                         if self.funding_tx_confirmations > 0 {
3167                                 self.funding_tx_confirmations += 1;
3168                         }
3169                 }
3170                 if non_shutdown_state & !(ChannelState::TheirFundingLocked as u32) == ChannelState::FundingSent as u32 {
3171                         for (ref tx, index_in_block) in txn_matched.iter().zip(indexes_of_txn_matched) {
3172                                 if tx.txid() == self.funding_txo.unwrap().txid {
3173                                         let txo_idx = self.funding_txo.unwrap().index as usize;
3174                                         if txo_idx >= tx.output.len() || tx.output[txo_idx].script_pubkey != self.get_funding_redeemscript().to_v0_p2wsh() ||
3175                                                         tx.output[txo_idx].value != self.channel_value_satoshis {
3176                                                 if self.channel_outbound {
3177                                                         // If we generated the funding transaction and it doesn't match what it
3178                                                         // should, the client is really broken and we should just panic and
3179                                                         // tell them off. That said, because hash collisions happen with high
3180                                                         // probability in fuzztarget mode, if we're fuzzing we just close the
3181                                                         // channel and move on.
3182                                                         #[cfg(not(feature = "fuzztarget"))]
3183                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3184                                                 }
3185                                                 self.channel_state = ChannelState::ShutdownComplete as u32;
3186                                                 self.update_time_counter += 1;
3187                                                 return Err(msgs::ErrorMessage {
3188                                                         channel_id: self.channel_id(),
3189                                                         data: "funding tx had wrong script/value".to_owned()
3190                                                 });
3191                                         } else {
3192                                                 if self.channel_outbound {
3193                                                         for input in tx.input.iter() {
3194                                                                 if input.witness.is_empty() {
3195                                                                         // We generated a malleable funding transaction, implying we've
3196                                                                         // just exposed ourselves to funds loss to our counterparty.
3197                                                                         #[cfg(not(feature = "fuzztarget"))]
3198                                                                         panic!("Client called ChannelManager::funding_transaction_generated with bogus transaction!");
3199                                                                 }
3200                                                         }
3201                                                 }
3202                                                 self.funding_tx_confirmations = 1;
3203                                                 self.short_channel_id = Some(((height as u64)          << (5*8)) |
3204                                                                              ((*index_in_block as u64) << (2*8)) |
3205                                                                              ((txo_idx as u64)         << (0*8)));
3206                                         }
3207                                 }
3208                         }
3209                 }
3210                 if header.bitcoin_hash() != self.last_block_connected {
3211                         self.last_block_connected = header.bitcoin_hash();
3212                         self.update_time_counter = cmp::max(self.update_time_counter, header.time);
3213                         if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3214                                 channel_monitor.last_block_hash = self.last_block_connected;
3215                         }
3216                         if self.funding_tx_confirmations > 0 {
3217                                 if self.funding_tx_confirmations == self.minimum_depth as u64 {
3218                                         let need_commitment_update = if non_shutdown_state == ChannelState::FundingSent as u32 {
3219                                                 self.channel_state |= ChannelState::OurFundingLocked as u32;
3220                                                 true
3221                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::TheirFundingLocked as u32) {
3222                                                 self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & MULTI_STATE_FLAGS);
3223                                                 self.update_time_counter += 1;
3224                                                 true
3225                                         } else if non_shutdown_state == (ChannelState::FundingSent as u32 | ChannelState::OurFundingLocked as u32) {
3226                                                 // We got a reorg but not enough to trigger a force close, just update
3227                                                 // funding_tx_confirmed_in and return.
3228                                                 false
3229                                         } else if self.channel_state < ChannelState::ChannelFunded as u32 {
3230                                                 panic!("Started confirming a channel in a state pre-FundingSent?: {}", self.channel_state);
3231                                         } else {
3232                                                 // We got a reorg but not enough to trigger a force close, just update
3233                                                 // funding_tx_confirmed_in and return.
3234                                                 false
3235                                         };
3236                                         self.funding_tx_confirmed_in = Some(header.bitcoin_hash());
3237
3238                                         //TODO: Note that this must be a duplicate of the previous commitment point they sent us,
3239                                         //as otherwise we will have a commitment transaction that they can't revoke (well, kinda,
3240                                         //they can by sending two revoke_and_acks back-to-back, but not really). This appears to be
3241                                         //a protocol oversight, but I assume I'm just missing something.
3242                                         if need_commitment_update {
3243                                                 if self.channel_state & (ChannelState::MonitorUpdateFailed as u32) == 0 {
3244                                                         let next_per_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3245                                                         let next_per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &next_per_commitment_secret);
3246                                                         return Ok(Some(msgs::FundingLocked {
3247                                                                 channel_id: self.channel_id,
3248                                                                 next_per_commitment_point: next_per_commitment_point,
3249                                                         }));
3250                                                 } else {
3251                                                         self.monitor_pending_funding_locked = true;
3252                                                         return Ok(None);
3253                                                 }
3254                                         }
3255                                 }
3256                         }
3257                 }
3258                 Ok(None)
3259         }
3260
3261         /// Called by channelmanager based on chain blocks being disconnected.
3262         /// Returns true if we need to close the channel now due to funding transaction
3263         /// unconfirmation/reorg.
3264         pub fn block_disconnected(&mut self, header: &BlockHeader) -> bool {
3265                 if self.funding_tx_confirmations > 0 {
3266                         self.funding_tx_confirmations -= 1;
3267                         if self.funding_tx_confirmations == UNCONF_THRESHOLD as u64 {
3268                                 return true;
3269                         }
3270                 }
3271                 if Some(header.bitcoin_hash()) == self.funding_tx_confirmed_in {
3272                         self.funding_tx_confirmations = self.minimum_depth as u64 - 1;
3273                 }
3274                 self.last_block_connected = header.bitcoin_hash();
3275                 if let Some(channel_monitor) = self.channel_monitor.as_mut() {
3276                         channel_monitor.last_block_hash = self.last_block_connected;
3277                 }
3278                 false
3279         }
3280
3281         // Methods to get unprompted messages to send to the remote end (or where we already returned
3282         // something in the handler for the message that prompted this message):
3283
3284         pub fn get_open_channel<F: Deref>(&self, chain_hash: Sha256dHash, fee_estimator: &F) -> msgs::OpenChannel
3285                 where F::Target: FeeEstimator
3286         {
3287                 if !self.channel_outbound {
3288                         panic!("Tried to open a channel for an inbound channel?");
3289                 }
3290                 if self.channel_state != ChannelState::OurInitSent as u32 {
3291                         panic!("Cannot generate an open_channel after we've moved forward");
3292                 }
3293
3294                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3295                         panic!("Tried to send an open_channel for a channel that has already advanced");
3296                 }
3297
3298                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3299
3300                 msgs::OpenChannel {
3301                         chain_hash: chain_hash,
3302                         temporary_channel_id: self.channel_id,
3303                         funding_satoshis: self.channel_value_satoshis,
3304                         push_msat: self.channel_value_satoshis * 1000 - self.value_to_self_msat,
3305                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3306                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3307                         channel_reserve_satoshis: Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3308                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3309                         feerate_per_kw: fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background) as u32,
3310                         to_self_delay: self.our_to_self_delay,
3311                         max_accepted_htlcs: OUR_MAX_HTLCS,
3312                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3313                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3314                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key()),
3315                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3316                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3317                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3318                         channel_flags: if self.config.announced_channel {1} else {0},
3319                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3320                 }
3321         }
3322
3323         pub fn get_accept_channel(&self) -> msgs::AcceptChannel {
3324                 if self.channel_outbound {
3325                         panic!("Tried to send accept_channel for an outbound channel?");
3326                 }
3327                 if self.channel_state != (ChannelState::OurInitSent as u32) | (ChannelState::TheirInitSent as u32) {
3328                         panic!("Tried to send accept_channel after channel had moved forward");
3329                 }
3330                 if self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3331                         panic!("Tried to send an accept_channel for a channel that has already advanced");
3332                 }
3333
3334                 let local_commitment_secret = self.build_local_commitment_secret(self.cur_local_commitment_transaction_number);
3335
3336                 msgs::AcceptChannel {
3337                         temporary_channel_id: self.channel_id,
3338                         dust_limit_satoshis: self.our_dust_limit_satoshis,
3339                         max_htlc_value_in_flight_msat: Channel::<ChanSigner>::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis),
3340                         channel_reserve_satoshis: Channel::<ChanSigner>::get_our_channel_reserve_satoshis(self.channel_value_satoshis),
3341                         htlc_minimum_msat: self.our_htlc_minimum_msat,
3342                         minimum_depth: self.minimum_depth,
3343                         to_self_delay: self.our_to_self_delay,
3344                         max_accepted_htlcs: OUR_MAX_HTLCS,
3345                         funding_pubkey: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key()),
3346                         revocation_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.revocation_base_key()),
3347                         payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.payment_base_key()),
3348                         delayed_payment_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.delayed_payment_base_key()),
3349                         htlc_basepoint: PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.htlc_base_key()),
3350                         first_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &local_commitment_secret),
3351                         shutdown_scriptpubkey: OptionalField::Present(if self.config.commit_upfront_shutdown_pubkey { self.get_closing_scriptpubkey() } else { Builder::new().into_script() })
3352                 }
3353         }
3354
3355         /// If an Err is returned, it is a ChannelError::Close (for get_outbound_funding_created)
3356         fn get_outbound_funding_created_signature(&mut self) -> Result<Signature, ChannelError> {
3357                 let remote_keys = self.build_remote_transaction_keys()?;
3358                 let remote_initial_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, false, self.feerate_per_kw).0;
3359                 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)
3360                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?.0)
3361         }
3362
3363         /// Updates channel state with knowledge of the funding transaction's txid/index, and generates
3364         /// a funding_created message for the remote peer.
3365         /// Panics if called at some time other than immediately after initial handshake, if called twice,
3366         /// or if called on an inbound channel.
3367         /// Note that channel_id changes during this call!
3368         /// Do NOT broadcast the funding transaction until after a successful funding_signed call!
3369         /// If an Err is returned, it is a ChannelError::Close.
3370         pub fn get_outbound_funding_created(&mut self, funding_txo: OutPoint) -> Result<msgs::FundingCreated, ChannelError> {
3371                 if !self.channel_outbound {
3372                         panic!("Tried to create outbound funding_created message on an inbound channel!");
3373                 }
3374                 if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) {
3375                         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)");
3376                 }
3377                 if self.commitment_secrets.get_min_seen_secret() != (1 << 48) ||
3378                                 self.cur_remote_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER ||
3379                                 self.cur_local_commitment_transaction_number != INITIAL_COMMITMENT_NUMBER {
3380                         panic!("Should not have advanced channel commitment tx numbers prior to funding_created");
3381                 }
3382
3383                 self.funding_txo = Some(funding_txo.clone());
3384                 let our_signature = match self.get_outbound_funding_created_signature() {
3385                         Ok(res) => res,
3386                         Err(e) => {
3387                                 log_error!(self, "Got bad signatures: {:?}!", e);
3388                                 self.funding_txo = None;
3389                                 return Err(e);
3390                         }
3391                 };
3392
3393                 let temporary_channel_id = self.channel_id;
3394
3395                 // Now that we're past error-generating stuff, update our local state:
3396
3397                 self.channel_state = ChannelState::FundingCreated as u32;
3398                 self.channel_id = funding_txo.to_channel_id();
3399
3400                 Ok(msgs::FundingCreated {
3401                         temporary_channel_id,
3402                         funding_txid: funding_txo.txid,
3403                         funding_output_index: funding_txo.index,
3404                         signature: our_signature
3405                 })
3406         }
3407
3408         /// Gets an UnsignedChannelAnnouncement, as well as a signature covering it using our
3409         /// bitcoin_key, if available, for this channel. The channel must be publicly announceable and
3410         /// available for use (have exchanged FundingLocked messages in both directions). Should be used
3411         /// for both loose and in response to an AnnouncementSignatures message from the remote peer.
3412         /// Will only fail if we're not in a state where channel_announcement may be sent (including
3413         /// closing).
3414         /// Note that the "channel must be funded" requirement is stricter than BOLT 7 requires - see
3415         /// https://github.com/lightningnetwork/lightning-rfc/issues/468
3416         pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), ChannelError> {
3417                 if !self.config.announced_channel {
3418                         return Err(ChannelError::Ignore("Channel is not available for public announcements"));
3419                 }
3420                 if self.channel_state & (ChannelState::ChannelFunded as u32) == 0 {
3421                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement until the channel funding has been locked"));
3422                 }
3423                 if (self.channel_state & (ChannelState::LocalShutdownSent as u32 | ChannelState::ShutdownComplete as u32)) != 0 {
3424                         return Err(ChannelError::Ignore("Cannot get a ChannelAnnouncement once the channel is closing"));
3425                 }
3426
3427                 let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..];
3428                 let our_bitcoin_key = PublicKey::from_secret_key(&self.secp_ctx, self.local_keys.funding_key());
3429
3430                 let msg = msgs::UnsignedChannelAnnouncement {
3431                         features: ChannelFeatures::supported(),
3432                         chain_hash: chain_hash,
3433                         short_channel_id: self.get_short_channel_id().unwrap(),
3434                         node_id_1: if were_node_one { our_node_id } else { self.get_their_node_id() },
3435                         node_id_2: if were_node_one { self.get_their_node_id() } else { our_node_id },
3436                         bitcoin_key_1: if were_node_one { our_bitcoin_key } else { self.their_funding_pubkey().clone() },
3437                         bitcoin_key_2: if were_node_one { self.their_funding_pubkey().clone() } else { our_bitcoin_key },
3438                         excess_data: Vec::new(),
3439                 };
3440
3441                 let sig = self.local_keys.sign_channel_announcement(&msg, &self.secp_ctx)
3442                         .map_err(|_| ChannelError::Ignore("Signer rejected channel_announcement"))?;
3443
3444                 Ok((msg, sig))
3445         }
3446
3447         /// May panic if called on a channel that wasn't immediately-previously
3448         /// self.remove_uncommitted_htlcs_and_mark_paused()'d
3449         pub fn get_channel_reestablish(&self) -> msgs::ChannelReestablish {
3450                 assert_eq!(self.channel_state & ChannelState::PeerDisconnected as u32, ChannelState::PeerDisconnected as u32);
3451                 assert_ne!(self.cur_remote_commitment_transaction_number, INITIAL_COMMITMENT_NUMBER);
3452                 let data_loss_protect = if self.cur_remote_commitment_transaction_number + 1 < INITIAL_COMMITMENT_NUMBER {
3453                         let remote_last_secret = self.commitment_secrets.get_secret(self.cur_remote_commitment_transaction_number + 2).unwrap();
3454                         log_trace!(self, "Enough info to generate a Data Loss Protect with per_commitment_secret {}", log_bytes!(remote_last_secret));
3455                         OptionalField::Present(DataLossProtect {
3456                                 your_last_per_commitment_secret: remote_last_secret,
3457                                 my_current_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number + 1))
3458                         })
3459                 } else {
3460                         log_info!(self, "Sending a data_loss_protect with no previous remote per_commitment_secret");
3461                         OptionalField::Present(DataLossProtect {
3462                                 your_last_per_commitment_secret: [0;32],
3463                                 my_current_per_commitment_point: PublicKey::from_secret_key(&self.secp_ctx, &self.build_local_commitment_secret(self.cur_local_commitment_transaction_number + 1))
3464                         })
3465                 };
3466                 msgs::ChannelReestablish {
3467                         channel_id: self.channel_id(),
3468                         // The protocol has two different commitment number concepts - the "commitment
3469                         // transaction number", which starts from 0 and counts up, and the "revocation key
3470                         // index" which starts at INITIAL_COMMITMENT_NUMBER and counts down. We track
3471                         // commitment transaction numbers by the index which will be used to reveal the
3472                         // revocation key for that commitment transaction, which means we have to convert them
3473                         // to protocol-level commitment numbers here...
3474
3475                         // next_local_commitment_number is the next commitment_signed number we expect to
3476                         // receive (indicating if they need to resend one that we missed).
3477                         next_local_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_local_commitment_transaction_number,
3478                         // We have to set next_remote_commitment_number to the next revoke_and_ack we expect to
3479                         // receive, however we track it by the next commitment number for a remote transaction
3480                         // (which is one further, as they always revoke previous commitment transaction, not
3481                         // the one we send) so we have to decrement by 1. Note that if
3482                         // cur_remote_commitment_transaction_number is INITIAL_COMMITMENT_NUMBER we will have
3483                         // dropped this channel on disconnect as it hasn't yet reached FundingSent so we can't
3484                         // overflow here.
3485                         next_remote_commitment_number: INITIAL_COMMITMENT_NUMBER - self.cur_remote_commitment_transaction_number - 1,
3486                         data_loss_protect,
3487                 }
3488         }
3489
3490
3491         // Send stuff to our remote peers:
3492
3493         /// Adds a pending outbound HTLC to this channel, note that you probably want
3494         /// send_htlc_and_commit instead cause you'll want both messages at once.
3495         /// This returns an option instead of a pure UpdateAddHTLC as we may be in a state where we are
3496         /// waiting on the remote peer to send us a revoke_and_ack during which time we cannot add new
3497         /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed.
3498         /// You MUST call send_commitment prior to any other calls on this Channel
3499         /// If an Err is returned, it's a ChannelError::Ignore!
3500         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> {
3501                 if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) {
3502                         return Err(ChannelError::Ignore("Cannot send HTLC until channel is fully established and we haven't started shutting down"));
3503                 }
3504
3505                 if amount_msat > self.channel_value_satoshis * 1000 {
3506                         return Err(ChannelError::Ignore("Cannot send more than the total value of the channel"));
3507                 }
3508
3509                 if amount_msat == 0 {
3510                         return Err(ChannelError::Ignore("Cannot send 0-msat HTLC"));
3511                 }
3512
3513                 if amount_msat < self.their_htlc_minimum_msat {
3514                         return Err(ChannelError::Ignore("Cannot send less than their minimum HTLC value"));
3515                 }
3516
3517                 if (self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32)) != 0 {
3518                         // Note that this should never really happen, if we're !is_live() on receipt of an
3519                         // incoming HTLC for relay will result in us rejecting the HTLC and we won't allow
3520                         // the user to send directly into a !is_live() channel. However, if we
3521                         // disconnected during the time the previous hop was doing the commitment dance we may
3522                         // end up getting here after the forwarding delay. In any case, returning an
3523                         // IgnoreError will get ChannelManager to do the right thing and fail backwards now.
3524                         return Err(ChannelError::Ignore("Cannot send an HTLC while disconnected/frozen for channel monitor update"));
3525                 }
3526
3527                 let (outbound_htlc_count, htlc_outbound_value_msat) = self.get_outbound_pending_htlc_stats();
3528                 if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 {
3529                         return Err(ChannelError::Ignore("Cannot push more than their max accepted HTLCs"));
3530                 }
3531                 // Check their_max_htlc_value_in_flight_msat
3532                 if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat {
3533                         return Err(ChannelError::Ignore("Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
3534                 }
3535
3536                 // Check self.their_channel_reserve_satoshis (the amount we must keep as
3537                 // reserve for them to have something to claim if we misbehave)
3538                 if self.value_to_self_msat < self.their_channel_reserve_satoshis * 1000 + amount_msat + htlc_outbound_value_msat {
3539                         return Err(ChannelError::Ignore("Cannot send value that would put us over their reserve value"));
3540                 }
3541
3542                 //TODO: Check cltv_expiry? Do this in channel manager?
3543
3544                 // Now update local state:
3545                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3546                         self.holding_cell_htlc_updates.push(HTLCUpdateAwaitingACK::AddHTLC {
3547                                 amount_msat: amount_msat,
3548                                 payment_hash: payment_hash,
3549                                 cltv_expiry: cltv_expiry,
3550                                 source,
3551                                 onion_routing_packet: onion_routing_packet,
3552                         });
3553                         return Ok(None);
3554                 }
3555
3556                 self.pending_outbound_htlcs.push(OutboundHTLCOutput {
3557                         htlc_id: self.next_local_htlc_id,
3558                         amount_msat: amount_msat,
3559                         payment_hash: payment_hash.clone(),
3560                         cltv_expiry: cltv_expiry,
3561                         state: OutboundHTLCState::LocalAnnounced(Box::new(onion_routing_packet.clone())),
3562                         source,
3563                 });
3564
3565                 let res = msgs::UpdateAddHTLC {
3566                         channel_id: self.channel_id,
3567                         htlc_id: self.next_local_htlc_id,
3568                         amount_msat: amount_msat,
3569                         payment_hash: payment_hash,
3570                         cltv_expiry: cltv_expiry,
3571                         onion_routing_packet: onion_routing_packet,
3572                 };
3573                 self.next_local_htlc_id += 1;
3574
3575                 Ok(Some(res))
3576         }
3577
3578         /// Creates a signed commitment transaction to send to the remote peer.
3579         /// Always returns a ChannelError::Close if an immediately-preceding (read: the
3580         /// last call to this Channel) send_htlc returned Ok(Some(_)) and there is an Err.
3581         /// May panic if called except immediately after a successful, Ok(Some(_))-returning send_htlc.
3582         pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3583                 if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) {
3584                         panic!("Cannot create commitment tx until channel is fully established");
3585                 }
3586                 if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) {
3587                         panic!("Cannot create commitment tx until remote revokes their previous commitment");
3588                 }
3589                 if (self.channel_state & (ChannelState::PeerDisconnected as u32)) == (ChannelState::PeerDisconnected as u32) {
3590                         panic!("Cannot create commitment tx while disconnected, as send_htlc will have returned an Err so a send_commitment precondition has been violated");
3591                 }
3592                 if (self.channel_state & (ChannelState::MonitorUpdateFailed as u32)) == (ChannelState::MonitorUpdateFailed as u32) {
3593                         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");
3594                 }
3595                 let mut have_updates = self.pending_update_fee.is_some();
3596                 for htlc in self.pending_outbound_htlcs.iter() {
3597                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3598                                 have_updates = true;
3599                         }
3600                         if have_updates { break; }
3601                 }
3602                 for htlc in self.pending_inbound_htlcs.iter() {
3603                         if let InboundHTLCState::LocalRemoved(_) = htlc.state {
3604                                 have_updates = true;
3605                         }
3606                         if have_updates { break; }
3607                 }
3608                 if !have_updates {
3609                         panic!("Cannot create commitment tx until we have some updates to send");
3610                 }
3611                 self.send_commitment_no_status_check()
3612         }
3613         /// Only fails in case of bad keys
3614         fn send_commitment_no_status_check(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitorUpdate), ChannelError> {
3615                 // We can upgrade the status of some HTLCs that are waiting on a commitment, even if we
3616                 // fail to generate this, we still are at least at a position where upgrading their status
3617                 // is acceptable.
3618                 for htlc in self.pending_inbound_htlcs.iter_mut() {
3619                         let new_state = if let &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref forward_info) = &htlc.state {
3620                                 Some(InboundHTLCState::AwaitingAnnouncedRemoteRevoke(forward_info.clone()))
3621                         } else { None };
3622                         if let Some(state) = new_state {
3623                                 htlc.state = state;
3624                         }
3625                 }
3626                 for htlc in self.pending_outbound_htlcs.iter_mut() {
3627                         if let Some(fail_reason) = if let &mut OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref mut fail_reason) = &mut htlc.state {
3628                                 Some(fail_reason.take())
3629                         } else { None } {
3630                                 htlc.state = OutboundHTLCState::AwaitingRemovedRemoteRevoke(fail_reason);
3631                         }
3632                 }
3633                 self.resend_order = RAACommitmentOrder::RevokeAndACKFirst;
3634
3635                 let (res, remote_commitment_tx, htlcs) = match self.send_commitment_no_state_update() {
3636                         Ok((res, (remote_commitment_tx, mut htlcs))) => {
3637                                 // Update state now that we've passed all the can-fail calls...
3638                                 let htlcs_no_ref: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)> =
3639                                         htlcs.drain(..).map(|(htlc, htlc_source)| (htlc, htlc_source.map(|source_ref| Box::new(source_ref.clone())))).collect();
3640                                 (res, remote_commitment_tx, htlcs_no_ref)
3641                         },
3642                         Err(e) => return Err(e),
3643                 };
3644
3645                 self.latest_monitor_update_id += 1;
3646                 let monitor_update = ChannelMonitorUpdate {
3647                         update_id: self.latest_monitor_update_id,
3648                         updates: vec![ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
3649                                 unsigned_commitment_tx: remote_commitment_tx.clone(),
3650                                 htlc_outputs: htlcs.clone(),
3651                                 commitment_number: self.cur_remote_commitment_transaction_number,
3652                                 their_revocation_point: self.their_cur_commitment_point.unwrap()
3653                         }]
3654                 };
3655                 self.channel_monitor.as_mut().unwrap().update_monitor_ooo(monitor_update.clone()).unwrap();
3656                 self.channel_state |= ChannelState::AwaitingRemoteRevoke as u32;
3657                 Ok((res, monitor_update))
3658         }
3659
3660         /// Only fails in case of bad keys. Used for channel_reestablish commitment_signed generation
3661         /// when we shouldn't change HTLC/channel state.
3662         fn send_commitment_no_state_update(&self) -> Result<(msgs::CommitmentSigned, (Transaction, Vec<(HTLCOutputInCommitment, Option<&HTLCSource>)>)), ChannelError> {
3663                 let mut feerate_per_kw = self.feerate_per_kw;
3664                 if let Some(feerate) = self.pending_update_fee {
3665                         if self.channel_outbound {
3666                                 feerate_per_kw = feerate;
3667                         }
3668                 }
3669
3670                 let remote_keys = self.build_remote_transaction_keys()?;
3671                 let remote_commitment_tx = self.build_commitment_transaction(self.cur_remote_commitment_transaction_number, &remote_keys, false, true, feerate_per_kw);
3672                 let (signature, htlc_signatures);
3673
3674                 {
3675                         let mut htlcs = Vec::with_capacity(remote_commitment_tx.2.len());
3676                         for &(ref htlc, _) in remote_commitment_tx.2.iter() {
3677                                 htlcs.push(htlc);
3678                         }
3679
3680                         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)
3681                                 .map_err(|_| ChannelError::Close("Failed to get signatures for new commitment_signed"))?;
3682                         signature = res.0;
3683                         htlc_signatures = res.1;
3684
3685                         log_trace!(self, "Signed remote commitment tx {} with redeemscript {} -> {}",
3686                                 encode::serialize_hex(&remote_commitment_tx.0),
3687                                 encode::serialize_hex(&self.get_funding_redeemscript()),
3688                                 log_bytes!(signature.serialize_compact()[..]));
3689
3690                         for (ref htlc_sig, ref htlc) in htlc_signatures.iter().zip(htlcs) {
3691                                 log_trace!(self, "Signed remote HTLC tx {} with redeemscript {} with pubkey {} -> {}",
3692                                         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)),
3693                                         encode::serialize_hex(&chan_utils::get_htlc_redeemscript(&htlc, &remote_keys)),
3694                                         log_bytes!(remote_keys.a_htlc_key.serialize()),
3695                                         log_bytes!(htlc_sig.serialize_compact()[..]));
3696                         }
3697                 }
3698
3699                 Ok((msgs::CommitmentSigned {
3700                         channel_id: self.channel_id,
3701                         signature,
3702                         htlc_signatures,
3703                 }, (remote_commitment_tx.0, remote_commitment_tx.2)))
3704         }
3705
3706         /// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
3707         /// to send to the remote peer in one go.
3708         /// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
3709         /// more info.
3710         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> {
3711                 match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet)? {
3712                         Some(update_add_htlc) => {
3713                                 let (commitment_signed, monitor_update) = self.send_commitment_no_status_check()?;
3714                                 Ok(Some((update_add_htlc, commitment_signed, monitor_update)))
3715                         },
3716                         None => Ok(None)
3717                 }
3718         }
3719
3720         /// Begins the shutdown process, getting a message for the remote peer and returning all
3721         /// holding cell HTLCs for payment failure.
3722         pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<(HTLCSource, PaymentHash)>), APIError> {
3723                 for htlc in self.pending_outbound_htlcs.iter() {
3724                         if let OutboundHTLCState::LocalAnnounced(_) = htlc.state {
3725                                 return Err(APIError::APIMisuseError{err: "Cannot begin shutdown with pending HTLCs. Process pending events first"});
3726                         }
3727                 }
3728                 if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 {
3729                         if (self.channel_state & ChannelState::LocalShutdownSent as u32) == ChannelState::LocalShutdownSent as u32 {
3730                                 return Err(APIError::APIMisuseError{err: "Shutdown already in progress"});
3731                         }
3732                         else if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 {
3733                                 return Err(APIError::ChannelUnavailable{err: "Shutdown already in progress by remote"});
3734                         }
3735                 }
3736                 assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0);
3737                 if self.channel_state & (ChannelState::PeerDisconnected as u32 | ChannelState::MonitorUpdateFailed as u32) != 0 {
3738                         return Err(APIError::ChannelUnavailable{err: "Cannot begin shutdown while peer is disconnected or we're waiting on a monitor update, maybe force-close instead?"});
3739                 }
3740
3741                 let our_closing_script = self.get_closing_scriptpubkey();
3742
3743                 // From here on out, we may not fail!
3744                 if self.channel_state < ChannelState::FundingSent as u32 {
3745                         self.channel_state = ChannelState::ShutdownComplete as u32;
3746                 } else {
3747                         self.channel_state |= ChannelState::LocalShutdownSent as u32;
3748                 }
3749                 self.update_time_counter += 1;
3750
3751                 // Go ahead and drop holding cell updates as we'd rather fail payments than wait to send
3752                 // our shutdown until we've committed all of the pending changes.
3753                 self.holding_cell_update_fee = None;
3754                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3755                 self.holding_cell_htlc_updates.retain(|htlc_update| {
3756                         match htlc_update {
3757                                 &HTLCUpdateAwaitingACK::AddHTLC { ref payment_hash, ref source, .. } => {
3758                                         dropped_outbound_htlcs.push((source.clone(), payment_hash.clone()));
3759                                         false
3760                                 },
3761                                 _ => true
3762                         }
3763                 });
3764
3765                 Ok((msgs::Shutdown {
3766                         channel_id: self.channel_id,
3767                         scriptpubkey: our_closing_script,
3768                 }, dropped_outbound_htlcs))
3769         }
3770
3771         /// Gets the latest commitment transaction and any dependent transactions for relay (forcing
3772         /// shutdown of this channel - no more calls into this Channel may be made afterwards except
3773         /// those explicitly stated to be allowed after shutdown completes, eg some simple getters).
3774         /// Also returns the list of payment_hashes for channels which we can safely fail backwards
3775         /// immediately (others we will have to allow to time out).
3776         pub fn force_shutdown(&mut self, should_broadcast: bool) -> (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>) {
3777                 assert!(self.channel_state != ChannelState::ShutdownComplete as u32);
3778
3779                 // We go ahead and "free" any holding cell HTLCs or HTLCs we haven't yet committed to and
3780                 // return them to fail the payment.
3781                 let mut dropped_outbound_htlcs = Vec::with_capacity(self.holding_cell_htlc_updates.len());
3782                 for htlc_update in self.holding_cell_htlc_updates.drain(..) {
3783                         match htlc_update {
3784                                 HTLCUpdateAwaitingACK::AddHTLC { source, payment_hash, .. } => {
3785                                         dropped_outbound_htlcs.push((source, payment_hash));
3786                                 },
3787                                 _ => {}
3788                         }
3789                 }
3790
3791                 for _htlc in self.pending_outbound_htlcs.drain(..) {
3792                         //TODO: Do something with the remaining HTLCs
3793                         //(we need to have the ChannelManager monitor them so we can claim the inbound HTLCs
3794                         //which correspond)
3795                 }
3796
3797                 self.channel_state = ChannelState::ShutdownComplete as u32;
3798                 self.update_time_counter += 1;
3799                 self.latest_monitor_update_id += 1;
3800                 (self.funding_txo.clone(), ChannelMonitorUpdate {
3801                         update_id: self.latest_monitor_update_id,
3802                         updates: vec![ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast }],
3803                 }, dropped_outbound_htlcs)
3804         }
3805 }
3806
3807 const SERIALIZATION_VERSION: u8 = 1;
3808 const MIN_SERIALIZATION_VERSION: u8 = 1;
3809
3810 impl Writeable for InboundHTLCRemovalReason {
3811         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3812                 match self {
3813                         &InboundHTLCRemovalReason::FailRelay(ref error_packet) => {
3814                                 0u8.write(writer)?;
3815                                 error_packet.write(writer)?;
3816                         },
3817                         &InboundHTLCRemovalReason::FailMalformed((ref onion_hash, ref err_code)) => {
3818                                 1u8.write(writer)?;
3819                                 onion_hash.write(writer)?;
3820                                 err_code.write(writer)?;
3821                         },
3822                         &InboundHTLCRemovalReason::Fulfill(ref payment_preimage) => {
3823                                 2u8.write(writer)?;
3824                                 payment_preimage.write(writer)?;
3825                         },
3826                 }
3827                 Ok(())
3828         }
3829 }
3830
3831 impl Readable for InboundHTLCRemovalReason {
3832         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
3833                 Ok(match <u8 as Readable>::read(reader)? {
3834                         0 => InboundHTLCRemovalReason::FailRelay(Readable::read(reader)?),
3835                         1 => InboundHTLCRemovalReason::FailMalformed((Readable::read(reader)?, Readable::read(reader)?)),
3836                         2 => InboundHTLCRemovalReason::Fulfill(Readable::read(reader)?),
3837                         _ => return Err(DecodeError::InvalidValue),
3838                 })
3839         }
3840 }
3841
3842 impl<ChanSigner: ChannelKeys + Writeable> Writeable for Channel<ChanSigner> {
3843         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3844                 // Note that we write out as if remove_uncommitted_htlcs_and_mark_paused had just been
3845                 // called but include holding cell updates (and obviously we don't modify self).
3846
3847                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3848                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3849
3850                 self.user_id.write(writer)?;
3851                 self.config.write(writer)?;
3852
3853                 self.channel_id.write(writer)?;
3854                 (self.channel_state | ChannelState::PeerDisconnected as u32).write(writer)?;
3855                 self.channel_outbound.write(writer)?;
3856                 self.channel_value_satoshis.write(writer)?;
3857
3858                 self.latest_monitor_update_id.write(writer)?;
3859
3860                 self.local_keys.write(writer)?;
3861                 self.shutdown_pubkey.write(writer)?;
3862                 self.destination_script.write(writer)?;
3863
3864                 self.cur_local_commitment_transaction_number.write(writer)?;
3865                 self.cur_remote_commitment_transaction_number.write(writer)?;
3866                 self.value_to_self_msat.write(writer)?;
3867
3868                 let mut dropped_inbound_htlcs = 0;
3869                 for htlc in self.pending_inbound_htlcs.iter() {
3870                         if let InboundHTLCState::RemoteAnnounced(_) = htlc.state {
3871                                 dropped_inbound_htlcs += 1;
3872                         }
3873                 }
3874                 (self.pending_inbound_htlcs.len() as u64 - dropped_inbound_htlcs).write(writer)?;
3875                 for htlc in self.pending_inbound_htlcs.iter() {
3876                         if let &InboundHTLCState::RemoteAnnounced(_) = &htlc.state {
3877                                 continue; // Drop
3878                         }
3879                         htlc.htlc_id.write(writer)?;
3880                         htlc.amount_msat.write(writer)?;
3881                         htlc.cltv_expiry.write(writer)?;
3882                         htlc.payment_hash.write(writer)?;
3883                         match &htlc.state {
3884                                 &InboundHTLCState::RemoteAnnounced(_) => unreachable!(),
3885                                 &InboundHTLCState::AwaitingRemoteRevokeToAnnounce(ref htlc_state) => {
3886                                         1u8.write(writer)?;
3887                                         htlc_state.write(writer)?;
3888                                 },
3889                                 &InboundHTLCState::AwaitingAnnouncedRemoteRevoke(ref htlc_state) => {
3890                                         2u8.write(writer)?;
3891                                         htlc_state.write(writer)?;
3892                                 },
3893                                 &InboundHTLCState::Committed => {
3894                                         3u8.write(writer)?;
3895                                 },
3896                                 &InboundHTLCState::LocalRemoved(ref removal_reason) => {
3897                                         4u8.write(writer)?;
3898                                         removal_reason.write(writer)?;
3899                                 },
3900                         }
3901                 }
3902
3903                 (self.pending_outbound_htlcs.len() as u64).write(writer)?;
3904                 for htlc in self.pending_outbound_htlcs.iter() {
3905                         htlc.htlc_id.write(writer)?;
3906                         htlc.amount_msat.write(writer)?;
3907                         htlc.cltv_expiry.write(writer)?;
3908                         htlc.payment_hash.write(writer)?;
3909                         htlc.source.write(writer)?;
3910                         match &htlc.state {
3911                                 &OutboundHTLCState::LocalAnnounced(ref onion_packet) => {
3912                                         0u8.write(writer)?;
3913                                         onion_packet.write(writer)?;
3914                                 },
3915                                 &OutboundHTLCState::Committed => {
3916                                         1u8.write(writer)?;
3917                                 },
3918                                 &OutboundHTLCState::RemoteRemoved(ref fail_reason) => {
3919                                         2u8.write(writer)?;
3920                                         fail_reason.write(writer)?;
3921                                 },
3922                                 &OutboundHTLCState::AwaitingRemoteRevokeToRemove(ref fail_reason) => {
3923                                         3u8.write(writer)?;
3924                                         fail_reason.write(writer)?;
3925                                 },
3926                                 &OutboundHTLCState::AwaitingRemovedRemoteRevoke(ref fail_reason) => {
3927                                         4u8.write(writer)?;
3928                                         fail_reason.write(writer)?;
3929                                 },
3930                         }
3931                 }
3932
3933                 (self.holding_cell_htlc_updates.len() as u64).write(writer)?;
3934                 for update in self.holding_cell_htlc_updates.iter() {
3935                         match update {
3936                                 &HTLCUpdateAwaitingACK::AddHTLC { ref amount_msat, ref cltv_expiry, ref payment_hash, ref source, ref onion_routing_packet } => {
3937                                         0u8.write(writer)?;
3938                                         amount_msat.write(writer)?;
3939                                         cltv_expiry.write(writer)?;
3940                                         payment_hash.write(writer)?;
3941                                         source.write(writer)?;
3942                                         onion_routing_packet.write(writer)?;
3943                                 },
3944                                 &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_preimage, ref htlc_id } => {
3945                                         1u8.write(writer)?;
3946                                         payment_preimage.write(writer)?;
3947                                         htlc_id.write(writer)?;
3948                                 },
3949                                 &HTLCUpdateAwaitingACK::FailHTLC { ref htlc_id, ref err_packet } => {
3950                                         2u8.write(writer)?;
3951                                         htlc_id.write(writer)?;
3952                                         err_packet.write(writer)?;
3953                                 }
3954                         }
3955                 }
3956
3957                 match self.resend_order {
3958                         RAACommitmentOrder::CommitmentFirst => 0u8.write(writer)?,
3959                         RAACommitmentOrder::RevokeAndACKFirst => 1u8.write(writer)?,
3960                 }
3961
3962                 self.monitor_pending_funding_locked.write(writer)?;
3963                 self.monitor_pending_revoke_and_ack.write(writer)?;
3964                 self.monitor_pending_commitment_signed.write(writer)?;
3965
3966                 (self.monitor_pending_forwards.len() as u64).write(writer)?;
3967                 for &(ref pending_forward, ref htlc_id) in self.monitor_pending_forwards.iter() {
3968                         pending_forward.write(writer)?;
3969                         htlc_id.write(writer)?;
3970                 }
3971
3972                 (self.monitor_pending_failures.len() as u64).write(writer)?;
3973                 for &(ref htlc_source, ref payment_hash, ref fail_reason) in self.monitor_pending_failures.iter() {
3974                         htlc_source.write(writer)?;
3975                         payment_hash.write(writer)?;
3976                         fail_reason.write(writer)?;
3977                 }
3978
3979                 self.pending_update_fee.write(writer)?;
3980                 self.holding_cell_update_fee.write(writer)?;
3981
3982                 self.next_local_htlc_id.write(writer)?;
3983                 (self.next_remote_htlc_id - dropped_inbound_htlcs).write(writer)?;
3984                 self.update_time_counter.write(writer)?;
3985                 self.feerate_per_kw.write(writer)?;
3986
3987                 match self.last_sent_closing_fee {
3988                         Some((feerate, fee, sig)) => {
3989                                 1u8.write(writer)?;
3990                                 feerate.write(writer)?;
3991                                 fee.write(writer)?;
3992                                 sig.write(writer)?;
3993                         },
3994                         None => 0u8.write(writer)?,
3995                 }
3996
3997                 self.funding_txo.write(writer)?;
3998                 self.funding_tx_confirmed_in.write(writer)?;
3999                 self.short_channel_id.write(writer)?;
4000
4001                 self.last_block_connected.write(writer)?;
4002                 self.funding_tx_confirmations.write(writer)?;
4003
4004                 self.their_dust_limit_satoshis.write(writer)?;
4005                 self.our_dust_limit_satoshis.write(writer)?;
4006                 self.their_max_htlc_value_in_flight_msat.write(writer)?;
4007                 self.their_channel_reserve_satoshis.write(writer)?;
4008                 self.their_htlc_minimum_msat.write(writer)?;
4009                 self.our_htlc_minimum_msat.write(writer)?;
4010                 self.their_to_self_delay.write(writer)?;
4011                 self.our_to_self_delay.write(writer)?;
4012                 self.their_max_accepted_htlcs.write(writer)?;
4013                 self.minimum_depth.write(writer)?;
4014
4015                 self.their_pubkeys.write(writer)?;
4016                 self.their_cur_commitment_point.write(writer)?;
4017
4018                 self.their_prev_commitment_point.write(writer)?;
4019                 self.their_node_id.write(writer)?;
4020
4021                 self.their_shutdown_scriptpubkey.write(writer)?;
4022
4023                 self.commitment_secrets.write(writer)?;
4024
4025                 self.channel_monitor.as_ref().unwrap().write_for_disk(writer)?;
4026                 Ok(())
4027         }
4028 }
4029
4030 impl<ChanSigner: ChannelKeys + Readable> ReadableArgs<Arc<Logger>> for Channel<ChanSigner> {
4031         fn read<R : ::std::io::Read>(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
4032                 let _ver: u8 = Readable::read(reader)?;
4033                 let min_ver: u8 = Readable::read(reader)?;
4034                 if min_ver > SERIALIZATION_VERSION {
4035                         return Err(DecodeError::UnknownVersion);
4036                 }
4037
4038                 let user_id = Readable::read(reader)?;
4039                 let config: ChannelConfig = Readable::read(reader)?;
4040
4041                 let channel_id = Readable::read(reader)?;
4042                 let channel_state = Readable::read(reader)?;
4043                 let channel_outbound = Readable::read(reader)?;
4044                 let channel_value_satoshis = Readable::read(reader)?;
4045
4046                 let latest_monitor_update_id = Readable::read(reader)?;
4047
4048                 let local_keys = Readable::read(reader)?;
4049                 let shutdown_pubkey = Readable::read(reader)?;
4050                 let destination_script = Readable::read(reader)?;
4051
4052                 let cur_local_commitment_transaction_number = Readable::read(reader)?;
4053                 let cur_remote_commitment_transaction_number = Readable::read(reader)?;
4054                 let value_to_self_msat = Readable::read(reader)?;
4055
4056                 let pending_inbound_htlc_count: u64 = Readable::read(reader)?;
4057                 let mut pending_inbound_htlcs = Vec::with_capacity(cmp::min(pending_inbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4058                 for _ in 0..pending_inbound_htlc_count {
4059                         pending_inbound_htlcs.push(InboundHTLCOutput {
4060                                 htlc_id: Readable::read(reader)?,
4061                                 amount_msat: Readable::read(reader)?,
4062                                 cltv_expiry: Readable::read(reader)?,
4063                                 payment_hash: Readable::read(reader)?,
4064                                 state: match <u8 as Readable>::read(reader)? {
4065                                         1 => InboundHTLCState::AwaitingRemoteRevokeToAnnounce(Readable::read(reader)?),
4066                                         2 => InboundHTLCState::AwaitingAnnouncedRemoteRevoke(Readable::read(reader)?),
4067                                         3 => InboundHTLCState::Committed,
4068                                         4 => InboundHTLCState::LocalRemoved(Readable::read(reader)?),
4069                                         _ => return Err(DecodeError::InvalidValue),
4070                                 },
4071                         });
4072                 }
4073
4074                 let pending_outbound_htlc_count: u64 = Readable::read(reader)?;
4075                 let mut pending_outbound_htlcs = Vec::with_capacity(cmp::min(pending_outbound_htlc_count as usize, OUR_MAX_HTLCS as usize));
4076                 for _ in 0..pending_outbound_htlc_count {
4077                         pending_outbound_htlcs.push(OutboundHTLCOutput {
4078                                 htlc_id: Readable::read(reader)?,
4079                                 amount_msat: Readable::read(reader)?,
4080                                 cltv_expiry: Readable::read(reader)?,
4081                                 payment_hash: Readable::read(reader)?,
4082                                 source: Readable::read(reader)?,
4083                                 state: match <u8 as Readable>::read(reader)? {
4084                                         0 => OutboundHTLCState::LocalAnnounced(Box::new(Readable::read(reader)?)),
4085                                         1 => OutboundHTLCState::Committed,
4086                                         2 => OutboundHTLCState::RemoteRemoved(Readable::read(reader)?),
4087                                         3 => OutboundHTLCState::AwaitingRemoteRevokeToRemove(Readable::read(reader)?),
4088                                         4 => OutboundHTLCState::AwaitingRemovedRemoteRevoke(Readable::read(reader)?),
4089                                         _ => return Err(DecodeError::InvalidValue),
4090                                 },
4091                         });
4092                 }
4093
4094                 let holding_cell_htlc_update_count: u64 = Readable::read(reader)?;
4095                 let mut holding_cell_htlc_updates = Vec::with_capacity(cmp::min(holding_cell_htlc_update_count as usize, OUR_MAX_HTLCS as usize*2));
4096                 for _ in 0..holding_cell_htlc_update_count {
4097                         holding_cell_htlc_updates.push(match <u8 as Readable>::read(reader)? {
4098                                 0 => HTLCUpdateAwaitingACK::AddHTLC {
4099                                         amount_msat: Readable::read(reader)?,
4100                                         cltv_expiry: Readable::read(reader)?,
4101                                         payment_hash: Readable::read(reader)?,
4102                                         source: Readable::read(reader)?,
4103                                         onion_routing_packet: Readable::read(reader)?,
4104                                 },
4105                                 1 => HTLCUpdateAwaitingACK::ClaimHTLC {
4106                                         payment_preimage: Readable::read(reader)?,
4107                                         htlc_id: Readable::read(reader)?,
4108                                 },
4109                                 2 => HTLCUpdateAwaitingACK::FailHTLC {
4110                                         htlc_id: Readable::read(reader)?,
4111                                         err_packet: Readable::read(reader)?,
4112                                 },
4113                                 _ => return Err(DecodeError::InvalidValue),
4114                         });
4115                 }
4116
4117                 let resend_order = match <u8 as Readable>::read(reader)? {
4118                         0 => RAACommitmentOrder::CommitmentFirst,
4119                         1 => RAACommitmentOrder::RevokeAndACKFirst,
4120                         _ => return Err(DecodeError::InvalidValue),
4121                 };
4122
4123                 let monitor_pending_funding_locked = Readable::read(reader)?;
4124                 let monitor_pending_revoke_and_ack = Readable::read(reader)?;
4125                 let monitor_pending_commitment_signed = Readable::read(reader)?;
4126
4127                 let monitor_pending_forwards_count: u64 = Readable::read(reader)?;
4128                 let mut monitor_pending_forwards = Vec::with_capacity(cmp::min(monitor_pending_forwards_count as usize, OUR_MAX_HTLCS as usize));
4129                 for _ in 0..monitor_pending_forwards_count {
4130                         monitor_pending_forwards.push((Readable::read(reader)?, Readable::read(reader)?));
4131                 }
4132
4133                 let monitor_pending_failures_count: u64 = Readable::read(reader)?;
4134                 let mut monitor_pending_failures = Vec::with_capacity(cmp::min(monitor_pending_failures_count as usize, OUR_MAX_HTLCS as usize));
4135                 for _ in 0..monitor_pending_failures_count {
4136                         monitor_pending_failures.push((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?));
4137                 }
4138
4139                 let pending_update_fee = Readable::read(reader)?;
4140                 let holding_cell_update_fee = Readable::read(reader)?;
4141
4142                 let next_local_htlc_id = Readable::read(reader)?;
4143                 let next_remote_htlc_id = Readable::read(reader)?;
4144                 let update_time_counter = Readable::read(reader)?;
4145                 let feerate_per_kw = Readable::read(reader)?;
4146
4147                 let last_sent_closing_fee = match <u8 as Readable>::read(reader)? {
4148                         0 => None,
4149                         1 => Some((Readable::read(reader)?, Readable::read(reader)?, Readable::read(reader)?)),
4150                         _ => return Err(DecodeError::InvalidValue),
4151                 };
4152
4153                 let funding_txo = Readable::read(reader)?;
4154                 let funding_tx_confirmed_in = Readable::read(reader)?;
4155                 let short_channel_id = Readable::read(reader)?;
4156
4157                 let last_block_connected = Readable::read(reader)?;
4158                 let funding_tx_confirmations = Readable::read(reader)?;
4159
4160                 let their_dust_limit_satoshis = Readable::read(reader)?;
4161                 let our_dust_limit_satoshis = Readable::read(reader)?;
4162                 let their_max_htlc_value_in_flight_msat = Readable::read(reader)?;
4163                 let their_channel_reserve_satoshis = Readable::read(reader)?;
4164                 let their_htlc_minimum_msat = Readable::read(reader)?;
4165                 let our_htlc_minimum_msat = Readable::read(reader)?;
4166                 let their_to_self_delay = Readable::read(reader)?;
4167                 let our_to_self_delay = Readable::read(reader)?;
4168                 let their_max_accepted_htlcs = Readable::read(reader)?;
4169                 let minimum_depth = Readable::read(reader)?;
4170
4171                 let their_pubkeys = Readable::read(reader)?;
4172                 let their_cur_commitment_point = Readable::read(reader)?;
4173
4174                 let their_prev_commitment_point = Readable::read(reader)?;
4175                 let their_node_id = Readable::read(reader)?;
4176
4177                 let their_shutdown_scriptpubkey = Readable::read(reader)?;
4178                 let commitment_secrets = Readable::read(reader)?;
4179
4180                 let (monitor_last_block, channel_monitor) = ReadableArgs::read(reader, logger.clone())?;
4181                 // We drop the ChannelMonitor's last block connected hash cause we don't actually bother
4182                 // doing full block connection operations on the internal ChannelMonitor copies
4183                 if monitor_last_block != last_block_connected {
4184                         return Err(DecodeError::InvalidValue);
4185                 }
4186
4187                 Ok(Channel {
4188                         user_id,
4189
4190                         config,
4191                         channel_id,
4192                         channel_state,
4193                         channel_outbound,
4194                         secp_ctx: Secp256k1::new(),
4195                         channel_value_satoshis,
4196
4197                         latest_monitor_update_id,
4198
4199                         local_keys,
4200                         shutdown_pubkey,
4201                         destination_script,
4202
4203                         cur_local_commitment_transaction_number,
4204                         cur_remote_commitment_transaction_number,
4205                         value_to_self_msat,
4206
4207                         pending_inbound_htlcs,
4208                         pending_outbound_htlcs,
4209                         holding_cell_htlc_updates,
4210
4211                         resend_order,
4212
4213                         monitor_pending_funding_locked,
4214                         monitor_pending_revoke_and_ack,
4215                         monitor_pending_commitment_signed,
4216                         monitor_pending_forwards,
4217                         monitor_pending_failures,
4218
4219                         pending_update_fee,
4220                         holding_cell_update_fee,
4221                         next_local_htlc_id,
4222                         next_remote_htlc_id,
4223                         update_time_counter,
4224                         feerate_per_kw,
4225
4226                         #[cfg(debug_assertions)]
4227                         max_commitment_tx_output_local: ::std::sync::Mutex::new((0, 0)),
4228                         #[cfg(debug_assertions)]
4229                         max_commitment_tx_output_remote: ::std::sync::Mutex::new((0, 0)),
4230
4231                         last_sent_closing_fee,
4232
4233                         funding_txo,
4234                         funding_tx_confirmed_in,
4235                         short_channel_id,
4236                         last_block_connected,
4237                         funding_tx_confirmations,
4238
4239                         their_dust_limit_satoshis,
4240                         our_dust_limit_satoshis,
4241                         their_max_htlc_value_in_flight_msat,
4242                         their_channel_reserve_satoshis,
4243                         their_htlc_minimum_msat,
4244                         our_htlc_minimum_msat,
4245                         their_to_self_delay,
4246                         our_to_self_delay,
4247                         their_max_accepted_htlcs,
4248                         minimum_depth,
4249
4250                         their_pubkeys,
4251                         their_cur_commitment_point,
4252
4253                         their_prev_commitment_point,
4254                         their_node_id,
4255
4256                         their_shutdown_scriptpubkey,
4257
4258                         channel_monitor: Some(channel_monitor),
4259                         commitment_secrets,
4260
4261                         network_sync: UpdateStatus::Fresh,
4262
4263                         logger,
4264                 })
4265         }
4266 }
4267
4268 #[cfg(test)]
4269 mod tests {
4270         use bitcoin::BitcoinHash;
4271         use bitcoin::util::bip143;
4272         use bitcoin::consensus::encode::serialize;
4273         use bitcoin::blockdata::script::{Script, Builder};
4274         use bitcoin::blockdata::transaction::{Transaction, TxOut};
4275         use bitcoin::blockdata::constants::genesis_block;
4276         use bitcoin::blockdata::opcodes;
4277         use bitcoin::network::constants::Network;
4278         use bitcoin_hashes::hex::FromHex;
4279         use hex;
4280         use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
4281         use ln::channel::{Channel,ChannelKeys,InboundHTLCOutput,OutboundHTLCOutput,InboundHTLCState,OutboundHTLCState,HTLCOutputInCommitment,TxCreationKeys};
4282         use ln::channel::MAX_FUNDING_SATOSHIS;
4283         use ln::features::InitFeatures;
4284         use ln::msgs::{OptionalField, DataLossProtect};
4285         use ln::chan_utils;
4286         use ln::chan_utils::{LocalCommitmentTransaction, ChannelPublicKeys};
4287         use chain::chaininterface::{FeeEstimator,ConfirmationTarget};
4288         use chain::keysinterface::{InMemoryChannelKeys, KeysInterface};
4289         use chain::transaction::OutPoint;
4290         use util::config::UserConfig;
4291         use util::enforcing_trait_impls::EnforcingChannelKeys;
4292         use util::test_utils;
4293         use util::logger::Logger;
4294         use secp256k1::{Secp256k1, Message, Signature, All};
4295         use secp256k1::key::{SecretKey,PublicKey};
4296         use bitcoin_hashes::sha256::Hash as Sha256;
4297         use bitcoin_hashes::sha256d::Hash as Sha256dHash;
4298         use bitcoin_hashes::hash160::Hash as Hash160;
4299         use bitcoin_hashes::Hash;
4300         use std::sync::Arc;
4301         use rand::{thread_rng,Rng};
4302
4303         struct TestFeeEstimator {
4304                 fee_est: u64
4305         }
4306         impl FeeEstimator for TestFeeEstimator {
4307                 fn get_est_sat_per_1000_weight(&self, _: ConfirmationTarget) -> u64 {
4308                         self.fee_est
4309                 }
4310         }
4311
4312         #[test]
4313         fn test_max_funding_satoshis() {
4314                 assert!(MAX_FUNDING_SATOSHIS <= 21_000_000 * 100_000_000,
4315                         "MAX_FUNDING_SATOSHIS is greater than all satoshis in existence");
4316         }
4317
4318         struct Keys {
4319                 chan_keys: InMemoryChannelKeys,
4320         }
4321         impl KeysInterface for Keys {
4322                 type ChanKeySigner = InMemoryChannelKeys;
4323
4324                 fn get_node_secret(&self) -> SecretKey { panic!(); }
4325                 fn get_destination_script(&self) -> Script {
4326                         let secp_ctx = Secp256k1::signing_only();
4327                         let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4328                         let our_channel_monitor_claim_key_hash = Hash160::hash(&PublicKey::from_secret_key(&secp_ctx, &channel_monitor_claim_key).serialize());
4329                         Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_monitor_claim_key_hash[..]).into_script()
4330                 }
4331
4332                 fn get_shutdown_pubkey(&self) -> PublicKey {
4333                         let secp_ctx = Secp256k1::signing_only();
4334                         let channel_close_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
4335                         PublicKey::from_secret_key(&secp_ctx, &channel_close_key)
4336                 }
4337
4338                 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> InMemoryChannelKeys {
4339                         self.chan_keys.clone()
4340                 }
4341                 fn get_onion_rand(&self) -> (SecretKey, [u8; 32]) { panic!(); }
4342                 fn get_channel_id(&self) -> [u8; 32] { [0; 32] }
4343         }
4344
4345         fn public_from_secret_hex(secp_ctx: &Secp256k1<All>, hex: &str) -> PublicKey {
4346                 PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&hex::decode(hex).unwrap()[..]).unwrap())
4347         }
4348
4349         #[test]
4350         fn channel_reestablish_no_updates() {
4351                 let feeest = TestFeeEstimator{fee_est: 15000};
4352                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4353                 let secp_ctx = Secp256k1::new();
4354                 let mut seed = [0; 32];
4355                 let mut rng = thread_rng();
4356                 rng.fill_bytes(&mut seed);
4357                 let network = Network::Testnet;
4358                 let keys_provider = test_utils::TestKeysInterface::new(&seed, network, logger.clone() as Arc<Logger>);
4359
4360                 // Go through the flow of opening a channel between two nodes.
4361
4362                 // Create Node A's channel
4363                 let node_a_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4364                 let config = UserConfig::default();
4365                 let mut node_a_chan = Channel::<EnforcingChannelKeys>::new_outbound(&&feeest, &&keys_provider, node_a_node_id, 10000000, 100000, 42, Arc::clone(&logger), &config).unwrap();
4366
4367                 // Create Node B's channel by receiving Node A's open_channel message
4368                 let open_channel_msg = node_a_chan.get_open_channel(genesis_block(network).header.bitcoin_hash(), &&feeest);
4369                 let node_b_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[7; 32]).unwrap());
4370                 let mut node_b_chan = Channel::<EnforcingChannelKeys>::new_from_req(&&feeest, &&keys_provider, node_b_node_id, InitFeatures::supported(), &open_channel_msg, 7, logger, &config).unwrap();
4371
4372                 // Node B --> Node A: accept channel
4373                 let accept_channel_msg = node_b_chan.get_accept_channel();
4374                 node_a_chan.accept_channel(&accept_channel_msg, &config, InitFeatures::supported()).unwrap();
4375
4376                 // Node A --> Node B: funding created
4377                 let output_script = node_a_chan.get_funding_redeemscript();
4378                 let tx = Transaction { version: 1, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4379                         value: 10000000, script_pubkey: output_script.clone(),
4380                 }]};
4381                 let funding_outpoint = OutPoint::new(tx.txid(), 0);
4382                 let funding_created_msg = node_a_chan.get_outbound_funding_created(funding_outpoint).unwrap();
4383                 let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg).unwrap();
4384
4385                 // Node B --> Node A: funding signed
4386                 let _ = node_a_chan.funding_signed(&funding_signed_msg);
4387
4388                 // Now disconnect the two nodes and check that the commitment point in
4389                 // Node B's channel_reestablish message is sane.
4390                 node_b_chan.remove_uncommitted_htlcs_and_mark_paused();
4391                 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));
4392                 let msg = node_b_chan.get_channel_reestablish();
4393                 match msg.data_loss_protect {
4394                         OptionalField::Present(DataLossProtect { my_current_per_commitment_point, .. }) => {
4395                                 assert_eq!(expected_commitment_point, my_current_per_commitment_point);
4396                         },
4397                         _ => panic!()
4398                 }
4399
4400                 // Check that the commitment point in Node A's channel_reestablish message
4401                 // is sane.
4402                 node_a_chan.remove_uncommitted_htlcs_and_mark_paused();
4403                 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));
4404                 let msg = node_a_chan.get_channel_reestablish();
4405                 match msg.data_loss_protect {
4406                         OptionalField::Present(DataLossProtect { my_current_per_commitment_point, .. }) => {
4407                                 assert_eq!(expected_commitment_point, my_current_per_commitment_point);
4408                         },
4409                         _ => panic!()
4410                 }
4411         }
4412
4413         #[test]
4414         fn outbound_commitment_test() {
4415                 // Test vectors from BOLT 3 Appendix C:
4416                 let feeest = TestFeeEstimator{fee_est: 15000};
4417                 let logger : Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4418                 let secp_ctx = Secp256k1::new();
4419
4420                 let mut chan_keys = InMemoryChannelKeys::new(
4421                         &secp_ctx,
4422                         SecretKey::from_slice(&hex::decode("30ff4956bbdd3222d44cc5e8a1261dab1e07957bdac5ae88fe3261ef321f3749").unwrap()[..]).unwrap(),
4423                         SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap(),
4424                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4425                         SecretKey::from_slice(&hex::decode("3333333333333333333333333333333333333333333333333333333333333333").unwrap()[..]).unwrap(),
4426                         SecretKey::from_slice(&hex::decode("1111111111111111111111111111111111111111111111111111111111111111").unwrap()[..]).unwrap(),
4427
4428                         // These aren't set in the test vectors:
4429                         [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],
4430                         10_000_000,
4431                 );
4432
4433                 assert_eq!(PublicKey::from_secret_key(&secp_ctx, chan_keys.funding_key()).serialize()[..],
4434                                 hex::decode("023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb").unwrap()[..]);
4435                 let keys_provider = Keys { chan_keys: chan_keys.clone() };
4436
4437                 let their_node_id = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
4438                 let mut config = UserConfig::default();
4439                 config.channel_options.announced_channel = false;
4440                 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
4441                 chan.their_to_self_delay = 144;
4442                 chan.our_dust_limit_satoshis = 546;
4443
4444                 let funding_info = OutPoint::new(Sha256dHash::from_hex("8984484a580b825b9972d7adb15050b3ab624ccd731946b3eeddb92f4e7ef6be").unwrap(), 0);
4445                 chan.funding_txo = Some(funding_info);
4446
4447                 let their_pubkeys = ChannelPublicKeys {
4448                         funding_pubkey: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4449                         revocation_basepoint: PublicKey::from_slice(&hex::decode("02466d7fcae563e5cb09a0d1870bb580344804617879a14949cf22285f1bae3f27").unwrap()[..]).unwrap(),
4450                         payment_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444"),
4451                         delayed_payment_basepoint: public_from_secret_hex(&secp_ctx, "1552dfba4f6cf29a62a0af13c8d6981d36d0ef8d61ba10fb0fe90da7634d7e13"),
4452                         htlc_basepoint: public_from_secret_hex(&secp_ctx, "4444444444444444444444444444444444444444444444444444444444444444")
4453                 };
4454                 chan_keys.set_remote_channel_pubkeys(&their_pubkeys);
4455
4456                 assert_eq!(their_pubkeys.payment_basepoint.serialize()[..],
4457                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4458
4459                 assert_eq!(their_pubkeys.funding_pubkey.serialize()[..],
4460                            hex::decode("030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c1").unwrap()[..]);
4461
4462                 assert_eq!(their_pubkeys.htlc_basepoint.serialize()[..],
4463                            hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]);
4464
4465                 // We can't just use build_local_transaction_keys here as the per_commitment_secret is not
4466                 // derived from a commitment_seed, so instead we copy it here and call
4467                 // build_commitment_transaction.
4468                 let delayed_payment_base = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.delayed_payment_base_key());
4469                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4470                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4471                 let htlc_basepoint = PublicKey::from_secret_key(&secp_ctx, chan.local_keys.htlc_base_key());
4472                 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();
4473
4474                 chan.their_pubkeys = Some(their_pubkeys);
4475
4476                 let mut unsigned_tx: (Transaction, Vec<HTLCOutputInCommitment>);
4477
4478                 let mut localtx;
4479                 macro_rules! test_commitment {
4480                         ( $their_sig_hex: expr, $our_sig_hex: expr, $tx_hex: expr, {
4481                                 $( { $htlc_idx: expr, $their_htlc_sig_hex: expr, $our_htlc_sig_hex: expr, $htlc_tx_hex: expr } ), *
4482                         } ) => {
4483                                 unsigned_tx = {
4484                                         let mut res = chan.build_commitment_transaction(0xffffffffffff - 42, &keys, true, false, chan.feerate_per_kw);
4485                                         let htlcs = res.2.drain(..)
4486                                                 .filter_map(|(htlc, _)| if htlc.transaction_output_index.is_some() { Some(htlc) } else { None })
4487                                                 .collect();
4488                                         (res.0, htlcs)
4489                                 };
4490                                 let redeemscript = chan.get_funding_redeemscript();
4491                                 let their_signature = Signature::from_der(&hex::decode($their_sig_hex).unwrap()[..]).unwrap();
4492                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&unsigned_tx.0).sighash_all(&unsigned_tx.0.input[0], &redeemscript, chan.channel_value_satoshis)[..]).unwrap();
4493                                 secp_ctx.verify(&sighash, &their_signature, chan.their_funding_pubkey()).unwrap();
4494
4495                                 let mut per_htlc = Vec::new();
4496                                 per_htlc.clear(); // Don't warn about excess mut for no-HTLC calls
4497                                 $({
4498                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4499                                         per_htlc.push((unsigned_tx.1[$htlc_idx].clone(), Some(remote_signature)));
4500                                 })*
4501                                 assert_eq!(unsigned_tx.1.len(), per_htlc.len());
4502
4503                                 localtx = LocalCommitmentTransaction::new_missing_local_sig(unsigned_tx.0.clone(), &their_signature, &PublicKey::from_secret_key(&secp_ctx, chan.local_keys.funding_key()), chan.their_funding_pubkey(), keys.clone(), chan.feerate_per_kw, per_htlc);
4504                                 chan_keys.sign_local_commitment(&mut localtx, &chan.secp_ctx);
4505
4506                                 assert_eq!(serialize(localtx.with_valid_witness())[..],
4507                                                 hex::decode($tx_hex).unwrap()[..]);
4508
4509                                 $({
4510                                         let remote_signature = Signature::from_der(&hex::decode($their_htlc_sig_hex).unwrap()[..]).unwrap();
4511
4512                                         let ref htlc = unsigned_tx.1[$htlc_idx];
4513                                         let htlc_tx = chan.build_htlc_transaction(&unsigned_tx.0.txid(), &htlc, true, &keys, chan.feerate_per_kw);
4514                                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, &keys);
4515                                         let htlc_sighash = Message::from_slice(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, htlc.amount_msat / 1000)[..]).unwrap();
4516                                         secp_ctx.verify(&htlc_sighash, &remote_signature, &keys.b_htlc_key).unwrap();
4517
4518                                         let mut preimage: Option<PaymentPreimage> = None;
4519                                         if !htlc.offered {
4520                                                 for i in 0..5 {
4521                                                         let out = PaymentHash(Sha256::hash(&[i; 32]).into_inner());
4522                                                         if out == htlc.payment_hash {
4523                                                                 preimage = Some(PaymentPreimage([i; 32]));
4524                                                         }
4525                                                 }
4526
4527                                                 assert!(preimage.is_some());
4528                                         }
4529
4530                                         chan_keys.sign_htlc_transaction(&mut localtx, $htlc_idx, preimage, chan.their_to_self_delay, &chan.secp_ctx);
4531
4532                                         assert_eq!(serialize(localtx.htlc_with_valid_witness($htlc_idx).as_ref().unwrap())[..],
4533                                                         hex::decode($htlc_tx_hex).unwrap()[..]);
4534                                 })*
4535                         }
4536                 }
4537
4538                 {
4539                         // simple commitment tx with no HTLCs
4540                         chan.value_to_self_msat = 7000000000;
4541
4542                         test_commitment!("3045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c0",
4543                                          "3044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c3836939",
4544                                          "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311054a56a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022051b75c73198c6deee1a875871c3961832909acd297c6b908d59e3319e5185a46022055c419379c5051a78d00dbbce11b5b664a0c22815fbcc6fcef6b1937c383693901483045022100f51d2e566a70ba740fc5d8c0f07b9b93d2ed741c3c0860c613173de7d39e7968022041376d520e9c0e1ad52248ddf4b22e12be8763007df977253ef45a4ca3bdb7c001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4545                 }
4546
4547                 chan.pending_inbound_htlcs.push({
4548                         let mut out = InboundHTLCOutput{
4549                                 htlc_id: 0,
4550                                 amount_msat: 1000000,
4551                                 cltv_expiry: 500,
4552                                 payment_hash: PaymentHash([0; 32]),
4553                                 state: InboundHTLCState::Committed,
4554                         };
4555                         out.payment_hash.0 = Sha256::hash(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap()).into_inner();
4556                         out
4557                 });
4558                 chan.pending_inbound_htlcs.push({
4559                         let mut out = InboundHTLCOutput{
4560                                 htlc_id: 1,
4561                                 amount_msat: 2000000,
4562                                 cltv_expiry: 501,
4563                                 payment_hash: PaymentHash([0; 32]),
4564                                 state: InboundHTLCState::Committed,
4565                         };
4566                         out.payment_hash.0 = Sha256::hash(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()).into_inner();
4567                         out
4568                 });
4569                 chan.pending_outbound_htlcs.push({
4570                         let mut out = OutboundHTLCOutput{
4571                                 htlc_id: 2,
4572                                 amount_msat: 2000000,
4573                                 cltv_expiry: 502,
4574                                 payment_hash: PaymentHash([0; 32]),
4575                                 state: OutboundHTLCState::Committed,
4576                                 source: HTLCSource::dummy(),
4577                         };
4578                         out.payment_hash.0 = Sha256::hash(&hex::decode("0202020202020202020202020202020202020202020202020202020202020202").unwrap()).into_inner();
4579                         out
4580                 });
4581                 chan.pending_outbound_htlcs.push({
4582                         let mut out = OutboundHTLCOutput{
4583                                 htlc_id: 3,
4584                                 amount_msat: 3000000,
4585                                 cltv_expiry: 503,
4586                                 payment_hash: PaymentHash([0; 32]),
4587                                 state: OutboundHTLCState::Committed,
4588                                 source: HTLCSource::dummy(),
4589                         };
4590                         out.payment_hash.0 = Sha256::hash(&hex::decode("0303030303030303030303030303030303030303030303030303030303030303").unwrap()).into_inner();
4591                         out
4592                 });
4593                 chan.pending_inbound_htlcs.push({
4594                         let mut out = InboundHTLCOutput{
4595                                 htlc_id: 4,
4596                                 amount_msat: 4000000,
4597                                 cltv_expiry: 504,
4598                                 payment_hash: PaymentHash([0; 32]),
4599                                 state: InboundHTLCState::Committed,
4600                         };
4601                         out.payment_hash.0 = Sha256::hash(&hex::decode("0404040404040404040404040404040404040404040404040404040404040404").unwrap()).into_inner();
4602                         out
4603                 });
4604
4605                 // commitment tx with all five HTLCs untrimmed (minimum feerate)
4606                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4607                 chan.feerate_per_kw = 0;
4608
4609                 test_commitment!("304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b70606",
4610                                  "30440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f06",
4611                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e0a06a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220275b0c325a5e9355650dc30c0eccfbc7efb23987c24b556b9dfdd40effca18d202206caceb2c067836c51f296740c7ae807ffcbfbf1dd3a0d56b6de9a5b247985f060147304402204fd4928835db1ccdfc40f5c78ce9bd65249b16348df81f0c44328dcdefc97d630220194d3869c38bc732dd87d13d2958015e2fc16829e74cd4377f84d215c0b7060601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4612
4613                                   { 0,
4614                                   "304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a6",
4615                                   "304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5",
4616                                   "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219700000000000000000001e8030000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a6e59f18764a5bf8d4fa45eebc591566689441229c918b480fb2af8cc6a4aeb02205248f273be447684b33e3c8d1d85a8e0ca9fa0bae9ae33f0527ada9c162919a60147304402207cb324fa0de88f452ffa9389678127ebcf4cabe1dd848b8e076c1a1962bf34720220116ed922b12311bd602d67e60d2529917f21c5b82f25ff6506c0f87886b4dfd5012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000"},
4617
4618                                   { 1,
4619                                   "3045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b",
4620                                   "3045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be5",
4621                                   "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219701000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d5275b3619953cb0c3b5aa577f04bc512380e60fa551762ce3d7a1bb7401cff9022037237ab0dac3fe100cde094e82e2bed9ba0ed1bb40154b48e56aa70f259e608b01483045022100c89172099507ff50f4c925e6c5150e871fb6e83dd73ff9fbb72f6ce829a9633f02203a63821d9162e99f9be712a68f9e589483994feae2661e4546cd5b6cec007be501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4622
4623                                   { 2,
4624                                   "304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f202",
4625                                   "3045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da",
4626                                   "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219702000000000000000001d0070000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402201b63ec807771baf4fdff523c644080de17f1da478989308ad13a58b51db91d360220568939d38c9ce295adba15665fa68f51d967e8ed14a007b751540a80b325f20201483045022100def389deab09cee69eaa1ec14d9428770e45bcbe9feb46468ecf481371165c2f022015d2e3c46600b2ebba8dcc899768874cc6851fd1ecb3fffd15db1cc3de7e10da012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000"},
4627
4628                                   { 3,
4629                                   "3045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554",
4630                                   "30440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac08727",
4631                                   "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219703000000000000000001b80b0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100daee1808f9861b6c3ecd14f7b707eca02dd6bdfc714ba2f33bc8cdba507bb182022026654bf8863af77d74f51f4e0b62d461a019561bb12acb120d3f7195d148a554014730440220643aacb19bbb72bd2b635bc3f7375481f5981bace78cdd8319b2988ffcc6704202203d27784ec8ad51ed3bd517a05525a5139bb0b755dd719e0054332d186ac0872701008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4632
4633                                  { 4,
4634                                   "304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d",
4635                                   "30440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e",
4636                                   "020000000001018154ecccf11a5fb56c39654c4deb4d2296f83c69268280b94d021370c94e219704000000000000000001a00f0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207e0410e45454b0978a623f36a10626ef17b27d9ad44e2760f98cfa3efb37924f0220220bd8acd43ecaa916a80bd4f919c495a2c58982ce7c8625153f8596692a801d014730440220549e80b4496803cbc4a1d09d46df50109f546d43fbbf86cd90b174b1484acd5402205f12a4f995cb9bded597eabfee195a285986aa6d93ae5bb72507ebc6a4e2349e012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4637                 } );
4638
4639                 // commitment tx with seven outputs untrimmed (maximum feerate)
4640                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4641                 chan.feerate_per_kw = 647;
4642
4643                 test_commitment!("3045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b",
4644                                  "304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d1163",
4645                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8007e80300000000000022002052bfef0479d7b293c27e0f1eb294bea154c63a3294ef092c19af51409bce0e2ad007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110e09c6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040048304502210094bfd8f5572ac0157ec76a9551b6c5216a4538c07cd13a51af4a54cb26fa14320220768efce8ce6f4a5efac875142ff19237c011343670adf9c7ac69704a120d116301483045022100a5c01383d3ec646d97e40f44318d49def817fcd61a0ef18008a665b3e151785502203e648efddd5838981ef55ec954be69c4a652d021e6081a100d034de366815e9b01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4646
4647                                  { 0,
4648                                   "30440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab343740",
4649                                   "304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a",
4650                                   "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220385a5afe75632f50128cbb029ee95c80156b5b4744beddc729ad339c9ca432c802202ba5f48550cad3379ac75b9b4fedb86a35baa6947f16ba5037fb8b11ab3437400147304402205999590b8a79fa346e003a68fd40366397119b2b0cdf37b149968d6bc6fbcc4702202b1e1fb5ab7864931caed4e732c359e0fe3d86a548b557be2246efb1708d579a012000000000000000000000000000000000000000000000000000000000000000008a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a914b8bcb07f6344b42ab04250c86a6e8b75d3fdbbc688527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f401b175ac686800000000"},
4651
4652                                  { 1,
4653                                   "304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b0",
4654                                   "304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac",
4655                                   "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb60100000000000000000124060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402207ceb6678d4db33d2401fdc409959e57c16a6cb97a30261d9c61f29b8c58d34b90220084b4a17b4ca0e86f2d798b3698ca52de5621f2ce86f80bed79afa66874511b00147304402207ff03eb0127fc7c6cae49cc29e2a586b98d1e8969cf4a17dfa50b9c2647720b902205e2ecfda2252956c0ca32f175080e75e4e390e433feb1f8ce9f2ba55648a1dac01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4656
4657                                  { 2,
4658                                   "304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d833",
4659                                   "3045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877",
4660                                   "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6020000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e050047304402206a401b29a0dff0d18ec903502c13d83e7ec019450113f4a7655a4ce40d1f65ba0220217723a084e727b6ca0cc8b6c69c014a7e4a01fcdcba3e3993f462a3c574d83301483045022100d50d067ca625d54e62df533a8f9291736678d0b86c28a61bb2a80cf42e702d6e02202373dde7e00218eacdafb9415fe0e1071beec1857d1af3c6a201a44cbc47c877012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000"},
4661
4662                                  { 3,
4663                                   "30450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d",
4664                                   "3045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb",
4665                                   "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb6030000000000000000010c0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009b1c987ba599ee3bde1dbca776b85481d70a78b681a8d84206723e2795c7cac002207aac84ad910f8598c4d1c0ea2e3399cf6627a4e3e90131315bc9f038451ce39d01483045022100db9dc65291077a52728c622987e9895b7241d4394d6dcb916d7600a3e8728c22022036ee3ee717ba0bb5c45ee84bc7bbf85c0f90f26ae4e4a25a6b4241afa8a3f1cb01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4666
4667                                  { 4,
4668                                   "3045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f0",
4669                                   "304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f",
4670                                   "020000000001018323148ce2419f21ca3d6780053747715832e18ac780931a514b187768882bb604000000000000000001da0d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100cc28030b59f0914f45b84caa983b6f8effa900c952310708c2b5b00781117022022027ba2ccdf94d03c6d48b327f183f6e28c8a214d089b9227f94ac4f85315274f00147304402202d1a3c0d31200265d2a2def2753ead4959ae20b4083e19553acfffa5dfab60bf022020ede134149504e15b88ab261a066de49848411e15e70f9e6a5462aec2949f8f012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4671                 });
4672
4673                 // commitment tx with six outputs untrimmed (minimum feerate)
4674                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4675                 chan.feerate_per_kw = 648;
4676
4677                 test_commitment!("3044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b057",
4678                                  "3045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de",
4679                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431104e9d6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a2270d5950c89ae0841233f6efea9c951898b301b2e89e0adbd2c687b9f32efa02207943d90f95b9610458e7c65a576e149750ff3accaacad004cd85e70b235e27de01473044022072714e2fbb93cdd1c42eb0828b4f2eff143f717d8f26e79d6ada4f0dcb681bbe02200911be4e5161dd6ebe59ff1c58e1997c4aea804f81db6b698821db6093d7b05701475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4680
4681                                  { 0,
4682                                   "3044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada8",
4683                                   "3045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc098",
4684                                   "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10000000000000000000123060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022062ef2e77591409d60d7817d9bb1e71d3c4a2931d1a6c7c8307422c84f001a251022022dad9726b0ae3fe92bda745a06f2c00f92342a186d84518588cf65f4dfaada801483045022100a4c574f00411dd2f978ca5cdc1b848c311cd7849c087ad2f21a5bce5e8cc5ae90220090ae39a9bce2fb8bc879d7e9f9022df249f41e25e51f1a9bf6447a9eeffc09801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4685
4686                                  { 1,
4687                                   "3045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d4",
4688                                   "304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0",
4689                                   "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd10100000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e968cbbb5f402ed389fdc7f6cd2a80ed650bb42c79aeb2a5678444af94f6c78502204b47a1cb24ab5b0b6fe69fe9cfc7dba07b9dd0d8b95f372c1d9435146a88f8d40147304402207679cf19790bea76a733d2fa0672bd43ab455687a068f815a3d237581f57139a0220683a1a799e102071c206b207735ca80f627ab83d6616b4bcd017c5d79ef3e7d0012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000"},
4690
4691                                  { 2,
4692                                   "3045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c2",
4693                                   "304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda3",
4694                                   "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd1020000000000000000010b0a0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100aa91932e305292cf9969cc23502bbf6cef83a5df39c95ad04a707c4f4fed5c7702207099fc0f3a9bfe1e7683c0e9aa5e76c5432eb20693bf4cb182f04d383dc9c8c20147304402200df76fea718745f3c529bac7fd37923e7309ce38b25c0781e4cf514dd9ef8dc802204172295739dbae9fe0474dcee3608e3433b4b2af3a2e6787108b02f894dcdda301008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4695
4696                                  { 3,
4697                                   "3044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f",
4698                                   "304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6",
4699                                   "02000000000101579c183eca9e8236a5d7f5dcd79cfec32c497fdc0ec61533cde99ecd436cadd103000000000000000001d90d0000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022035cac88040a5bba420b1c4257235d5015309113460bc33f2853cd81ca36e632402202fc94fd3e81e9d34a9d01782a0284f3044370d03d60f3fc041e2da088d2de58f0147304402200daf2eb7afd355b4caf6fb08387b5f031940ea29d1a9f35071288a839c9039e4022067201b562456e7948616c13acb876b386b511599b58ac1d94d127f91c50463a6012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4700                 });
4701
4702                 // commitment tx with six outputs untrimmed (maximum feerate)
4703                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4704                 chan.feerate_per_kw = 2069;
4705
4706                 test_commitment!("3044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb4",
4707                                  "304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea",
4708                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8006d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5d007000000000000220020748eba944fedc8827f6b06bc44678f93c0f9e6078b35c6331ed31e75f8ce0c2db80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311077956a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203ca8f31c6a47519f83255dc69f1894d9a6d7476a19f498d31eaf0cd3a85eeb63022026fd92dc752b33905c4c838c528b692a8ad4ced959990b5d5ee2ff940fa90eea01473044022001d55e488b8b035b2dd29d50b65b530923a416d47f377284145bc8767b1b6a75022019bb53ddfe1cefaf156f924777eaaf8fdca1810695a7d0a247ad2afba8232eb401475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4709
4710                                  { 0,
4711                                   "3045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f992",
4712                                   "3044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae66402",
4713                                   "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0000000000000000000175020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d1cf354de41c1369336cf85b225ed033f1f8982a01be503668df756a7e668b66022001254144fb4d0eecc61908fccc3388891ba17c5d7a1a8c62bdd307e5a513f99201473044022056eb1af429660e45a1b0b66568cb8c4a3aa7e4c9c292d5d6c47f86ebf2c8838f022065c3ac4ebe980ca7a41148569be4ad8751b0a724a41405697ec55035dae6640201008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4714
4715                                  { 1,
4716                                   "3045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f4",
4717                                   "3045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f",
4718                                   "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a0100000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d065569dcb94f090345402736385efeb8ea265131804beac06dd84d15dd2d6880220664feb0b4b2eb985fadb6ec7dc58c9334ea88ce599a9be760554a2d4b3b5d9f401483045022100914bb232cd4b2690ee3d6cb8c3713c4ac9c4fb925323068d8b07f67c8541f8d9022057152f5f1615b793d2d45aac7518989ae4fe970f28b9b5c77504799d25433f7f012001010101010101010101010101010101010101010101010101010101010101018a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a9144b6b2e5444c2639cc0fb7bcea5afba3f3cdce23988527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f501b175ac686800000000"},
4719
4720                                  { 2,
4721                                   "3045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef18",
4722                                   "304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f9",
4723                                   "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a020000000000000000015d060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100d4e69d363de993684eae7b37853c40722a4c1b4a7b588ad7b5d8a9b5006137a102207a069c628170ee34be5612747051bdcc087466dbaa68d5756ea81c10155aef180147304402200e362443f7af830b419771e8e1614fc391db3a4eb799989abfc5ab26d6fcd032022039ab0cad1c14dfbe9446bf847965e56fe016e0cbcf719fd18c1bfbf53ecbd9f901008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4724
4725                                  { 3,
4726                                   "30450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c",
4727                                   "304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5",
4728                                   "02000000000101ca94a9ad516ebc0c4bdd7b6254871babfa978d5accafb554214137d398bfcf6a03000000000000000001f2090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221008ec888e36e4a4b3dc2ed6b823319855b2ae03006ca6ae0d9aa7e24bfc1d6f07102203b0f78885472a67ff4fe5916c0bb669487d659527509516fc3a08e87a2cc0a7c0147304402202c3e14282b84b02705dfd00a6da396c9fe8a8bcb1d3fdb4b20a4feba09440e8b02202b058b39aa9b0c865b22095edcd9ff1f71bbfe20aa4993755e54d042755ed0d5012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000" }
4729                 });
4730
4731                 // commitment tx with five outputs untrimmed (minimum feerate)
4732                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4733                 chan.feerate_per_kw = 2070;
4734
4735                 test_commitment!("3045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f37526",
4736                                  "30440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd0",
4737                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110da966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e04004730440220443cb07f650aebbba14b8bc8d81e096712590f524c5991ac0ed3bbc8fd3bd0c7022028a635f548e3ca64b19b69b1ea00f05b22752f91daf0b6dab78e62ba52eb7fd001483045022100f2377f7a67b7fc7f4e2c0c9e3a7de935c32417f5668eda31ea1db401b7dc53030220415fdbc8e91d0f735e70c21952342742e25249b0d062d43efbfc564499f3752601475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4738
4739                                  { 0,
4740                                   "3045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f891",
4741                                   "3045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb8",
4742                                   "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a2180000000000000000000174020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100eed143b1ee4bed5dc3cde40afa5db3e7354cbf9c44054b5f713f729356f08cf7022077161d171c2bbd9badf3c9934de65a4918de03bbac1450f715275f75b103f89101483045022100a0d043ed533e7fb1911e0553d31a8e2f3e6de19dbc035257f29d747c5e02f1f5022030cd38d8e84282175d49c1ebe0470db3ebd59768cf40780a784e248a43904fb801008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4743
4744                                  { 1,
4745                                   "3044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf6",
4746                                   "3045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d",
4747                                   "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a218010000000000000000015c060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022071e9357619fd8d29a411dc053b326a5224c5d11268070e88ecb981b174747c7a02202b763ae29a9d0732fa8836dd8597439460b50472183f420021b768981b4f7cf601483045022100adb1d679f65f96178b59f23ed37d3b70443118f345224a07ecb043eee2acc157022034d24524fe857144a3bcfff3065a9994d0a6ec5f11c681e49431d573e242612d01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4748
4749                                  { 2,
4750                                   "3045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a4",
4751                                   "304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04",
4752                                   "0200000000010140a83ce364747ff277f4d7595d8d15f708418798922c40bc2b056aca5485a21802000000000000000001f1090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100c9458a4d2cbb741705577deb0a890e5cb90ee141be0400d3162e533727c9cb2102206edcf765c5dc5e5f9b976ea8149bf8607b5a0efb30691138e1231302b640d2a40147304402200831422aa4e1ee6d55e0b894201770a8f8817a189356f2d70be76633ffa6a6f602200dd1b84a4855dc6727dd46c98daae43dfc70889d1ba7ef0087529a57c06e5e04012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4753                 });
4754
4755                 // commitment tx with five outputs untrimmed (maximum feerate)
4756                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4757                 chan.feerate_per_kw = 2194;
4758
4759                 test_commitment!("3045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec86203953348",
4760                                  "304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f7061",
4761                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8005d007000000000000220020403d394747cae42e98ff01734ad5c08f82ba123d3d9a620abda88989651e2ab5b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311040966a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b1b010c109c2ecbe7feb2d259b9c4126bd5dc99ee693c422ec0a5781fe161ba0220571fe4e2c649dea9c7aaf7e49b382962f6a3494963c97d80fef9a430ca3f706101483045022100d33c4e541aa1d255d41ea9a3b443b3b822ad8f7f86862638aac1f69f8f760577022007e2a18e6931ce3d3a804b1c78eda1de17dbe1fb7a95488c9a4ec8620395334801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4762
4763                                  { 0,
4764                                   "30450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf44",
4765                                   "3044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f",
4766                                   "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004830450221009ed2f0a67f99e29c3c8cf45c08207b765980697781bb727fe0b1416de0e7622902206052684229bc171419ed290f4b615c943f819c0262414e43c5b91dcf72ddcf4401473044022004ad5f04ae69c71b3b141d4db9d0d4c38d84009fb3cfeeae6efdad414487a9a0022042d3fe1388c1ff517d1da7fb4025663d372c14728ed52dc88608363450ff6a2f01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a914b43e1b38138a41b37f7cd9a1d274bc63e3a9b5d188ac6868f6010000"},
4767
4768                                  { 1,
4769                                   "30440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d",
4770                                   "304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c915",
4771                                   "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a010000000000000000010a060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e05004730440220155d3b90c67c33a8321996a9be5b82431b0c126613be751d400669da9d5c696702204318448bcd48824439d2c6a70be6e5747446be47ff45977cf41672bdc9b6b12d0147304402201707050c870c1f77cc3ed58d6d71bf281de239e9eabd8ef0955bad0d7fe38dcc02204d36d80d0019b3a71e646a08fa4a5607761d341ae8be371946ebe437c289c91501008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4772
4773                                  { 2,
4774                                   "3045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a",
4775                                   "3045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0",
4776                                   "02000000000101fb824d4e4dafc0f567789dee3a6bce8d411fe80f5563d8cdfdcc7d7e4447d43a020000000000000000019a090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a12a9a473ece548584aabdd051779025a5ed4077c4b7aa376ec7a0b1645e5a48022039490b333f53b5b3e2ddde1d809e492cba2b3e5fc3a436cd3ffb4cd3d500fa5a01483045022100ff200bc934ab26ce9a559e998ceb0aee53bc40368e114ab9d3054d9960546e2802202496856ca163ac12c143110b6b3ac9d598df7254f2e17b3b94c3ab5301f4c3b0012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4777                 });
4778
4779                 // commitment tx with four outputs untrimmed (minimum feerate)
4780                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4781                 chan.feerate_per_kw = 2195;
4782
4783                 test_commitment!("304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb7924298",
4784                                  "304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a5429",
4785                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110b8976a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402203b12d44254244b8ff3bb4129b0920fd45120ab42f553d9976394b099d500c99e02205e95bb7a3164852ef0c48f9e0eaf145218f8e2c41251b231f03cbdc4f29a54290147304402205e2f76d4657fb732c0dfc820a18a7301e368f5799e06b7828007633741bda6df0220458009ae59d0c6246065c419359e05eb2a4b4ef4a1b310cc912db44eb792429801475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4786
4787                                  { 0,
4788                                   "3045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc",
4789                                   "3045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc704390",
4790                                   "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0000000000000000000109060000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100a8a78fa1016a5c5c3704f2e8908715a3cef66723fb95f3132ec4d2d05cd84fb4022025ac49287b0861ec21932405f5600cbce94313dbde0e6c5d5af1b3366d8afbfc01483045022100be6ae1977fd7b630a53623f3f25c542317ccfc2b971782802a4f1ef538eb22b402207edc4d0408f8f38fd3c7365d1cfc26511b7cd2d4fecd8b005fba3cd5bc70439001008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4791
4792                                  { 1,
4793                                   "3045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92",
4794                                   "30440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8",
4795                                   "020000000001014e16c488fa158431c1a82e8f661240ec0a71ba0ce92f2721a6538c510226ad5c0100000000000000000199090000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100e769cb156aa2f7515d126cef7a69968629620ce82afcaa9e210969de6850df4602200b16b3f3486a229a48aadde520dbee31ae340dbadaffae74fbb56681fef27b92014730440220665b9cb4a978c09d1ca8977a534999bc8a49da624d0c5439451dd69cde1a003d022070eae0620f01f3c1bd029cc1488da13fb40fdab76f396ccd335479a11c5276d8012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4796                 });
4797
4798                 // commitment tx with four outputs untrimmed (maximum feerate)
4799                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4800                 chan.feerate_per_kw = 3702;
4801
4802                 test_commitment!("3045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c1",
4803                                  "304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b0",
4804                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8004b80b000000000000220020c20b5d1f8584fd90443e7b7b720136174fa4b9333c261d04dbbd012635c0f419a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431106f916a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402200e930a43c7951162dc15a2b7344f48091c74c70f7024e7116e900d8bcfba861c022066fa6cbda3929e21daa2e7e16a4b948db7e8919ef978402360d1095ffdaff7b001483045022100c1a3b0b60ca092ed5080121f26a74a20cec6bdee3f8e47bae973fcdceb3eda5502207d467a9873c939bf3aa758014ae67295fedbca52412633f7e5b2670fc7c381c101475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4805
4806                                  { 0,
4807                                   "3045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb",
4808                                   "304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a",
4809                                   "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100dfb73b4fe961b31a859b2bb1f4f15cabab9265016dd0272323dc6a9e85885c54022059a7b87c02861ee70662907f25ce11597d7b68d3399443a831ae40e777b76bdb0147304402202765b9c9ece4f127fa5407faf66da4c5ce2719cdbe47cd3175fc7d48b482e43d02205605125925e07bad1e41c618a4b434d72c88a164981c4b8af5eaf4ee9142ec3a01008576a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c820120876475527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae67a9148a486ff2e31d6158bf39e2608864d63fefd09d5b88ac6868f7010000"},
4810
4811                                  { 1,
4812                                   "3045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9",
4813                                   "30440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c",
4814                                   "02000000000101b8de11eb51c22498fe39722c7227b6e55ff1a94146cf638458cb9bc6a060d3a30100000000000000000176050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100ea9dc2a7c3c3640334dab733bb4e036e32a3106dc707b24227874fa4f7da746802204d672f7ac0fe765931a8df10b81e53a3242dd32bd9dc9331eb4a596da87954e9014730440220048a41c660c4841693de037d00a407810389f4574b3286afb7bc392a438fa3f802200401d71fa87c64fe621b49ac07e3bf85157ac680acb977124da28652cc7f1a5c012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4815                 });
4816
4817                 // commitment tx with three outputs untrimmed (minimum feerate)
4818                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4819                 chan.feerate_per_kw = 3703;
4820
4821                 test_commitment!("30450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb0",
4822                                  "3044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506",
4823                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110eb936a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400473044022047305531dd44391dce03ae20f8735005c615eb077a974edb0059ea1a311857d602202e0ed6972fbdd1e8cb542b06e0929bc41b2ddf236e04cb75edd56151f4197506014830450221008b7c191dd46893b67b628e618d2dc8e81169d38bade310181ab77d7c94c6675e02203b4dd131fd7c9deb299560983dcdc485545c98f989f7ae8180c28289f9e6bdb001475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4824
4825                                  { 0,
4826                                   "3044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd",
4827                                   "3045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724",
4828                                   "020000000001011c076aa7fb3d7460d10df69432c904227ea84bbf3134d4ceee5fb0f135ef206d0000000000000000000175050000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500473044022044f65cf833afdcb9d18795ca93f7230005777662539815b8a601eeb3e57129a902206a4bf3e53392affbba52640627defa8dc8af61c958c9e827b2798ab45828abdd01483045022100b94d931a811b32eeb885c28ddcf999ae1981893b21dd1329929543fe87ce793002206370107fdd151c5f2384f9ceb71b3107c69c74c8ed5a28a94a4ab2d27d3b0724012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4829                 });
4830
4831                 // commitment tx with three outputs untrimmed (maximum feerate)
4832                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4833                 chan.feerate_per_kw = 4914;
4834
4835                 test_commitment!("304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e",
4836                                  "304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe26",
4837                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {
4838
4839                                  { 0,
4840                                   "3045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf",
4841                                   "304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68",
4842                                   "0200000000010110a3fdcbcd5db477cd3ad465e7f501ffa8c437e8301f00a6061138590add757f0000000000000000000122020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0500483045022100fcb38506bfa11c02874092a843d0cc0a8613c23b639832564a5f69020cb0f6ba02206508b9e91eaa001425c190c68ee5f887e1ad5b1b314002e74db9dbd9e42dbecf0148304502210086e76b460ddd3cea10525fba298405d3fe11383e56966a5091811368362f689a02200f72ee75657915e0ede89c28709acd113ede9e1b7be520e3bc5cda425ecd6e68012004040404040404040404040404040404040404040404040404040404040404048a76a91414011f7254d96b819c76986c277d115efce6f7b58763ac67210394854aa6eab5b2a8122cc726e9dded053a2184d88256816826d6231c068d4a5b7c8201208763a91418bc1a114ccf9c052d3d23e28d3b0a9d1227434288527c21030d417a46946384f88d5f3337267c5e579765875dc4daca813e21734b140639e752ae677502f801b175ac686800000000"}
4843                 });
4844
4845                 // commitment tx with two outputs untrimmed (minimum feerate)
4846                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4847                 chan.feerate_per_kw = 4915;
4848
4849                 test_commitment!("304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f8765552",
4850                                  "3045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b9",
4851                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8002c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110fa926a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e0400483045022100a012691ba6cea2f73fa8bac37750477e66363c6d28813b0bb6da77c8eb3fb0270220365e99c51304b0b1a6ab9ea1c8500db186693e39ec1ad5743ee231b0138384b90147304402200769ba89c7330dfa4feba447b6e322305f12ac7dac70ec6ba997ed7c1b598d0802204fe8d337e7fee781f9b7b1a06e580b22f4f79d740059560191d7db53f876555201475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4852
4853                 // commitment tx with two outputs untrimmed (maximum feerate)
4854                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4855                 chan.feerate_per_kw = 9651180;
4856
4857                 test_commitment!("3044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd",
4858                                  "30440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b9",
4859                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b800222020000000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80ec0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de84311004004730440220514f977bf7edc442de8ce43ace9686e5ebdc0f893033f13e40fb46c8b8c6e1f90220188006227d175f5c35da0b092c57bea82537aed89f7778204dc5bacf4f29f2b901473044022037f83ff00c8e5fb18ae1f918ffc24e54581775a20ff1ae719297ef066c71caa9022039c529cccd89ff6c5ed1db799614533844bd6d101da503761c45c713996e3bbd01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4860
4861                 // commitment tx with one output untrimmed (minimum feerate)
4862                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4863                 chan.feerate_per_kw = 9651181;
4864
4865                 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4866                                  "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4867                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4868
4869                 // commitment tx with fee greater than funder amount
4870                 chan.value_to_self_msat = 6993000000; // 7000000000 - 7000000
4871                 chan.feerate_per_kw = 9651936;
4872
4873                 test_commitment!("3044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e",
4874                                  "3044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b1",
4875                                  "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8001c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de8431100400473044022031a82b51bd014915fe68928d1abf4b9885353fb896cac10c3fdd88d7f9c7f2e00220716bda819641d2c63e65d3549b6120112e1aeaf1742eed94a471488e79e206b101473044022064901950be922e62cbe3f2ab93de2b99f37cff9fc473e73e394b27f88ef0731d02206d1dfa227527b4df44a07599289e207d6fd9cca60c0365682dcd3deaf739567e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", {});
4876         }
4877
4878         #[test]
4879         fn test_per_commitment_secret_gen() {
4880                 // Test vectors from BOLT 3 Appendix D:
4881
4882                 let mut seed = [0; 32];
4883                 seed[0..32].clone_from_slice(&hex::decode("0000000000000000000000000000000000000000000000000000000000000000").unwrap());
4884                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4885                            hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap()[..]);
4886
4887                 seed[0..32].clone_from_slice(&hex::decode("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF").unwrap());
4888                 assert_eq!(chan_utils::build_commitment_secret(&seed, 281474976710655),
4889                            hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap()[..]);
4890
4891                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0xaaaaaaaaaaa),
4892                            hex::decode("56f4008fb007ca9acf0e15b054d5c9fd12ee06cea347914ddbaed70d1c13a528").unwrap()[..]);
4893
4894                 assert_eq!(chan_utils::build_commitment_secret(&seed, 0x555555555555),
4895                            hex::decode("9015daaeb06dba4ccc05b91b2f73bd54405f2be9f217fbacd3c5ac2e62327d31").unwrap()[..]);
4896
4897                 seed[0..32].clone_from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap());
4898                 assert_eq!(chan_utils::build_commitment_secret(&seed, 1),
4899                            hex::decode("915c75942a26bb3a433a8ce2cb0427c29ec6c1775cfc78328b57f6ba7bfeaa9c").unwrap()[..]);
4900         }
4901
4902         #[test]
4903         fn test_key_derivation() {
4904                 // Test vectors from BOLT 3 Appendix E:
4905                 let secp_ctx = Secp256k1::new();
4906
4907                 let base_secret = SecretKey::from_slice(&hex::decode("000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f").unwrap()[..]).unwrap();
4908                 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
4909
4910                 let base_point = PublicKey::from_secret_key(&secp_ctx, &base_secret);
4911                 assert_eq!(base_point.serialize()[..], hex::decode("036d6caac248af96f6afa7f904f550253a0f3ef3f5aa2fe6838a95b216691468e2").unwrap()[..]);
4912
4913                 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
4914                 assert_eq!(per_commitment_point.serialize()[..], hex::decode("025f7117a78150fe2ef97db7cfc83bd57b2e2c0d0dd25eaf467a4a1c2a45ce1486").unwrap()[..]);
4915
4916                 assert_eq!(chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4917                                 hex::decode("0235f2dbfaa89b57ec7b055afe29849ef7ddfeb1cefdb9ebdc43f5494984db29e5").unwrap()[..]);
4918
4919                 assert_eq!(chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &base_secret).unwrap(),
4920                                 SecretKey::from_slice(&hex::decode("cbced912d3b21bf196a766651e436aff192362621ce317704ea2f75d87e7be0f").unwrap()[..]).unwrap());
4921
4922                 assert_eq!(chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &base_point).unwrap().serialize()[..],
4923                                 hex::decode("02916e326636d19c33f13e8c0c3a03dd157f332f3e99c317c141dd865eb01f8ff0").unwrap()[..]);
4924
4925                 assert_eq!(chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_secret, &base_secret).unwrap(),
4926                                 SecretKey::from_slice(&hex::decode("d09ffff62ddb2297ab000cc85bcb4283fdeb6aa052affbc9dddcf33b61078110").unwrap()[..]).unwrap());
4927         }
4928 }