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