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

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