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

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