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