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