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

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