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