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