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

   1 //! Various utilities for building scripts and deriving keys related to channels. These are
   2 //! largely of interest for those implementing chain::keysinterface::ChannelKeys message signing
   3 //! by hand.
   4
   5 use bitcoin::blockdata::script::{Script,Builder};
   6 use bitcoin::blockdata::opcodes;
   7 use bitcoin::blockdata::transaction::{TxIn,TxOut,OutPoint,Transaction, SigHashType};
   8 use bitcoin::consensus::encode::{self, Decodable, Encodable};
   9 use bitcoin::util::bip143;
  10
  11 use bitcoin::hashes::{Hash, HashEngine};
  12 use bitcoin::hashes::sha256::Hash as Sha256;
  13 use bitcoin::hashes::ripemd160::Hash as Ripemd160;
  14 use bitcoin::hashes::hash160::Hash as Hash160;
  15 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  16
  17 use ln::channelmanager::{PaymentHash, PaymentPreimage};
  18 use ln::msgs::DecodeError;
  19 use util::ser::{Readable, Writeable, Writer, WriterWriteAdaptor};
  20 use util::byte_utils;
  21
  22 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
  23 use bitcoin::secp256k1::{Secp256k1, Signature};
  24 use bitcoin::secp256k1;
  25
  26 use std::{cmp, mem};
  27
  28 const MAX_ALLOC_SIZE: usize = 64*1024;
  29
  30 pub(super) const HTLC_SUCCESS_TX_WEIGHT: u64 = 703;
  31 pub(super) const HTLC_TIMEOUT_TX_WEIGHT: u64 = 663;
  32
  33 #[derive(PartialEq)]
  34 pub(crate) enum HTLCType {
  35         AcceptedHTLC,
  36         OfferedHTLC
  37 }
  38
  39 impl HTLCType {
  40         /// Check if a given tx witnessScript len matchs one of a pre-signed HTLC
  41         pub(crate) fn scriptlen_to_htlctype(witness_script_len: usize) ->  Option<HTLCType> {
  42                 if witness_script_len == 133 {
  43                         Some(HTLCType::OfferedHTLC)
  44                 } else if witness_script_len >= 136 && witness_script_len <= 139 {
  45                         Some(HTLCType::AcceptedHTLC)
  46                 } else {
  47                         None
  48                 }
  49         }
  50 }
  51
  52 // Various functions for key derivation and transaction creation for use within channels. Primarily
  53 // used in Channel and ChannelMonitor.
  54
  55 pub(super) fn build_commitment_secret(commitment_seed: &[u8; 32], idx: u64) -> [u8; 32] {
  56         let mut res: [u8; 32] = commitment_seed.clone();
  57         for i in 0..48 {
  58                 let bitpos = 47 - i;
  59                 if idx & (1 << bitpos) == (1 << bitpos) {
  60                         res[bitpos / 8] ^= 1 << (bitpos & 7);
  61                         res = Sha256::hash(&res).into_inner();
  62                 }
  63         }
  64         res
  65 }
  66
  67 /// Implements the per-commitment secret storage scheme from
  68 /// [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
  69 ///
  70 /// Allows us to keep track of all of the revocation secrets of counterarties in just 50*32 bytes
  71 /// or so.
  72 #[derive(Clone)]
  73 pub(super) struct CounterpartyCommitmentSecrets {
  74         old_secrets: [([u8; 32], u64); 49],
  75 }
  76
  77 impl PartialEq for CounterpartyCommitmentSecrets {
  78         fn eq(&self, other: &Self) -> bool {
  79                 for (&(ref secret, ref idx), &(ref o_secret, ref o_idx)) in self.old_secrets.iter().zip(other.old_secrets.iter()) {
  80                         if secret != o_secret || idx != o_idx {
  81                                 return false
  82                         }
  83                 }
  84                 true
  85         }
  86 }
  87
  88 impl CounterpartyCommitmentSecrets {
  89         pub(super) fn new() -> Self {
  90                 Self { old_secrets: [([0; 32], 1 << 48); 49], }
  91         }
  92
  93         #[inline]
  94         fn place_secret(idx: u64) -> u8 {
  95                 for i in 0..48 {
  96                         if idx & (1 << i) == (1 << i) {
  97                                 return i
  98                         }
  99                 }
 100                 48
 101         }
 102
 103         pub(super) fn get_min_seen_secret(&self) -> u64 {
 104                 //TODO This can be optimized?
 105                 let mut min = 1 << 48;
 106                 for &(_, idx) in self.old_secrets.iter() {
 107                         if idx < min {
 108                                 min = idx;
 109                         }
 110                 }
 111                 min
 112         }
 113
 114         #[inline]
 115         pub(super) fn derive_secret(secret: [u8; 32], bits: u8, idx: u64) -> [u8; 32] {
 116                 let mut res: [u8; 32] = secret;
 117                 for i in 0..bits {
 118                         let bitpos = bits - 1 - i;
 119                         if idx & (1 << bitpos) == (1 << bitpos) {
 120                                 res[(bitpos / 8) as usize] ^= 1 << (bitpos & 7);
 121                                 res = Sha256::hash(&res).into_inner();
 122                         }
 123                 }
 124                 res
 125         }
 126
 127         pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), ()> {
 128                 let pos = Self::place_secret(idx);
 129                 for i in 0..pos {
 130                         let (old_secret, old_idx) = self.old_secrets[i as usize];
 131                         if Self::derive_secret(secret, pos, old_idx) != old_secret {
 132                                 return Err(());
 133                         }
 134                 }
 135                 if self.get_min_seen_secret() <= idx {
 136                         return Ok(());
 137                 }
 138                 self.old_secrets[pos as usize] = (secret, idx);
 139                 Ok(())
 140         }
 141
 142         /// Can only fail if idx is < get_min_seen_secret
 143         pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
 144                 for i in 0..self.old_secrets.len() {
 145                         if (idx & (!((1 << i) - 1))) == self.old_secrets[i].1 {
 146                                 return Some(Self::derive_secret(self.old_secrets[i].0, i as u8, idx))
 147                         }
 148                 }
 149                 assert!(idx < self.get_min_seen_secret());
 150                 None
 151         }
 152 }
 153
 154 impl Writeable for CounterpartyCommitmentSecrets {
 155         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 156                 for &(ref secret, ref idx) in self.old_secrets.iter() {
 157                         writer.write_all(secret)?;
 158                         writer.write_all(&byte_utils::be64_to_array(*idx))?;
 159                 }
 160                 Ok(())
 161         }
 162 }
 163 impl Readable for CounterpartyCommitmentSecrets {
 164         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 165                 let mut old_secrets = [([0; 32], 1 << 48); 49];
 166                 for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() {
 167                         *secret = Readable::read(reader)?;
 168                         *idx = Readable::read(reader)?;
 169                 }
 170
 171                 Ok(Self { old_secrets })
 172         }
 173 }
 174
 175 /// Derives a per-commitment-transaction private key (eg an htlc key or payment key) from the base
 176 /// private key for that type of key and the per_commitment_point (available in TxCreationKeys)
 177 pub fn derive_private_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_secret: &SecretKey) -> Result<SecretKey, secp256k1::Error> {
 178         let mut sha = Sha256::engine();
 179         sha.input(&per_commitment_point.serialize());
 180         sha.input(&PublicKey::from_secret_key(&secp_ctx, &base_secret).serialize());
 181         let res = Sha256::from_engine(sha).into_inner();
 182
 183         let mut key = base_secret.clone();
 184         key.add_assign(&res)?;
 185         Ok(key)
 186 }
 187
 188 pub(super) fn derive_public_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_point: &PublicKey) -> Result<PublicKey, secp256k1::Error> {
 189         let mut sha = Sha256::engine();
 190         sha.input(&per_commitment_point.serialize());
 191         sha.input(&base_point.serialize());
 192         let res = Sha256::from_engine(sha).into_inner();
 193
 194         let hashkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&res)?);
 195         base_point.combine(&hashkey)
 196 }
 197
 198 /// Derives a revocation key from its constituent parts.
 199 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
 200 /// generated (ie our own).
 201 pub(super) fn derive_private_revocation_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_secret: &SecretKey, revocation_base_secret: &SecretKey) -> Result<SecretKey, secp256k1::Error> {
 202         let revocation_base_point = PublicKey::from_secret_key(&secp_ctx, &revocation_base_secret);
 203         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
 204
 205         let rev_append_commit_hash_key = {
 206                 let mut sha = Sha256::engine();
 207                 sha.input(&revocation_base_point.serialize());
 208                 sha.input(&per_commitment_point.serialize());
 209
 210                 Sha256::from_engine(sha).into_inner()
 211         };
 212         let commit_append_rev_hash_key = {
 213                 let mut sha = Sha256::engine();
 214                 sha.input(&per_commitment_point.serialize());
 215                 sha.input(&revocation_base_point.serialize());
 216
 217                 Sha256::from_engine(sha).into_inner()
 218         };
 219
 220         let mut part_a = revocation_base_secret.clone();
 221         part_a.mul_assign(&rev_append_commit_hash_key)?;
 222         let mut part_b = per_commitment_secret.clone();
 223         part_b.mul_assign(&commit_append_rev_hash_key)?;
 224         part_a.add_assign(&part_b[..])?;
 225         Ok(part_a)
 226 }
 227
 228 pub(super) fn derive_public_revocation_key<T: secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, revocation_base_point: &PublicKey) -> Result<PublicKey, secp256k1::Error> {
 229         let rev_append_commit_hash_key = {
 230                 let mut sha = Sha256::engine();
 231                 sha.input(&revocation_base_point.serialize());
 232                 sha.input(&per_commitment_point.serialize());
 233
 234                 Sha256::from_engine(sha).into_inner()
 235         };
 236         let commit_append_rev_hash_key = {
 237                 let mut sha = Sha256::engine();
 238                 sha.input(&per_commitment_point.serialize());
 239                 sha.input(&revocation_base_point.serialize());
 240
 241                 Sha256::from_engine(sha).into_inner()
 242         };
 243
 244         let mut part_a = revocation_base_point.clone();
 245         part_a.mul_assign(&secp_ctx, &rev_append_commit_hash_key)?;
 246         let mut part_b = per_commitment_point.clone();
 247         part_b.mul_assign(&secp_ctx, &commit_append_rev_hash_key)?;
 248         part_a.combine(&part_b)
 249 }
 250
 251 /// The set of public keys which are used in the creation of one commitment transaction.
 252 /// These are derived from the channel base keys and per-commitment data.
 253 #[derive(PartialEq, Clone)]
 254 pub struct TxCreationKeys {
 255         /// The per-commitment public key which was used to derive the other keys.
 256         pub per_commitment_point: PublicKey,
 257         /// The revocation key which is used to allow the owner of the commitment transaction to
 258         /// provide their counterparty the ability to punish them if they broadcast an old state.
 259         pub(crate) revocation_key: PublicKey,
 260         /// A's HTLC Key
 261         pub(crate) a_htlc_key: PublicKey,
 262         /// B's HTLC Key
 263         pub(crate) b_htlc_key: PublicKey,
 264         /// A's Payment Key (which isn't allowed to be spent from for some delay)
 265         pub(crate) a_delayed_payment_key: PublicKey,
 266         /// B's Payment Key
 267         pub(crate) b_payment_key: PublicKey,
 268 }
 269 impl_writeable!(TxCreationKeys, 33*6,
 270         { per_commitment_point, revocation_key, a_htlc_key, b_htlc_key, a_delayed_payment_key, b_payment_key });
 271
 272 /// One counterparty's public keys which do not change over the life of a channel.
 273 #[derive(Clone, PartialEq)]
 274 pub struct ChannelPublicKeys {
 275         /// The public key which is used to sign all commitment transactions, as it appears in the
 276         /// on-chain channel lock-in 2-of-2 multisig output.
 277         pub funding_pubkey: PublicKey,
 278         /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
 279         /// revocation keys. The per-commitment revocation private key is then revealed by the owner of
 280         /// a commitment transaction so that their counterparty can claim all available funds if they
 281         /// broadcast an old state.
 282         pub revocation_basepoint: PublicKey,
 283         /// The base point which is used (with derive_public_key) to derive a per-commitment payment
 284         /// public key which receives immediately-spendable non-HTLC-encumbered funds.
 285         pub payment_basepoint: PublicKey,
 286         /// The base point which is used (with derive_public_key) to derive a per-commitment payment
 287         /// public key which receives non-HTLC-encumbered funds which are only available for spending
 288         /// after some delay (or can be claimed via the revocation path).
 289         pub delayed_payment_basepoint: PublicKey,
 290         /// The base point which is used (with derive_public_key) to derive a per-commitment public key
 291         /// which is used to encumber HTLC-in-flight outputs.
 292         pub htlc_basepoint: PublicKey,
 293 }
 294
 295 impl_writeable!(ChannelPublicKeys, 33*5, {
 296         funding_pubkey,
 297         revocation_basepoint,
 298         payment_basepoint,
 299         delayed_payment_basepoint,
 300         htlc_basepoint
 301 });
 302
 303
 304 impl TxCreationKeys {
 305         pub(crate) fn new<T: secp256k1::Signing + secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, a_delayed_payment_base: &PublicKey, a_htlc_base: &PublicKey, b_revocation_base: &PublicKey, b_payment_base: &PublicKey, b_htlc_base: &PublicKey) -> Result<TxCreationKeys, secp256k1::Error> {
 306                 Ok(TxCreationKeys {
 307                         per_commitment_point: per_commitment_point.clone(),
 308                         revocation_key: derive_public_revocation_key(&secp_ctx, &per_commitment_point, &b_revocation_base)?,
 309                         a_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &a_htlc_base)?,
 310                         b_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &b_htlc_base)?,
 311                         a_delayed_payment_key: derive_public_key(&secp_ctx, &per_commitment_point, &a_delayed_payment_base)?,
 312                         b_payment_key: derive_public_key(&secp_ctx, &per_commitment_point, &b_payment_base)?,
 313                 })
 314         }
 315 }
 316
 317 /// Gets the "to_local" output redeemscript, ie the script which is time-locked or spendable by
 318 /// the revocation key
 319 pub(super) fn get_revokeable_redeemscript(revocation_key: &PublicKey, to_self_delay: u16, delayed_payment_key: &PublicKey) -> Script {
 320         Builder::new().push_opcode(opcodes::all::OP_IF)
 321                       .push_slice(&revocation_key.serialize())
 322                       .push_opcode(opcodes::all::OP_ELSE)
 323                       .push_int(to_self_delay as i64)
 324                       .push_opcode(opcodes::all::OP_CSV)
 325                       .push_opcode(opcodes::all::OP_DROP)
 326                       .push_slice(&delayed_payment_key.serialize())
 327                       .push_opcode(opcodes::all::OP_ENDIF)
 328                       .push_opcode(opcodes::all::OP_CHECKSIG)
 329                       .into_script()
 330 }
 331
 332 #[derive(Clone, PartialEq)]
 333 /// Information about an HTLC as it appears in a commitment transaction
 334 pub struct HTLCOutputInCommitment {
 335         /// Whether the HTLC was "offered" (ie outbound in relation to this commitment transaction).
 336         /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
 337         /// need to compare this value to whether the commitment transaction in question is that of
 338         /// the remote party or our own.
 339         pub offered: bool,
 340         /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
 341         /// this divided by 1000.
 342         pub amount_msat: u64,
 343         /// The CLTV lock-time at which this HTLC expires.
 344         pub cltv_expiry: u32,
 345         /// The hash of the preimage which unlocks this HTLC.
 346         pub payment_hash: PaymentHash,
 347         /// The position within the commitment transactions' outputs. This may be None if the value is
 348         /// below the dust limit (in which case no output appears in the commitment transaction and the
 349         /// value is spent to additional transaction fees).
 350         pub transaction_output_index: Option<u32>,
 351 }
 352
 353 impl_writeable!(HTLCOutputInCommitment, 1 + 8 + 4 + 32 + 5, {
 354         offered,
 355         amount_msat,
 356         cltv_expiry,
 357         payment_hash,
 358         transaction_output_index
 359 });
 360
 361 #[inline]
 362 pub(crate) fn get_htlc_redeemscript_with_explicit_keys(htlc: &HTLCOutputInCommitment, a_htlc_key: &PublicKey, b_htlc_key: &PublicKey, revocation_key: &PublicKey) -> Script {
 363         let payment_hash160 = Ripemd160::hash(&htlc.payment_hash.0[..]).into_inner();
 364         if htlc.offered {
 365                 Builder::new().push_opcode(opcodes::all::OP_DUP)
 366                               .push_opcode(opcodes::all::OP_HASH160)
 367                               .push_slice(&Hash160::hash(&revocation_key.serialize())[..])
 368                               .push_opcode(opcodes::all::OP_EQUAL)
 369                               .push_opcode(opcodes::all::OP_IF)
 370                               .push_opcode(opcodes::all::OP_CHECKSIG)
 371                               .push_opcode(opcodes::all::OP_ELSE)
 372                               .push_slice(&b_htlc_key.serialize()[..])
 373                               .push_opcode(opcodes::all::OP_SWAP)
 374                               .push_opcode(opcodes::all::OP_SIZE)
 375                               .push_int(32)
 376                               .push_opcode(opcodes::all::OP_EQUAL)
 377                               .push_opcode(opcodes::all::OP_NOTIF)
 378                               .push_opcode(opcodes::all::OP_DROP)
 379                               .push_int(2)
 380                               .push_opcode(opcodes::all::OP_SWAP)
 381                               .push_slice(&a_htlc_key.serialize()[..])
 382                               .push_int(2)
 383                               .push_opcode(opcodes::all::OP_CHECKMULTISIG)
 384                               .push_opcode(opcodes::all::OP_ELSE)
 385                               .push_opcode(opcodes::all::OP_HASH160)
 386                               .push_slice(&payment_hash160)
 387                               .push_opcode(opcodes::all::OP_EQUALVERIFY)
 388                               .push_opcode(opcodes::all::OP_CHECKSIG)
 389                               .push_opcode(opcodes::all::OP_ENDIF)
 390                               .push_opcode(opcodes::all::OP_ENDIF)
 391                               .into_script()
 392         } else {
 393                 Builder::new().push_opcode(opcodes::all::OP_DUP)
 394                               .push_opcode(opcodes::all::OP_HASH160)
 395                               .push_slice(&Hash160::hash(&revocation_key.serialize())[..])
 396                               .push_opcode(opcodes::all::OP_EQUAL)
 397                               .push_opcode(opcodes::all::OP_IF)
 398                               .push_opcode(opcodes::all::OP_CHECKSIG)
 399                               .push_opcode(opcodes::all::OP_ELSE)
 400                               .push_slice(&b_htlc_key.serialize()[..])
 401                               .push_opcode(opcodes::all::OP_SWAP)
 402                               .push_opcode(opcodes::all::OP_SIZE)
 403                               .push_int(32)
 404                               .push_opcode(opcodes::all::OP_EQUAL)
 405                               .push_opcode(opcodes::all::OP_IF)
 406                               .push_opcode(opcodes::all::OP_HASH160)
 407                               .push_slice(&payment_hash160)
 408                               .push_opcode(opcodes::all::OP_EQUALVERIFY)
 409                               .push_int(2)
 410                               .push_opcode(opcodes::all::OP_SWAP)
 411                               .push_slice(&a_htlc_key.serialize()[..])
 412                               .push_int(2)
 413                               .push_opcode(opcodes::all::OP_CHECKMULTISIG)
 414                               .push_opcode(opcodes::all::OP_ELSE)
 415                               .push_opcode(opcodes::all::OP_DROP)
 416                               .push_int(htlc.cltv_expiry as i64)
 417                               .push_opcode(opcodes::all::OP_CLTV)
 418                               .push_opcode(opcodes::all::OP_DROP)
 419                               .push_opcode(opcodes::all::OP_CHECKSIG)
 420                               .push_opcode(opcodes::all::OP_ENDIF)
 421                               .push_opcode(opcodes::all::OP_ENDIF)
 422                               .into_script()
 423         }
 424 }
 425
 426 /// note here that 'a_revocation_key' is generated using b_revocation_basepoint and a's
 427 /// commitment secret. 'htlc' does *not* need to have its previous_output_index filled.
 428 #[inline]
 429 pub fn get_htlc_redeemscript(htlc: &HTLCOutputInCommitment, keys: &TxCreationKeys) -> Script {
 430         get_htlc_redeemscript_with_explicit_keys(htlc, &keys.a_htlc_key, &keys.b_htlc_key, &keys.revocation_key)
 431 }
 432
 433 /// Gets the redeemscript for a funding output from the two funding public keys.
 434 /// Note that the order of funding public keys does not matter.
 435 pub fn make_funding_redeemscript(a: &PublicKey, b: &PublicKey) -> Script {
 436         let our_funding_key = a.serialize();
 437         let their_funding_key = b.serialize();
 438
 439         let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
 440         if our_funding_key[..] < their_funding_key[..] {
 441                 builder.push_slice(&our_funding_key)
 442                         .push_slice(&their_funding_key)
 443         } else {
 444                 builder.push_slice(&their_funding_key)
 445                         .push_slice(&our_funding_key)
 446         }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
 447 }
 448
 449 /// panics if htlc.transaction_output_index.is_none()!
 450 pub fn build_htlc_transaction(prev_hash: &Sha256dHash, feerate_per_kw: u64, to_self_delay: u16, htlc: &HTLCOutputInCommitment, a_delayed_payment_key: &PublicKey, revocation_key: &PublicKey) -> Transaction {
 451         let mut txins: Vec<TxIn> = Vec::new();
 452         txins.push(TxIn {
 453                 previous_output: OutPoint {
 454                         txid: prev_hash.clone(),
 455                         vout: htlc.transaction_output_index.expect("Can't build an HTLC transaction for a dust output"),
 456                 },
 457                 script_sig: Script::new(),
 458                 sequence: 0,
 459                 witness: Vec::new(),
 460         });
 461
 462         let total_fee = if htlc.offered {
 463                         feerate_per_kw * HTLC_TIMEOUT_TX_WEIGHT / 1000
 464                 } else {
 465                         feerate_per_kw * HTLC_SUCCESS_TX_WEIGHT / 1000
 466                 };
 467
 468         let mut txouts: Vec<TxOut> = Vec::new();
 469         txouts.push(TxOut {
 470                 script_pubkey: get_revokeable_redeemscript(revocation_key, to_self_delay, a_delayed_payment_key).to_v0_p2wsh(),
 471                 value: htlc.amount_msat / 1000 - total_fee //TODO: BOLT 3 does not specify if we should add amount_msat before dividing or if we should divide by 1000 before subtracting (as we do here)
 472         });
 473
 474         Transaction {
 475                 version: 2,
 476                 lock_time: if htlc.offered { htlc.cltv_expiry } else { 0 },
 477                 input: txins,
 478                 output: txouts,
 479         }
 480 }
 481
 482 #[derive(Clone)]
 483 /// We use this to track local commitment transactions and put off signing them until we are ready
 484 /// to broadcast. Eventually this will require a signer which is possibly external, but for now we
 485 /// just pass in the SecretKeys required.
 486 pub struct LocalCommitmentTransaction {
 487         // TODO: We should migrate away from providing the transaction, instead providing enough to
 488         // allow the ChannelKeys to construct it from scratch. Luckily we already have HTLC data here,
 489         // so we're probably most of the way there.
 490         /// The commitment transaction itself, in unsigned form.
 491         pub unsigned_tx: Transaction,
 492         /// Our counterparty's signature for the transaction, above.
 493         pub their_sig: Signature,
 494         // Which order the signatures should go in when constructing the final commitment tx witness.
 495         // The user should be able to reconstruc this themselves, so we don't bother to expose it.
 496         our_sig_first: bool,
 497         /// The key derivation parameters for this commitment transaction
 498         pub local_keys: TxCreationKeys,
 499         /// The feerate paid per 1000-weight-unit in this commitment transaction. This value is
 500         /// controlled by the channel initiator.
 501         pub feerate_per_kw: u64,
 502         /// The HTLCs and remote htlc signatures which were included in this commitment transaction.
 503         ///
 504         /// Note that this includes all HTLCs, including ones which were considered dust and not
 505         /// actually included in the transaction as it appears on-chain, but who's value is burned as
 506         /// fees and not included in the to_local or to_remote outputs.
 507         ///
 508         /// The remote HTLC signatures in the second element will always be set for non-dust HTLCs, ie
 509         /// those for which transaction_output_index.is_some().
 510         pub per_htlc: Vec<(HTLCOutputInCommitment, Option<Signature>)>,
 511 }
 512 impl LocalCommitmentTransaction {
 513         #[cfg(test)]
 514         pub fn dummy() -> Self {
 515                 let dummy_input = TxIn {
 516                         previous_output: OutPoint {
 517                                 txid: Default::default(),
 518                                 vout: 0,
 519                         },
 520                         script_sig: Default::default(),
 521                         sequence: 0,
 522                         witness: vec![]
 523                 };
 524                 let dummy_key = PublicKey::from_secret_key(&Secp256k1::new(), &SecretKey::from_slice(&[42; 32]).unwrap());
 525                 let dummy_sig = Secp256k1::new().sign(&secp256k1::Message::from_slice(&[42; 32]).unwrap(), &SecretKey::from_slice(&[42; 32]).unwrap());
 526                 Self {
 527                         unsigned_tx: Transaction {
 528                                 version: 2,
 529                                 input: vec![dummy_input],
 530                                 output: Vec::new(),
 531                                 lock_time: 0,
 532                         },
 533                         their_sig: dummy_sig,
 534                         our_sig_first: false,
 535                         local_keys: TxCreationKeys {
 536                                         per_commitment_point: dummy_key.clone(),
 537                                         revocation_key: dummy_key.clone(),
 538                                         a_htlc_key: dummy_key.clone(),
 539                                         b_htlc_key: dummy_key.clone(),
 540                                         a_delayed_payment_key: dummy_key.clone(),
 541                                         b_payment_key: dummy_key.clone(),
 542                                 },
 543                         feerate_per_kw: 0,
 544                         per_htlc: Vec::new()
 545                 }
 546         }
 547
 548         /// Generate a new LocalCommitmentTransaction based on a raw commitment transaction,
 549         /// remote signature and both parties keys
 550         pub(crate) fn new_missing_local_sig(unsigned_tx: Transaction, their_sig: Signature, our_funding_key: &PublicKey, their_funding_key: &PublicKey, local_keys: TxCreationKeys, feerate_per_kw: u64, htlc_data: Vec<(HTLCOutputInCommitment, Option<Signature>)>) -> LocalCommitmentTransaction {
 551                 if unsigned_tx.input.len() != 1 { panic!("Tried to store a commitment transaction that had input count != 1!"); }
 552                 if unsigned_tx.input[0].witness.len() != 0 { panic!("Tried to store a signed commitment transaction?"); }
 553
 554                 Self {
 555                         unsigned_tx,
 556                         their_sig,
 557                         our_sig_first: our_funding_key.serialize()[..] < their_funding_key.serialize()[..],
 558                         local_keys,
 559                         feerate_per_kw,
 560                         per_htlc: htlc_data,
 561                 }
 562         }
 563
 564         /// Get the txid of the local commitment transaction contained in this
 565         /// LocalCommitmentTransaction
 566         pub fn txid(&self) -> Sha256dHash {
 567                 self.unsigned_tx.txid()
 568         }
 569
 570         /// Gets our signature for the contained commitment transaction given our funding private key.
 571         ///
 572         /// Funding key is your key included in the 2-2 funding_outpoint lock. Should be provided
 573         /// by your ChannelKeys.
 574         /// Funding redeemscript is script locking funding_outpoint. This is the mutlsig script
 575         /// between your own funding key and your counterparty's. Currently, this is provided in
 576         /// ChannelKeys::sign_local_commitment() calls directly.
 577         /// Channel value is amount locked in funding_outpoint.
 578         pub fn get_local_sig<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
 579                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&self.unsigned_tx)
 580                         .sighash_all(&self.unsigned_tx.input[0], funding_redeemscript, channel_value_satoshis)[..]);
 581                 secp_ctx.sign(&sighash, funding_key)
 582         }
 583
 584         pub(crate) fn add_local_sig(&self, funding_redeemscript: &Script, our_sig: Signature) -> Transaction {
 585                 let mut tx = self.unsigned_tx.clone();
 586                 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
 587                 tx.input[0].witness.push(Vec::new());
 588
 589                 if self.our_sig_first {
 590                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
 591                         tx.input[0].witness.push(self.their_sig.serialize_der().to_vec());
 592                 } else {
 593                         tx.input[0].witness.push(self.their_sig.serialize_der().to_vec());
 594                         tx.input[0].witness.push(our_sig.serialize_der().to_vec());
 595                 }
 596                 tx.input[0].witness[1].push(SigHashType::All as u8);
 597                 tx.input[0].witness[2].push(SigHashType::All as u8);
 598
 599                 tx.input[0].witness.push(funding_redeemscript.as_bytes().to_vec());
 600                 tx
 601         }
 602
 603         /// Get a signature for each HTLC which was included in the commitment transaction (ie for
 604         /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
 605         ///
 606         /// The returned Vec has one entry for each HTLC, and in the same order. For HTLCs which were
 607         /// considered dust and not included, a None entry exists, for all others a signature is
 608         /// included.
 609         pub fn get_htlc_sigs<T: secp256k1::Signing + secp256k1::Verification>(&self, htlc_base_key: &SecretKey, local_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Vec<Option<Signature>>, ()> {
 610                 let txid = self.txid();
 611                 let mut ret = Vec::with_capacity(self.per_htlc.len());
 612                 let our_htlc_key = derive_private_key(secp_ctx, &self.local_keys.per_commitment_point, htlc_base_key).map_err(|_| ())?;
 613
 614                 for this_htlc in self.per_htlc.iter() {
 615                         if this_htlc.0.transaction_output_index.is_some() {
 616                                 let htlc_tx = build_htlc_transaction(&txid, self.feerate_per_kw, local_csv, &this_htlc.0, &self.local_keys.a_delayed_payment_key, &self.local_keys.revocation_key);
 617
 618                                 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc.0, &self.local_keys.a_htlc_key, &self.local_keys.b_htlc_key, &self.local_keys.revocation_key);
 619
 620                                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, this_htlc.0.amount_msat / 1000)[..]);
 621                                 ret.push(Some(secp_ctx.sign(&sighash, &our_htlc_key)));
 622                         } else {
 623                                 ret.push(None);
 624                         }
 625                 }
 626                 Ok(ret)
 627         }
 628
 629         /// Gets a signed HTLC transaction given a preimage (for !htlc.offered) and the local HTLC transaction signature.
 630         pub(crate) fn get_signed_htlc_tx(&self, htlc_index: usize, signature: &Signature, preimage: &Option<PaymentPreimage>, local_csv: u16) -> Transaction {
 631                 let txid = self.txid();
 632                 let this_htlc = &self.per_htlc[htlc_index];
 633                 assert!(this_htlc.0.transaction_output_index.is_some());
 634                 // if we don't have preimage for an HTLC-Success, we can't generate an HTLC transaction.
 635                 if !this_htlc.0.offered && preimage.is_none() { unreachable!(); }
 636                 // Further, we should never be provided the preimage for an HTLC-Timeout transaction.
 637                 if  this_htlc.0.offered && preimage.is_some() { unreachable!(); }
 638
 639                 let mut htlc_tx = build_htlc_transaction(&txid, self.feerate_per_kw, local_csv, &this_htlc.0, &self.local_keys.a_delayed_payment_key, &self.local_keys.revocation_key);
 640                 // Channel should have checked that we have a remote signature for this HTLC at
 641                 // creation, and we should have a sensible htlc transaction:
 642                 assert!(this_htlc.1.is_some());
 643
 644                 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc.0, &self.local_keys.a_htlc_key, &self.local_keys.b_htlc_key, &self.local_keys.revocation_key);
 645
 646                 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
 647                 htlc_tx.input[0].witness.push(Vec::new());
 648
 649                 htlc_tx.input[0].witness.push(this_htlc.1.unwrap().serialize_der().to_vec());
 650                 htlc_tx.input[0].witness.push(signature.serialize_der().to_vec());
 651                 htlc_tx.input[0].witness[1].push(SigHashType::All as u8);
 652                 htlc_tx.input[0].witness[2].push(SigHashType::All as u8);
 653
 654                 if this_htlc.0.offered {
 655                         // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
 656                         htlc_tx.input[0].witness.push(Vec::new());
 657                 } else {
 658                         htlc_tx.input[0].witness.push(preimage.unwrap().0.to_vec());
 659                 }
 660
 661                 htlc_tx.input[0].witness.push(htlc_redeemscript.as_bytes().to_vec());
 662                 htlc_tx
 663         }
 664 }
 665 impl PartialEq for LocalCommitmentTransaction {
 666         // We dont care whether we are signed in equality comparison
 667         fn eq(&self, o: &Self) -> bool {
 668                 self.txid() == o.txid()
 669         }
 670 }
 671 impl Writeable for LocalCommitmentTransaction {
 672         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
 673                 if let Err(e) = self.unsigned_tx.consensus_encode(&mut WriterWriteAdaptor(writer)) {
 674                         match e {
 675                                 encode::Error::Io(e) => return Err(e),
 676                                 _ => panic!("local tx must have been well-formed!"),
 677                         }
 678                 }
 679                 self.their_sig.write(writer)?;
 680                 self.our_sig_first.write(writer)?;
 681                 self.local_keys.write(writer)?;
 682                 self.feerate_per_kw.write(writer)?;
 683                 writer.write_all(&byte_utils::be64_to_array(self.per_htlc.len() as u64))?;
 684                 for &(ref htlc, ref sig) in self.per_htlc.iter() {
 685                         htlc.write(writer)?;
 686                         sig.write(writer)?;
 687                 }
 688                 Ok(())
 689         }
 690 }
 691 impl Readable for LocalCommitmentTransaction {
 692         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
 693                 let unsigned_tx = match Transaction::consensus_decode(reader.by_ref()) {
 694                         Ok(tx) => tx,
 695                         Err(e) => match e {
 696                                 encode::Error::Io(ioe) => return Err(DecodeError::Io(ioe)),
 697                                 _ => return Err(DecodeError::InvalidValue),
 698                         },
 699                 };
 700                 let their_sig = Readable::read(reader)?;
 701                 let our_sig_first = Readable::read(reader)?;
 702                 let local_keys = Readable::read(reader)?;
 703                 let feerate_per_kw = Readable::read(reader)?;
 704                 let htlcs_count: u64 = Readable::read(reader)?;
 705                 let mut per_htlc = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / mem::size_of::<(HTLCOutputInCommitment, Option<Signature>)>()));
 706                 for _ in 0..htlcs_count {
 707                         let htlc: HTLCOutputInCommitment = Readable::read(reader)?;
 708                         let sigs = Readable::read(reader)?;
 709                         per_htlc.push((htlc, sigs));
 710                 }
 711
 712                 if unsigned_tx.input.len() != 1 {
 713                         // Ensure tx didn't hit the 0-input ambiguity case.
 714                         return Err(DecodeError::InvalidValue);
 715                 }
 716                 Ok(Self {
 717                         unsigned_tx,
 718                         their_sig,
 719                         our_sig_first,
 720                         local_keys,
 721                         feerate_per_kw,
 722                         per_htlc,
 723                 })
 724         }
 725 }
 726
 727 #[cfg(test)]
 728 mod tests {
 729         use super::CounterpartyCommitmentSecrets;
 730         use hex;
 731
 732         #[test]
 733         fn test_per_commitment_storage() {
 734                 // Test vectors from BOLT 3:
 735                 let mut secrets: Vec<[u8; 32]> = Vec::new();
 736                 let mut monitor;
 737
 738                 macro_rules! test_secrets {
 739                         () => {
 740                                 let mut idx = 281474976710655;
 741                                 for secret in secrets.iter() {
 742                                         assert_eq!(monitor.get_secret(idx).unwrap(), *secret);
 743                                         idx -= 1;
 744                                 }
 745                                 assert_eq!(monitor.get_min_seen_secret(), idx + 1);
 746                                 assert!(monitor.get_secret(idx).is_none());
 747                         };
 748                 }
 749
 750                 {
 751                         // insert_secret correct sequence
 752                         monitor = CounterpartyCommitmentSecrets::new();
 753                         secrets.clear();
 754
 755                         secrets.push([0; 32]);
 756                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 757                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 758                         test_secrets!();
 759
 760                         secrets.push([0; 32]);
 761                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 762                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 763                         test_secrets!();
 764
 765                         secrets.push([0; 32]);
 766                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 767                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 768                         test_secrets!();
 769
 770                         secrets.push([0; 32]);
 771                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 772                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 773                         test_secrets!();
 774
 775                         secrets.push([0; 32]);
 776                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
 777                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 778                         test_secrets!();
 779
 780                         secrets.push([0; 32]);
 781                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 782                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 783                         test_secrets!();
 784
 785                         secrets.push([0; 32]);
 786                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 787                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 788                         test_secrets!();
 789
 790                         secrets.push([0; 32]);
 791                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 792                         monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).unwrap();
 793                         test_secrets!();
 794                 }
 795
 796                 {
 797                         // insert_secret #1 incorrect
 798                         monitor = CounterpartyCommitmentSecrets::new();
 799                         secrets.clear();
 800
 801                         secrets.push([0; 32]);
 802                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 803                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 804                         test_secrets!();
 805
 806                         secrets.push([0; 32]);
 807                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 808                         assert!(monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).is_err());
 809                 }
 810
 811                 {
 812                         // insert_secret #2 incorrect (#1 derived from incorrect)
 813                         monitor = CounterpartyCommitmentSecrets::new();
 814                         secrets.clear();
 815
 816                         secrets.push([0; 32]);
 817                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 818                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 819                         test_secrets!();
 820
 821                         secrets.push([0; 32]);
 822                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
 823                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 824                         test_secrets!();
 825
 826                         secrets.push([0; 32]);
 827                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 828                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 829                         test_secrets!();
 830
 831                         secrets.push([0; 32]);
 832                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 833                         assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
 834                 }
 835
 836                 {
 837                         // insert_secret #3 incorrect
 838                         monitor = CounterpartyCommitmentSecrets::new();
 839                         secrets.clear();
 840
 841                         secrets.push([0; 32]);
 842                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 843                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 844                         test_secrets!();
 845
 846                         secrets.push([0; 32]);
 847                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 848                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 849                         test_secrets!();
 850
 851                         secrets.push([0; 32]);
 852                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
 853                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 854                         test_secrets!();
 855
 856                         secrets.push([0; 32]);
 857                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 858                         assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
 859                 }
 860
 861                 {
 862                         // insert_secret #4 incorrect (1,2,3 derived from incorrect)
 863                         monitor = CounterpartyCommitmentSecrets::new();
 864                         secrets.clear();
 865
 866                         secrets.push([0; 32]);
 867                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
 868                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 869                         test_secrets!();
 870
 871                         secrets.push([0; 32]);
 872                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
 873                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 874                         test_secrets!();
 875
 876                         secrets.push([0; 32]);
 877                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
 878                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 879                         test_secrets!();
 880
 881                         secrets.push([0; 32]);
 882                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("ba65d7b0ef55a3ba300d4e87af29868f394f8f138d78a7011669c79b37b936f4").unwrap());
 883                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 884                         test_secrets!();
 885
 886                         secrets.push([0; 32]);
 887                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
 888                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 889                         test_secrets!();
 890
 891                         secrets.push([0; 32]);
 892                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 893                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 894                         test_secrets!();
 895
 896                         secrets.push([0; 32]);
 897                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 898                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 899                         test_secrets!();
 900
 901                         secrets.push([0; 32]);
 902                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 903                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
 904                 }
 905
 906                 {
 907                         // insert_secret #5 incorrect
 908                         monitor = CounterpartyCommitmentSecrets::new();
 909                         secrets.clear();
 910
 911                         secrets.push([0; 32]);
 912                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 913                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 914                         test_secrets!();
 915
 916                         secrets.push([0; 32]);
 917                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 918                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 919                         test_secrets!();
 920
 921                         secrets.push([0; 32]);
 922                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 923                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 924                         test_secrets!();
 925
 926                         secrets.push([0; 32]);
 927                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 928                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 929                         test_secrets!();
 930
 931                         secrets.push([0; 32]);
 932                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
 933                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 934                         test_secrets!();
 935
 936                         secrets.push([0; 32]);
 937                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
 938                         assert!(monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).is_err());
 939                 }
 940
 941                 {
 942                         // insert_secret #6 incorrect (5 derived from incorrect)
 943                         monitor = CounterpartyCommitmentSecrets::new();
 944                         secrets.clear();
 945
 946                         secrets.push([0; 32]);
 947                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 948                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 949                         test_secrets!();
 950
 951                         secrets.push([0; 32]);
 952                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 953                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 954                         test_secrets!();
 955
 956                         secrets.push([0; 32]);
 957                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
 958                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
 959                         test_secrets!();
 960
 961                         secrets.push([0; 32]);
 962                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
 963                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
 964                         test_secrets!();
 965
 966                         secrets.push([0; 32]);
 967                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
 968                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
 969                         test_secrets!();
 970
 971                         secrets.push([0; 32]);
 972                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("b7e76a83668bde38b373970155c868a653304308f9896692f904a23731224bb1").unwrap());
 973                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
 974                         test_secrets!();
 975
 976                         secrets.push([0; 32]);
 977                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
 978                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
 979                         test_secrets!();
 980
 981                         secrets.push([0; 32]);
 982                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
 983                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
 984                 }
 985
 986                 {
 987                         // insert_secret #7 incorrect
 988                         monitor = CounterpartyCommitmentSecrets::new();
 989                         secrets.clear();
 990
 991                         secrets.push([0; 32]);
 992                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
 993                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
 994                         test_secrets!();
 995
 996                         secrets.push([0; 32]);
 997                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
 998                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
 999                         test_secrets!();
1000
1001                         secrets.push([0; 32]);
1002                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1003                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1004                         test_secrets!();
1005
1006                         secrets.push([0; 32]);
1007                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1008                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1009                         test_secrets!();
1010
1011                         secrets.push([0; 32]);
1012                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1013                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1014                         test_secrets!();
1015
1016                         secrets.push([0; 32]);
1017                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1018                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1019                         test_secrets!();
1020
1021                         secrets.push([0; 32]);
1022                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("e7971de736e01da8ed58b94c2fc216cb1dca9e326f3a96e7194fe8ea8af6c0a3").unwrap());
1023                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1024                         test_secrets!();
1025
1026                         secrets.push([0; 32]);
1027                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1028                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1029                 }
1030
1031                 {
1032                         // insert_secret #8 incorrect
1033                         monitor = CounterpartyCommitmentSecrets::new();
1034                         secrets.clear();
1035
1036                         secrets.push([0; 32]);
1037                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1038                         monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1039                         test_secrets!();
1040
1041                         secrets.push([0; 32]);
1042                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1043                         monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1044                         test_secrets!();
1045
1046                         secrets.push([0; 32]);
1047                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1048                         monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1049                         test_secrets!();
1050
1051                         secrets.push([0; 32]);
1052                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1053                         monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1054                         test_secrets!();
1055
1056                         secrets.push([0; 32]);
1057                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1058                         monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1059                         test_secrets!();
1060
1061                         secrets.push([0; 32]);
1062                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1063                         monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1064                         test_secrets!();
1065
1066                         secrets.push([0; 32]);
1067                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1068                         monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1069                         test_secrets!();
1070
1071                         secrets.push([0; 32]);
1072                         secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a7efbc61aac46d34f77778bac22c8a20c6a46ca460addc49009bda875ec88fa4").unwrap());
1073                         assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1074                 }
1075         }
1076 }