1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! Various utilities for building scripts and deriving keys related to channels. These are
11 //! largely of interest for those implementing chain::keysinterface::Sign message signing by hand.
13 use bitcoin::blockdata::script::{Script,Builder};
14 use bitcoin::blockdata::opcodes;
15 use bitcoin::blockdata::transaction::{TxIn,TxOut,OutPoint,Transaction, SigHashType};
16 use bitcoin::util::bip143;
18 use bitcoin::hashes::{Hash, HashEngine};
19 use bitcoin::hashes::sha256::Hash as Sha256;
20 use bitcoin::hashes::ripemd160::Hash as Ripemd160;
21 use bitcoin::hash_types::{Txid, PubkeyHash};
23 use ln::{PaymentHash, PaymentPreimage};
24 use ln::msgs::DecodeError;
25 use util::ser::{Readable, Writeable, Writer};
26 use util::{byte_utils, transaction_utils};
28 use bitcoin::hash_types::WPubkeyHash;
29 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
30 use bitcoin::secp256k1::{Secp256k1, Signature, Message};
31 use bitcoin::secp256k1::Error as SecpError;
32 use bitcoin::secp256k1;
38 use util::transaction_utils::sort_outputs;
39 use ln::channel::{INITIAL_COMMITMENT_NUMBER, ANCHOR_OUTPUT_VALUE_SATOSHI};
43 pub(crate) const MAX_HTLCS: u16 = 483;
45 pub(super) const HTLC_SUCCESS_TX_WEIGHT: u64 = 703;
46 pub(super) const HTLC_TIMEOUT_TX_WEIGHT: u64 = 663;
49 pub(crate) enum HTLCType {
55 /// Check if a given tx witnessScript len matchs one of a pre-signed HTLC
56 pub(crate) fn scriptlen_to_htlctype(witness_script_len: usize) -> Option<HTLCType> {
57 if witness_script_len == 133 {
58 Some(HTLCType::OfferedHTLC)
59 } else if witness_script_len >= 136 && witness_script_len <= 139 {
60 Some(HTLCType::AcceptedHTLC)
67 // Various functions for key derivation and transaction creation for use within channels. Primarily
68 // used in Channel and ChannelMonitor.
70 /// Build the commitment secret from the seed and the commitment number
71 pub fn build_commitment_secret(commitment_seed: &[u8; 32], idx: u64) -> [u8; 32] {
72 let mut res: [u8; 32] = commitment_seed.clone();
75 if idx & (1 << bitpos) == (1 << bitpos) {
76 res[bitpos / 8] ^= 1 << (bitpos & 7);
77 res = Sha256::hash(&res).into_inner();
83 /// Build a closing transaction
84 pub fn build_closing_transaction(to_holder_value_sat: u64, to_counterparty_value_sat: u64, to_holder_script: Script, to_counterparty_script: Script, funding_outpoint: OutPoint) -> Transaction {
86 let mut ins: Vec<TxIn> = Vec::new();
88 previous_output: funding_outpoint,
89 script_sig: Script::new(),
96 let mut txouts: Vec<(TxOut, ())> = Vec::new();
98 if to_counterparty_value_sat > 0 {
100 script_pubkey: to_counterparty_script,
101 value: to_counterparty_value_sat
105 if to_holder_value_sat > 0 {
107 script_pubkey: to_holder_script,
108 value: to_holder_value_sat
112 transaction_utils::sort_outputs(&mut txouts, |_, _| { cmp::Ordering::Equal }); // Ordering doesnt matter if they used our pubkey...
114 let mut outputs: Vec<TxOut> = Vec::new();
115 for out in txouts.drain(..) {
127 /// Implements the per-commitment secret storage scheme from
128 /// [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
130 /// Allows us to keep track of all of the revocation secrets of counterarties in just 50*32 bytes
133 pub(crate) struct CounterpartyCommitmentSecrets {
134 old_secrets: [([u8; 32], u64); 49],
137 impl PartialEq for CounterpartyCommitmentSecrets {
138 fn eq(&self, other: &Self) -> bool {
139 for (&(ref secret, ref idx), &(ref o_secret, ref o_idx)) in self.old_secrets.iter().zip(other.old_secrets.iter()) {
140 if secret != o_secret || idx != o_idx {
148 impl CounterpartyCommitmentSecrets {
149 pub(crate) fn new() -> Self {
150 Self { old_secrets: [([0; 32], 1 << 48); 49], }
154 fn place_secret(idx: u64) -> u8 {
156 if idx & (1 << i) == (1 << i) {
163 pub(crate) fn get_min_seen_secret(&self) -> u64 {
164 //TODO This can be optimized?
165 let mut min = 1 << 48;
166 for &(_, idx) in self.old_secrets.iter() {
175 fn derive_secret(secret: [u8; 32], bits: u8, idx: u64) -> [u8; 32] {
176 let mut res: [u8; 32] = secret;
178 let bitpos = bits - 1 - i;
179 if idx & (1 << bitpos) == (1 << bitpos) {
180 res[(bitpos / 8) as usize] ^= 1 << (bitpos & 7);
181 res = Sha256::hash(&res).into_inner();
187 pub(crate) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), ()> {
188 let pos = Self::place_secret(idx);
190 let (old_secret, old_idx) = self.old_secrets[i as usize];
191 if Self::derive_secret(secret, pos, old_idx) != old_secret {
195 if self.get_min_seen_secret() <= idx {
198 self.old_secrets[pos as usize] = (secret, idx);
202 /// Can only fail if idx is < get_min_seen_secret
203 pub(crate) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
204 for i in 0..self.old_secrets.len() {
205 if (idx & (!((1 << i) - 1))) == self.old_secrets[i].1 {
206 return Some(Self::derive_secret(self.old_secrets[i].0, i as u8, idx))
209 assert!(idx < self.get_min_seen_secret());
214 impl Writeable for CounterpartyCommitmentSecrets {
215 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
216 for &(ref secret, ref idx) in self.old_secrets.iter() {
217 writer.write_all(secret)?;
218 writer.write_all(&byte_utils::be64_to_array(*idx))?;
220 write_tlv_fields!(writer, {});
224 impl Readable for CounterpartyCommitmentSecrets {
225 fn read<R: io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
226 let mut old_secrets = [([0; 32], 1 << 48); 49];
227 for &mut (ref mut secret, ref mut idx) in old_secrets.iter_mut() {
228 *secret = Readable::read(reader)?;
229 *idx = Readable::read(reader)?;
231 read_tlv_fields!(reader, {});
232 Ok(Self { old_secrets })
236 /// Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
237 /// from the base secret and the per_commitment_point.
239 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
240 /// generated (ie our own).
241 pub fn derive_private_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_secret: &SecretKey) -> Result<SecretKey, SecpError> {
242 let mut sha = Sha256::engine();
243 sha.input(&per_commitment_point.serialize());
244 sha.input(&PublicKey::from_secret_key(&secp_ctx, &base_secret).serialize());
245 let res = Sha256::from_engine(sha).into_inner();
247 let mut key = base_secret.clone();
248 key.add_assign(&res)?;
252 /// Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
253 /// from the base point and the per_commitment_key. This is the public equivalent of
254 /// derive_private_key - using only public keys to derive a public key instead of private keys.
256 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
257 /// generated (ie our own).
258 pub fn derive_public_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, base_point: &PublicKey) -> Result<PublicKey, SecpError> {
259 let mut sha = Sha256::engine();
260 sha.input(&per_commitment_point.serialize());
261 sha.input(&base_point.serialize());
262 let res = Sha256::from_engine(sha).into_inner();
264 let hashkey = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&res)?);
265 base_point.combine(&hashkey)
268 /// Derives a per-commitment-transaction revocation key from its constituent parts.
270 /// Only the cheating participant owns a valid witness to propagate a revoked
271 /// commitment transaction, thus per_commitment_secret always come from cheater
272 /// and revocation_base_secret always come from punisher, which is the broadcaster
273 /// of the transaction spending with this key knowledge.
275 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
276 /// generated (ie our own).
277 pub fn derive_private_revocation_key<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, per_commitment_secret: &SecretKey, countersignatory_revocation_base_secret: &SecretKey) -> Result<SecretKey, SecpError> {
278 let countersignatory_revocation_base_point = PublicKey::from_secret_key(&secp_ctx, &countersignatory_revocation_base_secret);
279 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
281 let rev_append_commit_hash_key = {
282 let mut sha = Sha256::engine();
283 sha.input(&countersignatory_revocation_base_point.serialize());
284 sha.input(&per_commitment_point.serialize());
286 Sha256::from_engine(sha).into_inner()
288 let commit_append_rev_hash_key = {
289 let mut sha = Sha256::engine();
290 sha.input(&per_commitment_point.serialize());
291 sha.input(&countersignatory_revocation_base_point.serialize());
293 Sha256::from_engine(sha).into_inner()
296 let mut countersignatory_contrib = countersignatory_revocation_base_secret.clone();
297 countersignatory_contrib.mul_assign(&rev_append_commit_hash_key)?;
298 let mut broadcaster_contrib = per_commitment_secret.clone();
299 broadcaster_contrib.mul_assign(&commit_append_rev_hash_key)?;
300 countersignatory_contrib.add_assign(&broadcaster_contrib[..])?;
301 Ok(countersignatory_contrib)
304 /// Derives a per-commitment-transaction revocation public key from its constituent parts. This is
305 /// the public equivalend of derive_private_revocation_key - using only public keys to derive a
306 /// public key instead of private keys.
308 /// Only the cheating participant owns a valid witness to propagate a revoked
309 /// commitment transaction, thus per_commitment_point always come from cheater
310 /// and revocation_base_point always come from punisher, which is the broadcaster
311 /// of the transaction spending with this key knowledge.
313 /// Note that this is infallible iff we trust that at least one of the two input keys are randomly
314 /// generated (ie our own).
315 pub fn derive_public_revocation_key<T: secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, countersignatory_revocation_base_point: &PublicKey) -> Result<PublicKey, SecpError> {
316 let rev_append_commit_hash_key = {
317 let mut sha = Sha256::engine();
318 sha.input(&countersignatory_revocation_base_point.serialize());
319 sha.input(&per_commitment_point.serialize());
321 Sha256::from_engine(sha).into_inner()
323 let commit_append_rev_hash_key = {
324 let mut sha = Sha256::engine();
325 sha.input(&per_commitment_point.serialize());
326 sha.input(&countersignatory_revocation_base_point.serialize());
328 Sha256::from_engine(sha).into_inner()
331 let mut countersignatory_contrib = countersignatory_revocation_base_point.clone();
332 countersignatory_contrib.mul_assign(&secp_ctx, &rev_append_commit_hash_key)?;
333 let mut broadcaster_contrib = per_commitment_point.clone();
334 broadcaster_contrib.mul_assign(&secp_ctx, &commit_append_rev_hash_key)?;
335 countersignatory_contrib.combine(&broadcaster_contrib)
338 /// The set of public keys which are used in the creation of one commitment transaction.
339 /// These are derived from the channel base keys and per-commitment data.
341 /// A broadcaster key is provided from potential broadcaster of the computed transaction.
342 /// A countersignatory key is coming from a protocol participant unable to broadcast the
345 /// These keys are assumed to be good, either because the code derived them from
346 /// channel basepoints via the new function, or they were obtained via
347 /// CommitmentTransaction.trust().keys() because we trusted the source of the
348 /// pre-calculated keys.
349 #[derive(PartialEq, Clone)]
350 pub struct TxCreationKeys {
351 /// The broadcaster's per-commitment public key which was used to derive the other keys.
352 pub per_commitment_point: PublicKey,
353 /// The revocation key which is used to allow the broadcaster of the commitment
354 /// transaction to provide their counterparty the ability to punish them if they broadcast
356 pub revocation_key: PublicKey,
357 /// Broadcaster's HTLC Key
358 pub broadcaster_htlc_key: PublicKey,
359 /// Countersignatory's HTLC Key
360 pub countersignatory_htlc_key: PublicKey,
361 /// Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
362 pub broadcaster_delayed_payment_key: PublicKey,
365 impl_writeable_tlv_based!(TxCreationKeys, {
366 (0, per_commitment_point, required),
367 (2, revocation_key, required),
368 (4, broadcaster_htlc_key, required),
369 (6, countersignatory_htlc_key, required),
370 (8, broadcaster_delayed_payment_key, required),
373 /// One counterparty's public keys which do not change over the life of a channel.
374 #[derive(Clone, PartialEq)]
375 pub struct ChannelPublicKeys {
376 /// The public key which is used to sign all commitment transactions, as it appears in the
377 /// on-chain channel lock-in 2-of-2 multisig output.
378 pub funding_pubkey: PublicKey,
379 /// The base point which is used (with derive_public_revocation_key) to derive per-commitment
380 /// revocation keys. This is combined with the per-commitment-secret generated by the
381 /// counterparty to create a secret which the counterparty can reveal to revoke previous
383 pub revocation_basepoint: PublicKey,
384 /// The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
385 /// spendable primary channel balance on the broadcaster's commitment transaction. This key is
386 /// static across every commitment transaction.
387 pub payment_point: PublicKey,
388 /// The base point which is used (with derive_public_key) to derive a per-commitment payment
389 /// public key which receives non-HTLC-encumbered funds which are only available for spending
390 /// after some delay (or can be claimed via the revocation path).
391 pub delayed_payment_basepoint: PublicKey,
392 /// The base point which is used (with derive_public_key) to derive a per-commitment public key
393 /// which is used to encumber HTLC-in-flight outputs.
394 pub htlc_basepoint: PublicKey,
397 impl_writeable_tlv_based!(ChannelPublicKeys, {
398 (0, funding_pubkey, required),
399 (2, revocation_basepoint, required),
400 (4, payment_point, required),
401 (6, delayed_payment_basepoint, required),
402 (8, htlc_basepoint, required),
405 impl TxCreationKeys {
406 /// Create per-state keys from channel base points and the per-commitment point.
407 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
408 pub fn derive_new<T: secp256k1::Signing + secp256k1::Verification>(secp_ctx: &Secp256k1<T>, per_commitment_point: &PublicKey, broadcaster_delayed_payment_base: &PublicKey, broadcaster_htlc_base: &PublicKey, countersignatory_revocation_base: &PublicKey, countersignatory_htlc_base: &PublicKey) -> Result<TxCreationKeys, SecpError> {
410 per_commitment_point: per_commitment_point.clone(),
411 revocation_key: derive_public_revocation_key(&secp_ctx, &per_commitment_point, &countersignatory_revocation_base)?,
412 broadcaster_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &broadcaster_htlc_base)?,
413 countersignatory_htlc_key: derive_public_key(&secp_ctx, &per_commitment_point, &countersignatory_htlc_base)?,
414 broadcaster_delayed_payment_key: derive_public_key(&secp_ctx, &per_commitment_point, &broadcaster_delayed_payment_base)?,
418 /// Generate per-state keys from channel static keys.
419 /// Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
420 pub fn from_channel_static_keys<T: secp256k1::Signing + secp256k1::Verification>(per_commitment_point: &PublicKey, broadcaster_keys: &ChannelPublicKeys, countersignatory_keys: &ChannelPublicKeys, secp_ctx: &Secp256k1<T>) -> Result<TxCreationKeys, SecpError> {
421 TxCreationKeys::derive_new(
423 &per_commitment_point,
424 &broadcaster_keys.delayed_payment_basepoint,
425 &broadcaster_keys.htlc_basepoint,
426 &countersignatory_keys.revocation_basepoint,
427 &countersignatory_keys.htlc_basepoint,
432 /// The maximum length of a script returned by get_revokeable_redeemscript.
433 // Calculated as 6 bytes of opcodes, 1 byte push plus 2 bytes for contest_delay, and two public
434 // keys of 33 bytes (+ 1 push).
435 pub const REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH: usize = 6 + 3 + 34*2;
437 /// A script either spendable by the revocation
438 /// key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
439 /// Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
440 pub fn get_revokeable_redeemscript(revocation_key: &PublicKey, contest_delay: u16, broadcaster_delayed_payment_key: &PublicKey) -> Script {
441 let res = Builder::new().push_opcode(opcodes::all::OP_IF)
442 .push_slice(&revocation_key.serialize())
443 .push_opcode(opcodes::all::OP_ELSE)
444 .push_int(contest_delay as i64)
445 .push_opcode(opcodes::all::OP_CSV)
446 .push_opcode(opcodes::all::OP_DROP)
447 .push_slice(&broadcaster_delayed_payment_key.serialize())
448 .push_opcode(opcodes::all::OP_ENDIF)
449 .push_opcode(opcodes::all::OP_CHECKSIG)
451 debug_assert!(res.len() <= REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH);
455 #[derive(Clone, PartialEq)]
456 /// Information about an HTLC as it appears in a commitment transaction
457 pub struct HTLCOutputInCommitment {
458 /// Whether the HTLC was "offered" (ie outbound in relation to this commitment transaction).
459 /// Note that this is not the same as whether it is ountbound *from us*. To determine that you
460 /// need to compare this value to whether the commitment transaction in question is that of
461 /// the counterparty or our own.
463 /// The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
464 /// this divided by 1000.
465 pub amount_msat: u64,
466 /// The CLTV lock-time at which this HTLC expires.
467 pub cltv_expiry: u32,
468 /// The hash of the preimage which unlocks this HTLC.
469 pub payment_hash: PaymentHash,
470 /// The position within the commitment transactions' outputs. This may be None if the value is
471 /// below the dust limit (in which case no output appears in the commitment transaction and the
472 /// value is spent to additional transaction fees).
473 pub transaction_output_index: Option<u32>,
476 impl_writeable_tlv_based!(HTLCOutputInCommitment, {
477 (0, offered, required),
478 (2, amount_msat, required),
479 (4, cltv_expiry, required),
480 (6, payment_hash, required),
481 (8, transaction_output_index, option),
485 pub(crate) fn get_htlc_redeemscript_with_explicit_keys(htlc: &HTLCOutputInCommitment, opt_anchors: bool, broadcaster_htlc_key: &PublicKey, countersignatory_htlc_key: &PublicKey, revocation_key: &PublicKey) -> Script {
486 let payment_hash160 = Ripemd160::hash(&htlc.payment_hash.0[..]).into_inner();
488 let mut bldr = Builder::new().push_opcode(opcodes::all::OP_DUP)
489 .push_opcode(opcodes::all::OP_HASH160)
490 .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
491 .push_opcode(opcodes::all::OP_EQUAL)
492 .push_opcode(opcodes::all::OP_IF)
493 .push_opcode(opcodes::all::OP_CHECKSIG)
494 .push_opcode(opcodes::all::OP_ELSE)
495 .push_slice(&countersignatory_htlc_key.serialize()[..])
496 .push_opcode(opcodes::all::OP_SWAP)
497 .push_opcode(opcodes::all::OP_SIZE)
499 .push_opcode(opcodes::all::OP_EQUAL)
500 .push_opcode(opcodes::all::OP_NOTIF)
501 .push_opcode(opcodes::all::OP_DROP)
503 .push_opcode(opcodes::all::OP_SWAP)
504 .push_slice(&broadcaster_htlc_key.serialize()[..])
506 .push_opcode(opcodes::all::OP_CHECKMULTISIG)
507 .push_opcode(opcodes::all::OP_ELSE)
508 .push_opcode(opcodes::all::OP_HASH160)
509 .push_slice(&payment_hash160)
510 .push_opcode(opcodes::all::OP_EQUALVERIFY)
511 .push_opcode(opcodes::all::OP_CHECKSIG)
512 .push_opcode(opcodes::all::OP_ENDIF);
514 bldr = bldr.push_opcode(opcodes::all::OP_PUSHNUM_1)
515 .push_opcode(opcodes::all::OP_CSV)
516 .push_opcode(opcodes::all::OP_DROP);
518 bldr.push_opcode(opcodes::all::OP_ENDIF)
521 let mut bldr = Builder::new().push_opcode(opcodes::all::OP_DUP)
522 .push_opcode(opcodes::all::OP_HASH160)
523 .push_slice(&PubkeyHash::hash(&revocation_key.serialize())[..])
524 .push_opcode(opcodes::all::OP_EQUAL)
525 .push_opcode(opcodes::all::OP_IF)
526 .push_opcode(opcodes::all::OP_CHECKSIG)
527 .push_opcode(opcodes::all::OP_ELSE)
528 .push_slice(&countersignatory_htlc_key.serialize()[..])
529 .push_opcode(opcodes::all::OP_SWAP)
530 .push_opcode(opcodes::all::OP_SIZE)
532 .push_opcode(opcodes::all::OP_EQUAL)
533 .push_opcode(opcodes::all::OP_IF)
534 .push_opcode(opcodes::all::OP_HASH160)
535 .push_slice(&payment_hash160)
536 .push_opcode(opcodes::all::OP_EQUALVERIFY)
538 .push_opcode(opcodes::all::OP_SWAP)
539 .push_slice(&broadcaster_htlc_key.serialize()[..])
541 .push_opcode(opcodes::all::OP_CHECKMULTISIG)
542 .push_opcode(opcodes::all::OP_ELSE)
543 .push_opcode(opcodes::all::OP_DROP)
544 .push_int(htlc.cltv_expiry as i64)
545 .push_opcode(opcodes::all::OP_CLTV)
546 .push_opcode(opcodes::all::OP_DROP)
547 .push_opcode(opcodes::all::OP_CHECKSIG)
548 .push_opcode(opcodes::all::OP_ENDIF);
550 bldr = bldr.push_opcode(opcodes::all::OP_PUSHNUM_1)
551 .push_opcode(opcodes::all::OP_CSV)
552 .push_opcode(opcodes::all::OP_DROP);
554 bldr.push_opcode(opcodes::all::OP_ENDIF)
559 /// Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
560 /// does not need to have its previous_output_index filled.
562 pub fn get_htlc_redeemscript(htlc: &HTLCOutputInCommitment, opt_anchors: bool, keys: &TxCreationKeys) -> Script {
563 get_htlc_redeemscript_with_explicit_keys(htlc, opt_anchors, &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key)
566 /// Gets the redeemscript for a funding output from the two funding public keys.
567 /// Note that the order of funding public keys does not matter.
568 pub fn make_funding_redeemscript(broadcaster: &PublicKey, countersignatory: &PublicKey) -> Script {
569 let broadcaster_funding_key = broadcaster.serialize();
570 let countersignatory_funding_key = countersignatory.serialize();
572 let builder = Builder::new().push_opcode(opcodes::all::OP_PUSHNUM_2);
573 if broadcaster_funding_key[..] < countersignatory_funding_key[..] {
574 builder.push_slice(&broadcaster_funding_key)
575 .push_slice(&countersignatory_funding_key)
577 builder.push_slice(&countersignatory_funding_key)
578 .push_slice(&broadcaster_funding_key)
579 }.push_opcode(opcodes::all::OP_PUSHNUM_2).push_opcode(opcodes::all::OP_CHECKMULTISIG).into_script()
582 /// Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
583 /// parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
584 /// transaction which needs signing, and can be used to construct an HTLC transaction which is
585 /// broadcastable given a counterparty HTLC signature.
587 /// Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
588 /// commitment transaction).
589 pub fn build_htlc_transaction(commitment_txid: &Txid, feerate_per_kw: u32, contest_delay: u16, htlc: &HTLCOutputInCommitment, opt_anchors: bool, broadcaster_delayed_payment_key: &PublicKey, revocation_key: &PublicKey) -> Transaction {
590 let mut txins: Vec<TxIn> = Vec::new();
592 previous_output: OutPoint {
593 txid: commitment_txid.clone(),
594 vout: htlc.transaction_output_index.expect("Can't build an HTLC transaction for a dust output"),
596 script_sig: Script::new(),
597 sequence: if opt_anchors { 1 } else { 0 },
601 let total_fee = if htlc.offered {
602 feerate_per_kw as u64 * HTLC_TIMEOUT_TX_WEIGHT / 1000
604 feerate_per_kw as u64 * HTLC_SUCCESS_TX_WEIGHT / 1000
607 let mut txouts: Vec<TxOut> = Vec::new();
609 script_pubkey: get_revokeable_redeemscript(revocation_key, contest_delay, broadcaster_delayed_payment_key).to_v0_p2wsh(),
610 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)
615 lock_time: if htlc.offered { htlc.cltv_expiry } else { 0 },
621 /// Gets the witnessScript for the to_remote output when anchors are enabled.
623 pub(crate) fn get_to_countersignatory_with_anchors_redeemscript(payment_point: &PublicKey) -> Script {
625 .push_slice(&payment_point.serialize()[..])
626 .push_opcode(opcodes::all::OP_CHECKSIGVERIFY)
628 .push_opcode(opcodes::all::OP_CSV)
632 /// Gets the witnessScript for an anchor output from the funding public key.
633 /// The witness in the spending input must be:
634 /// <BIP 143 funding_signature>
635 /// After 16 blocks of confirmation, an alternative satisfying witness could be:
637 /// (empty vector required to satisfy compliance with MINIMALIF-standard rule)
639 pub fn get_anchor_redeemscript(funding_pubkey: &PublicKey) -> Script {
640 Builder::new().push_slice(&funding_pubkey.serialize()[..])
641 .push_opcode(opcodes::all::OP_CHECKSIG)
642 .push_opcode(opcodes::all::OP_IFDUP)
643 .push_opcode(opcodes::all::OP_NOTIF)
645 .push_opcode(opcodes::all::OP_CSV)
646 .push_opcode(opcodes::all::OP_ENDIF)
650 /// Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
651 /// The fields are organized by holder/counterparty.
653 /// Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
654 /// before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
656 pub struct ChannelTransactionParameters {
657 /// Holder public keys
658 pub holder_pubkeys: ChannelPublicKeys,
659 /// The contest delay selected by the holder, which applies to counterparty-broadcast transactions
660 pub holder_selected_contest_delay: u16,
661 /// Whether the holder is the initiator of this channel.
662 /// This is an input to the commitment number obscure factor computation.
663 pub is_outbound_from_holder: bool,
664 /// The late-bound counterparty channel transaction parameters.
665 /// These parameters are populated at the point in the protocol where the counterparty provides them.
666 pub counterparty_parameters: Option<CounterpartyChannelTransactionParameters>,
667 /// The late-bound funding outpoint
668 pub funding_outpoint: Option<chain::transaction::OutPoint>,
669 /// Are anchors used for this channel. Boolean is serialization backwards-compatible
670 pub opt_anchors: Option<()>
673 /// Late-bound per-channel counterparty data used to build transactions.
675 pub struct CounterpartyChannelTransactionParameters {
676 /// Counter-party public keys
677 pub pubkeys: ChannelPublicKeys,
678 /// The contest delay selected by the counterparty, which applies to holder-broadcast transactions
679 pub selected_contest_delay: u16,
682 impl ChannelTransactionParameters {
683 /// Whether the late bound parameters are populated.
684 pub fn is_populated(&self) -> bool {
685 self.counterparty_parameters.is_some() && self.funding_outpoint.is_some()
688 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
689 /// given that the holder is the broadcaster.
691 /// self.is_populated() must be true before calling this function.
692 pub fn as_holder_broadcastable(&self) -> DirectedChannelTransactionParameters {
693 assert!(self.is_populated(), "self.late_parameters must be set before using as_holder_broadcastable");
694 DirectedChannelTransactionParameters {
696 holder_is_broadcaster: true
700 /// Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
701 /// given that the counterparty is the broadcaster.
703 /// self.is_populated() must be true before calling this function.
704 pub fn as_counterparty_broadcastable(&self) -> DirectedChannelTransactionParameters {
705 assert!(self.is_populated(), "self.late_parameters must be set before using as_counterparty_broadcastable");
706 DirectedChannelTransactionParameters {
708 holder_is_broadcaster: false
713 impl_writeable_tlv_based!(CounterpartyChannelTransactionParameters, {
714 (0, pubkeys, required),
715 (2, selected_contest_delay, required),
718 impl_writeable_tlv_based!(ChannelTransactionParameters, {
719 (0, holder_pubkeys, required),
720 (2, holder_selected_contest_delay, required),
721 (4, is_outbound_from_holder, required),
722 (6, counterparty_parameters, option),
723 (8, funding_outpoint, option),
724 (10, opt_anchors, option),
727 /// Static channel fields used to build transactions given per-commitment fields, organized by
728 /// broadcaster/countersignatory.
730 /// This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
731 /// as_holder_broadcastable and as_counterparty_broadcastable functions.
732 pub struct DirectedChannelTransactionParameters<'a> {
733 /// The holder's channel static parameters
734 inner: &'a ChannelTransactionParameters,
735 /// Whether the holder is the broadcaster
736 holder_is_broadcaster: bool,
739 impl<'a> DirectedChannelTransactionParameters<'a> {
740 /// Get the channel pubkeys for the broadcaster
741 pub fn broadcaster_pubkeys(&self) -> &ChannelPublicKeys {
742 if self.holder_is_broadcaster {
743 &self.inner.holder_pubkeys
745 &self.inner.counterparty_parameters.as_ref().unwrap().pubkeys
749 /// Get the channel pubkeys for the countersignatory
750 pub fn countersignatory_pubkeys(&self) -> &ChannelPublicKeys {
751 if self.holder_is_broadcaster {
752 &self.inner.counterparty_parameters.as_ref().unwrap().pubkeys
754 &self.inner.holder_pubkeys
758 /// Get the contest delay applicable to the transactions.
759 /// Note that the contest delay was selected by the countersignatory.
760 pub fn contest_delay(&self) -> u16 {
761 let counterparty_parameters = self.inner.counterparty_parameters.as_ref().unwrap();
762 if self.holder_is_broadcaster { counterparty_parameters.selected_contest_delay } else { self.inner.holder_selected_contest_delay }
765 /// Whether the channel is outbound from the broadcaster.
767 /// The boolean representing the side that initiated the channel is
768 /// an input to the commitment number obscure factor computation.
769 pub fn is_outbound(&self) -> bool {
770 if self.holder_is_broadcaster { self.inner.is_outbound_from_holder } else { !self.inner.is_outbound_from_holder }
773 /// The funding outpoint
774 pub fn funding_outpoint(&self) -> OutPoint {
775 self.inner.funding_outpoint.unwrap().into_bitcoin_outpoint()
778 /// Whether to use anchors for this channel
779 pub fn opt_anchors(&self) -> bool {
780 self.inner.opt_anchors.is_some()
784 /// Information needed to build and sign a holder's commitment transaction.
786 /// The transaction is only signed once we are ready to broadcast.
788 pub struct HolderCommitmentTransaction {
789 inner: CommitmentTransaction,
790 /// Our counterparty's signature for the transaction
791 pub counterparty_sig: Signature,
792 /// All non-dust counterparty HTLC signatures, in the order they appear in the transaction
793 pub counterparty_htlc_sigs: Vec<Signature>,
794 // Which order the signatures should go in when constructing the final commitment tx witness.
795 // The user should be able to reconstruct this themselves, so we don't bother to expose it.
796 holder_sig_first: bool,
799 impl Deref for HolderCommitmentTransaction {
800 type Target = CommitmentTransaction;
802 fn deref(&self) -> &Self::Target { &self.inner }
805 impl PartialEq for HolderCommitmentTransaction {
806 // We dont care whether we are signed in equality comparison
807 fn eq(&self, o: &Self) -> bool {
808 self.inner == o.inner
812 impl_writeable_tlv_based!(HolderCommitmentTransaction, {
813 (0, inner, required),
814 (2, counterparty_sig, required),
815 (4, holder_sig_first, required),
816 (6, counterparty_htlc_sigs, vec_type),
819 impl HolderCommitmentTransaction {
821 pub fn dummy() -> Self {
822 let secp_ctx = Secp256k1::new();
823 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
824 let dummy_sig = secp_ctx.sign(&secp256k1::Message::from_slice(&[42; 32]).unwrap(), &SecretKey::from_slice(&[42; 32]).unwrap());
826 let keys = TxCreationKeys {
827 per_commitment_point: dummy_key.clone(),
828 revocation_key: dummy_key.clone(),
829 broadcaster_htlc_key: dummy_key.clone(),
830 countersignatory_htlc_key: dummy_key.clone(),
831 broadcaster_delayed_payment_key: dummy_key.clone(),
833 let channel_pubkeys = ChannelPublicKeys {
834 funding_pubkey: dummy_key.clone(),
835 revocation_basepoint: dummy_key.clone(),
836 payment_point: dummy_key.clone(),
837 delayed_payment_basepoint: dummy_key.clone(),
838 htlc_basepoint: dummy_key.clone()
840 let channel_parameters = ChannelTransactionParameters {
841 holder_pubkeys: channel_pubkeys.clone(),
842 holder_selected_contest_delay: 0,
843 is_outbound_from_holder: false,
844 counterparty_parameters: Some(CounterpartyChannelTransactionParameters { pubkeys: channel_pubkeys.clone(), selected_contest_delay: 0 }),
845 funding_outpoint: Some(chain::transaction::OutPoint { txid: Default::default(), index: 0 }),
848 let mut htlcs_with_aux: Vec<(_, ())> = Vec::new();
849 let inner = CommitmentTransaction::new_with_auxiliary_htlc_data(0, 0, 0, false, dummy_key.clone(), dummy_key.clone(), keys, 0, &mut htlcs_with_aux, &channel_parameters.as_counterparty_broadcastable());
850 HolderCommitmentTransaction {
852 counterparty_sig: dummy_sig,
853 counterparty_htlc_sigs: Vec::new(),
854 holder_sig_first: false
858 /// Create a new holder transaction with the given counterparty signatures.
859 /// The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
860 pub fn new(commitment_tx: CommitmentTransaction, counterparty_sig: Signature, counterparty_htlc_sigs: Vec<Signature>, holder_funding_key: &PublicKey, counterparty_funding_key: &PublicKey) -> Self {
862 inner: commitment_tx,
864 counterparty_htlc_sigs,
865 holder_sig_first: holder_funding_key.serialize()[..] < counterparty_funding_key.serialize()[..],
869 pub(crate) fn add_holder_sig(&self, funding_redeemscript: &Script, holder_sig: Signature) -> Transaction {
870 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
871 let mut tx = self.inner.built.transaction.clone();
872 tx.input[0].witness.push(Vec::new());
874 if self.holder_sig_first {
875 tx.input[0].witness.push(holder_sig.serialize_der().to_vec());
876 tx.input[0].witness.push(self.counterparty_sig.serialize_der().to_vec());
878 tx.input[0].witness.push(self.counterparty_sig.serialize_der().to_vec());
879 tx.input[0].witness.push(holder_sig.serialize_der().to_vec());
881 tx.input[0].witness[1].push(SigHashType::All as u8);
882 tx.input[0].witness[2].push(SigHashType::All as u8);
884 tx.input[0].witness.push(funding_redeemscript.as_bytes().to_vec());
889 /// A pre-built Bitcoin commitment transaction and its txid.
891 pub struct BuiltCommitmentTransaction {
892 /// The commitment transaction
893 pub transaction: Transaction,
894 /// The txid for the commitment transaction.
896 /// This is provided as a performance optimization, instead of calling transaction.txid()
901 impl_writeable_tlv_based!(BuiltCommitmentTransaction, {
902 (0, transaction, required),
906 impl BuiltCommitmentTransaction {
907 /// Get the SIGHASH_ALL sighash value of the transaction.
909 /// This can be used to verify a signature.
910 pub fn get_sighash_all(&self, funding_redeemscript: &Script, channel_value_satoshis: u64) -> Message {
911 let sighash = &bip143::SigHashCache::new(&self.transaction).signature_hash(0, funding_redeemscript, channel_value_satoshis, SigHashType::All)[..];
912 hash_to_message!(sighash)
915 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
916 /// because we are about to broadcast a holder transaction.
917 pub fn sign<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
918 let sighash = self.get_sighash_all(funding_redeemscript, channel_value_satoshis);
919 secp_ctx.sign(&sighash, funding_key)
923 /// This class tracks the per-transaction information needed to build a closing transaction and will
924 /// actually build it and sign.
926 /// This class can be used inside a signer implementation to generate a signature given the relevant
928 pub struct ClosingTransaction {
929 to_holder_value_sat: u64,
930 to_counterparty_value_sat: u64,
931 to_holder_script: Script,
932 to_counterparty_script: Script,
936 impl ClosingTransaction {
937 /// Construct an object of the class
939 to_holder_value_sat: u64,
940 to_counterparty_value_sat: u64,
941 to_holder_script: Script,
942 to_counterparty_script: Script,
943 funding_outpoint: OutPoint,
945 let built = build_closing_transaction(
946 to_holder_value_sat, to_counterparty_value_sat,
947 to_holder_script.clone(), to_counterparty_script.clone(),
952 to_counterparty_value_sat,
954 to_counterparty_script,
959 /// Trust our pre-built transaction.
961 /// Applies a wrapper which allows access to the transaction.
963 /// This should only be used if you fully trust the builder of this object. It should not
964 /// be used by an external signer - instead use the verify function.
965 pub fn trust(&self) -> TrustedClosingTransaction {
966 TrustedClosingTransaction { inner: self }
969 /// Verify our pre-built transaction.
971 /// Applies a wrapper which allows access to the transaction.
973 /// An external validating signer must call this method before signing
974 /// or using the built transaction.
975 pub fn verify(&self, funding_outpoint: OutPoint) -> Result<TrustedClosingTransaction, ()> {
976 let built = build_closing_transaction(
977 self.to_holder_value_sat, self.to_counterparty_value_sat,
978 self.to_holder_script.clone(), self.to_counterparty_script.clone(),
981 if self.built != built {
984 Ok(TrustedClosingTransaction { inner: self })
987 /// The value to be sent to the holder, or zero if the output will be omitted
988 pub fn to_holder_value_sat(&self) -> u64 {
989 self.to_holder_value_sat
992 /// The value to be sent to the counterparty, or zero if the output will be omitted
993 pub fn to_counterparty_value_sat(&self) -> u64 {
994 self.to_counterparty_value_sat
997 /// The destination of the holder's output
998 pub fn to_holder_script(&self) -> &Script {
999 &self.to_holder_script
1002 /// The destination of the counterparty's output
1003 pub fn to_counterparty_script(&self) -> &Script {
1004 &self.to_counterparty_script
1008 /// A wrapper on ClosingTransaction indicating that the built bitcoin
1009 /// transaction is trusted.
1011 /// See trust() and verify() functions on CommitmentTransaction.
1013 /// This structure implements Deref.
1014 pub struct TrustedClosingTransaction<'a> {
1015 inner: &'a ClosingTransaction,
1018 impl<'a> Deref for TrustedClosingTransaction<'a> {
1019 type Target = ClosingTransaction;
1021 fn deref(&self) -> &Self::Target { self.inner }
1024 impl<'a> TrustedClosingTransaction<'a> {
1025 /// The pre-built Bitcoin commitment transaction
1026 pub fn built_transaction(&self) -> &Transaction {
1030 /// Get the SIGHASH_ALL sighash value of the transaction.
1032 /// This can be used to verify a signature.
1033 pub fn get_sighash_all(&self, funding_redeemscript: &Script, channel_value_satoshis: u64) -> Message {
1034 let sighash = &bip143::SigHashCache::new(&self.inner.built).signature_hash(0, funding_redeemscript, channel_value_satoshis, SigHashType::All)[..];
1035 hash_to_message!(sighash)
1038 /// Sign a transaction, either because we are counter-signing the counterparty's transaction or
1039 /// because we are about to broadcast a holder transaction.
1040 pub fn sign<T: secp256k1::Signing>(&self, funding_key: &SecretKey, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) -> Signature {
1041 let sighash = self.get_sighash_all(funding_redeemscript, channel_value_satoshis);
1042 secp_ctx.sign(&sighash, funding_key)
1046 /// This class tracks the per-transaction information needed to build a commitment transaction and will
1047 /// actually build it and sign. It is used for holder transactions that we sign only when needed
1048 /// and for transactions we sign for the counterparty.
1050 /// This class can be used inside a signer implementation to generate a signature given the relevant
1053 pub struct CommitmentTransaction {
1054 commitment_number: u64,
1055 to_broadcaster_value_sat: u64,
1056 to_countersignatory_value_sat: u64,
1057 feerate_per_kw: u32,
1058 htlcs: Vec<HTLCOutputInCommitment>,
1059 // A boolean that is serialization backwards-compatible
1060 opt_anchors: Option<()>,
1061 // A cache of the parties' pubkeys required to construct the transaction, see doc for trust()
1062 keys: TxCreationKeys,
1063 // For access to the pre-built transaction, see doc for trust()
1064 built: BuiltCommitmentTransaction,
1067 impl PartialEq for CommitmentTransaction {
1068 fn eq(&self, o: &Self) -> bool {
1069 let eq = self.commitment_number == o.commitment_number &&
1070 self.to_broadcaster_value_sat == o.to_broadcaster_value_sat &&
1071 self.to_countersignatory_value_sat == o.to_countersignatory_value_sat &&
1072 self.feerate_per_kw == o.feerate_per_kw &&
1073 self.htlcs == o.htlcs &&
1074 self.opt_anchors == o.opt_anchors &&
1075 self.keys == o.keys;
1077 debug_assert_eq!(self.built.transaction, o.built.transaction);
1078 debug_assert_eq!(self.built.txid, o.built.txid);
1084 impl_writeable_tlv_based!(CommitmentTransaction, {
1085 (0, commitment_number, required),
1086 (2, to_broadcaster_value_sat, required),
1087 (4, to_countersignatory_value_sat, required),
1088 (6, feerate_per_kw, required),
1089 (8, keys, required),
1090 (10, built, required),
1091 (12, htlcs, vec_type),
1092 (14, opt_anchors, option),
1095 impl CommitmentTransaction {
1096 /// Construct an object of the class while assigning transaction output indices to HTLCs.
1098 /// Populates HTLCOutputInCommitment.transaction_output_index in htlcs_with_aux.
1100 /// The generic T allows the caller to match the HTLC output index with auxiliary data.
1101 /// This auxiliary data is not stored in this object.
1103 /// Only include HTLCs that are above the dust limit for the channel.
1105 /// (C-not exported) due to the generic though we likely should expose a version without
1106 pub fn new_with_auxiliary_htlc_data<T>(commitment_number: u64, to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, opt_anchors: bool, broadcaster_funding_key: PublicKey, countersignatory_funding_key: PublicKey, keys: TxCreationKeys, feerate_per_kw: u32, htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>, channel_parameters: &DirectedChannelTransactionParameters) -> CommitmentTransaction {
1107 // Sort outputs and populate output indices while keeping track of the auxiliary data
1108 let (outputs, htlcs) = Self::internal_build_outputs(&keys, to_broadcaster_value_sat, to_countersignatory_value_sat, htlcs_with_aux, channel_parameters, opt_anchors, &broadcaster_funding_key, &countersignatory_funding_key).unwrap();
1110 let (obscured_commitment_transaction_number, txins) = Self::internal_build_inputs(commitment_number, channel_parameters);
1111 let transaction = Self::make_transaction(obscured_commitment_transaction_number, txins, outputs);
1112 let txid = transaction.txid();
1113 CommitmentTransaction {
1115 to_broadcaster_value_sat,
1116 to_countersignatory_value_sat,
1119 opt_anchors: if opt_anchors { Some(()) } else { None },
1121 built: BuiltCommitmentTransaction {
1128 fn internal_rebuild_transaction(&self, keys: &TxCreationKeys, channel_parameters: &DirectedChannelTransactionParameters, broadcaster_funding_key: &PublicKey, countersignatory_funding_key: &PublicKey) -> Result<BuiltCommitmentTransaction, ()> {
1129 let (obscured_commitment_transaction_number, txins) = Self::internal_build_inputs(self.commitment_number, channel_parameters);
1131 let mut htlcs_with_aux = self.htlcs.iter().map(|h| (h.clone(), ())).collect();
1132 let (outputs, _) = Self::internal_build_outputs(keys, self.to_broadcaster_value_sat, self.to_countersignatory_value_sat, &mut htlcs_with_aux, channel_parameters, self.opt_anchors.is_some(), broadcaster_funding_key, countersignatory_funding_key)?;
1134 let transaction = Self::make_transaction(obscured_commitment_transaction_number, txins, outputs);
1135 let txid = transaction.txid();
1136 let built_transaction = BuiltCommitmentTransaction {
1140 Ok(built_transaction)
1143 fn make_transaction(obscured_commitment_transaction_number: u64, txins: Vec<TxIn>, outputs: Vec<TxOut>) -> Transaction {
1146 lock_time: ((0x20 as u32) << 8 * 3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32),
1152 // This is used in two cases:
1153 // - initial sorting of outputs / HTLCs in the constructor, in which case T is auxiliary data the
1154 // caller needs to have sorted together with the HTLCs so it can keep track of the output index
1155 // - building of a bitcoin transaction during a verify() call, in which case T is just ()
1156 fn internal_build_outputs<T>(keys: &TxCreationKeys, to_broadcaster_value_sat: u64, to_countersignatory_value_sat: u64, htlcs_with_aux: &mut Vec<(HTLCOutputInCommitment, T)>, channel_parameters: &DirectedChannelTransactionParameters, opt_anchors: bool, broadcaster_funding_key: &PublicKey, countersignatory_funding_key: &PublicKey) -> Result<(Vec<TxOut>, Vec<HTLCOutputInCommitment>), ()> {
1157 let countersignatory_pubkeys = channel_parameters.countersignatory_pubkeys();
1158 let contest_delay = channel_parameters.contest_delay();
1160 let mut txouts: Vec<(TxOut, Option<&mut HTLCOutputInCommitment>)> = Vec::new();
1162 if to_countersignatory_value_sat > 0 {
1163 let script = if opt_anchors {
1164 get_to_countersignatory_with_anchors_redeemscript(&countersignatory_pubkeys.payment_point).to_v0_p2wsh()
1166 get_p2wpkh_redeemscript(&countersignatory_pubkeys.payment_point)
1170 script_pubkey: script.clone(),
1171 value: to_countersignatory_value_sat,
1177 if to_broadcaster_value_sat > 0 {
1178 let redeem_script = get_revokeable_redeemscript(
1179 &keys.revocation_key,
1181 &keys.broadcaster_delayed_payment_key,
1185 script_pubkey: redeem_script.to_v0_p2wsh(),
1186 value: to_broadcaster_value_sat,
1193 if to_broadcaster_value_sat > 0 || !htlcs_with_aux.is_empty() {
1194 let anchor_script = get_anchor_redeemscript(broadcaster_funding_key);
1197 script_pubkey: anchor_script.to_v0_p2wsh(),
1198 value: ANCHOR_OUTPUT_VALUE_SATOSHI,
1204 if to_countersignatory_value_sat > 0 || !htlcs_with_aux.is_empty() {
1205 let anchor_script = get_anchor_redeemscript(countersignatory_funding_key);
1208 script_pubkey: anchor_script.to_v0_p2wsh(),
1209 value: ANCHOR_OUTPUT_VALUE_SATOSHI,
1216 let mut htlcs = Vec::with_capacity(htlcs_with_aux.len());
1217 for (htlc, _) in htlcs_with_aux {
1218 let script = chan_utils::get_htlc_redeemscript(&htlc, opt_anchors, &keys);
1220 script_pubkey: script.to_v0_p2wsh(),
1221 value: htlc.amount_msat / 1000,
1223 txouts.push((txout, Some(htlc)));
1226 // Sort output in BIP-69 order (amount, scriptPubkey). Tie-breaks based on HTLC
1227 // CLTV expiration height.
1228 sort_outputs(&mut txouts, |a, b| {
1229 if let &Some(ref a_htlcout) = a {
1230 if let &Some(ref b_htlcout) = b {
1231 a_htlcout.cltv_expiry.cmp(&b_htlcout.cltv_expiry)
1232 // Note that due to hash collisions, we have to have a fallback comparison
1233 // here for fuzztarget mode (otherwise at least chanmon_fail_consistency
1235 .then(a_htlcout.payment_hash.0.cmp(&b_htlcout.payment_hash.0))
1236 // For non-HTLC outputs, if they're copying our SPK we don't really care if we
1237 // close the channel due to mismatches - they're doing something dumb:
1238 } else { cmp::Ordering::Equal }
1239 } else { cmp::Ordering::Equal }
1242 let mut outputs = Vec::with_capacity(txouts.len());
1243 for (idx, out) in txouts.drain(..).enumerate() {
1244 if let Some(htlc) = out.1 {
1245 htlc.transaction_output_index = Some(idx as u32);
1246 htlcs.push(htlc.clone());
1248 outputs.push(out.0);
1250 Ok((outputs, htlcs))
1253 fn internal_build_inputs(commitment_number: u64, channel_parameters: &DirectedChannelTransactionParameters) -> (u64, Vec<TxIn>) {
1254 let broadcaster_pubkeys = channel_parameters.broadcaster_pubkeys();
1255 let countersignatory_pubkeys = channel_parameters.countersignatory_pubkeys();
1256 let commitment_transaction_number_obscure_factor = get_commitment_transaction_number_obscure_factor(
1257 &broadcaster_pubkeys.payment_point,
1258 &countersignatory_pubkeys.payment_point,
1259 channel_parameters.is_outbound(),
1262 let obscured_commitment_transaction_number =
1263 commitment_transaction_number_obscure_factor ^ (INITIAL_COMMITMENT_NUMBER - commitment_number);
1266 let mut ins: Vec<TxIn> = Vec::new();
1268 previous_output: channel_parameters.funding_outpoint(),
1269 script_sig: Script::new(),
1270 sequence: ((0x80 as u32) << 8 * 3)
1271 | ((obscured_commitment_transaction_number >> 3 * 8) as u32),
1272 witness: Vec::new(),
1276 (obscured_commitment_transaction_number, txins)
1279 /// The backwards-counting commitment number
1280 pub fn commitment_number(&self) -> u64 {
1281 self.commitment_number
1284 /// The value to be sent to the broadcaster
1285 pub fn to_broadcaster_value_sat(&self) -> u64 {
1286 self.to_broadcaster_value_sat
1289 /// The value to be sent to the counterparty
1290 pub fn to_countersignatory_value_sat(&self) -> u64 {
1291 self.to_countersignatory_value_sat
1294 /// The feerate paid per 1000-weight-unit in this commitment transaction.
1295 pub fn feerate_per_kw(&self) -> u32 {
1299 /// The non-dust HTLCs (direction, amt, height expiration, hash, transaction output index)
1300 /// which were included in this commitment transaction in output order.
1301 /// The transaction index is always populated.
1303 /// (C-not exported) as we cannot currently convert Vec references to/from C, though we should
1304 /// expose a less effecient version which creates a Vec of references in the future.
1305 pub fn htlcs(&self) -> &Vec<HTLCOutputInCommitment> {
1309 /// Trust our pre-built transaction and derived transaction creation public keys.
1311 /// Applies a wrapper which allows access to these fields.
1313 /// This should only be used if you fully trust the builder of this object. It should not
1314 /// be used by an external signer - instead use the verify function.
1315 pub fn trust(&self) -> TrustedCommitmentTransaction {
1316 TrustedCommitmentTransaction { inner: self }
1319 /// Verify our pre-built transaction and derived transaction creation public keys.
1321 /// Applies a wrapper which allows access to these fields.
1323 /// An external validating signer must call this method before signing
1324 /// or using the built transaction.
1325 pub fn verify<T: secp256k1::Signing + secp256k1::Verification>(&self, channel_parameters: &DirectedChannelTransactionParameters, broadcaster_keys: &ChannelPublicKeys, countersignatory_keys: &ChannelPublicKeys, secp_ctx: &Secp256k1<T>) -> Result<TrustedCommitmentTransaction, ()> {
1326 // This is the only field of the key cache that we trust
1327 let per_commitment_point = self.keys.per_commitment_point;
1328 let keys = TxCreationKeys::from_channel_static_keys(&per_commitment_point, broadcaster_keys, countersignatory_keys, secp_ctx).unwrap();
1329 if keys != self.keys {
1332 let tx = self.internal_rebuild_transaction(&keys, channel_parameters, &broadcaster_keys.funding_pubkey, &countersignatory_keys.funding_pubkey)?;
1333 if self.built.transaction != tx.transaction || self.built.txid != tx.txid {
1336 Ok(TrustedCommitmentTransaction { inner: self })
1340 /// A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1341 /// transaction and the transaction creation keys) are trusted.
1343 /// See trust() and verify() functions on CommitmentTransaction.
1345 /// This structure implements Deref.
1346 pub struct TrustedCommitmentTransaction<'a> {
1347 inner: &'a CommitmentTransaction,
1350 impl<'a> Deref for TrustedCommitmentTransaction<'a> {
1351 type Target = CommitmentTransaction;
1353 fn deref(&self) -> &Self::Target { self.inner }
1356 impl<'a> TrustedCommitmentTransaction<'a> {
1357 /// The transaction ID of the built Bitcoin transaction
1358 pub fn txid(&self) -> Txid {
1359 self.inner.built.txid
1362 /// The pre-built Bitcoin commitment transaction
1363 pub fn built_transaction(&self) -> &BuiltCommitmentTransaction {
1367 /// The pre-calculated transaction creation public keys.
1368 pub fn keys(&self) -> &TxCreationKeys {
1372 /// Should anchors be used.
1373 pub fn opt_anchors(&self) -> bool {
1374 self.opt_anchors.is_some()
1377 /// Get a signature for each HTLC which was included in the commitment transaction (ie for
1378 /// which HTLCOutputInCommitment::transaction_output_index.is_some()).
1380 /// The returned Vec has one entry for each HTLC, and in the same order.
1381 pub fn get_htlc_sigs<T: secp256k1::Signing>(&self, htlc_base_key: &SecretKey, channel_parameters: &DirectedChannelTransactionParameters, secp_ctx: &Secp256k1<T>) -> Result<Vec<Signature>, ()> {
1382 let inner = self.inner;
1383 let keys = &inner.keys;
1384 let txid = inner.built.txid;
1385 let mut ret = Vec::with_capacity(inner.htlcs.len());
1386 let holder_htlc_key = derive_private_key(secp_ctx, &inner.keys.per_commitment_point, htlc_base_key).map_err(|_| ())?;
1388 for this_htlc in inner.htlcs.iter() {
1389 assert!(this_htlc.transaction_output_index.is_some());
1390 let htlc_tx = build_htlc_transaction(&txid, inner.feerate_per_kw, channel_parameters.contest_delay(), &this_htlc, self.opt_anchors(), &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
1392 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc, self.opt_anchors(), &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key);
1394 let sighash = hash_to_message!(&bip143::SigHashCache::new(&htlc_tx).signature_hash(0, &htlc_redeemscript, this_htlc.amount_msat / 1000, SigHashType::All)[..]);
1395 ret.push(secp_ctx.sign(&sighash, &holder_htlc_key));
1400 /// Gets a signed HTLC transaction given a preimage (for !htlc.offered) and the holder HTLC transaction signature.
1401 pub(crate) fn get_signed_htlc_tx(&self, channel_parameters: &DirectedChannelTransactionParameters, htlc_index: usize, counterparty_signature: &Signature, signature: &Signature, preimage: &Option<PaymentPreimage>) -> Transaction {
1402 let inner = self.inner;
1403 let keys = &inner.keys;
1404 let txid = inner.built.txid;
1405 let this_htlc = &inner.htlcs[htlc_index];
1406 assert!(this_htlc.transaction_output_index.is_some());
1407 // if we don't have preimage for an HTLC-Success, we can't generate an HTLC transaction.
1408 if !this_htlc.offered && preimage.is_none() { unreachable!(); }
1409 // Further, we should never be provided the preimage for an HTLC-Timeout transaction.
1410 if this_htlc.offered && preimage.is_some() { unreachable!(); }
1412 let mut htlc_tx = build_htlc_transaction(&txid, inner.feerate_per_kw, channel_parameters.contest_delay(), &this_htlc, self.opt_anchors(), &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
1414 let htlc_redeemscript = get_htlc_redeemscript_with_explicit_keys(&this_htlc, self.opt_anchors(), &keys.broadcaster_htlc_key, &keys.countersignatory_htlc_key, &keys.revocation_key);
1416 // First push the multisig dummy, note that due to BIP147 (NULLDUMMY) it must be a zero-length element.
1417 htlc_tx.input[0].witness.push(Vec::new());
1419 htlc_tx.input[0].witness.push(counterparty_signature.serialize_der().to_vec());
1420 htlc_tx.input[0].witness.push(signature.serialize_der().to_vec());
1421 htlc_tx.input[0].witness[1].push(SigHashType::All as u8);
1422 htlc_tx.input[0].witness[2].push(SigHashType::All as u8);
1424 if this_htlc.offered {
1425 // Due to BIP146 (MINIMALIF) this must be a zero-length element to relay.
1426 htlc_tx.input[0].witness.push(Vec::new());
1428 htlc_tx.input[0].witness.push(preimage.unwrap().0.to_vec());
1431 htlc_tx.input[0].witness.push(htlc_redeemscript.as_bytes().to_vec());
1436 /// Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
1437 /// shared secret first. This prevents on-chain observers from discovering how many commitment
1438 /// transactions occurred in a channel before it was closed.
1440 /// This function gets the shared secret from relevant channel public keys and can be used to
1441 /// "decrypt" the commitment transaction number given a commitment transaction on-chain.
1442 pub fn get_commitment_transaction_number_obscure_factor(
1443 broadcaster_payment_basepoint: &PublicKey,
1444 countersignatory_payment_basepoint: &PublicKey,
1445 outbound_from_broadcaster: bool,
1447 let mut sha = Sha256::engine();
1449 if outbound_from_broadcaster {
1450 sha.input(&broadcaster_payment_basepoint.serialize());
1451 sha.input(&countersignatory_payment_basepoint.serialize());
1453 sha.input(&countersignatory_payment_basepoint.serialize());
1454 sha.input(&broadcaster_payment_basepoint.serialize());
1456 let res = Sha256::from_engine(sha).into_inner();
1458 ((res[26] as u64) << 5 * 8)
1459 | ((res[27] as u64) << 4 * 8)
1460 | ((res[28] as u64) << 3 * 8)
1461 | ((res[29] as u64) << 2 * 8)
1462 | ((res[30] as u64) << 1 * 8)
1463 | ((res[31] as u64) << 0 * 8)
1466 fn get_p2wpkh_redeemscript(key: &PublicKey) -> Script {
1467 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1468 .push_slice(&WPubkeyHash::hash(&key.serialize())[..])
1474 use super::CounterpartyCommitmentSecrets;
1477 use ln::chan_utils::{get_htlc_redeemscript, get_to_countersignatory_with_anchors_redeemscript, get_p2wpkh_redeemscript, CommitmentTransaction, TxCreationKeys, ChannelTransactionParameters, CounterpartyChannelTransactionParameters, HTLCOutputInCommitment};
1478 use bitcoin::secp256k1::{PublicKey, SecretKey, Secp256k1};
1479 use util::test_utils;
1480 use chain::keysinterface::{KeysInterface, BaseSign};
1481 use bitcoin::Network;
1482 use ln::PaymentHash;
1486 let secp_ctx = Secp256k1::new();
1488 let seed = [42; 32];
1489 let network = Network::Testnet;
1490 let keys_provider = test_utils::TestKeysInterface::new(&seed, network);
1491 let signer = keys_provider.get_channel_signer(false, 3000);
1492 let counterparty_signer = keys_provider.get_channel_signer(false, 3000);
1493 let delayed_payment_base = &signer.pubkeys().delayed_payment_basepoint;
1494 let per_commitment_secret = SecretKey::from_slice(&hex::decode("1f1e1d1c1b1a191817161514131211100f0e0d0c0b0a09080706050403020100").unwrap()[..]).unwrap();
1495 let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &per_commitment_secret);
1496 let htlc_basepoint = &signer.pubkeys().htlc_basepoint;
1497 let holder_pubkeys = signer.pubkeys();
1498 let counterparty_pubkeys = counterparty_signer.pubkeys();
1499 let keys = TxCreationKeys::derive_new(&secp_ctx, &per_commitment_point, delayed_payment_base, htlc_basepoint, &counterparty_pubkeys.revocation_basepoint, &counterparty_pubkeys.htlc_basepoint).unwrap();
1500 let mut channel_parameters = ChannelTransactionParameters {
1501 holder_pubkeys: holder_pubkeys.clone(),
1502 holder_selected_contest_delay: 0,
1503 is_outbound_from_holder: false,
1504 counterparty_parameters: Some(CounterpartyChannelTransactionParameters { pubkeys: counterparty_pubkeys.clone(), selected_contest_delay: 0 }),
1505 funding_outpoint: Some(chain::transaction::OutPoint { txid: Default::default(), index: 0 }),
1509 let mut htlcs_with_aux: Vec<(_, ())> = Vec::new();
1511 // Generate broadcaster and counterparty outputs
1512 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1515 holder_pubkeys.funding_pubkey,
1516 counterparty_pubkeys.funding_pubkey,
1518 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1520 assert_eq!(tx.built.transaction.output.len(), 2);
1521 assert_eq!(tx.built.transaction.output[1].script_pubkey, get_p2wpkh_redeemscript(&counterparty_pubkeys.payment_point));
1523 // Generate broadcaster and counterparty outputs as well as two anchors
1524 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1527 holder_pubkeys.funding_pubkey,
1528 counterparty_pubkeys.funding_pubkey,
1530 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1532 assert_eq!(tx.built.transaction.output.len(), 4);
1533 assert_eq!(tx.built.transaction.output[3].script_pubkey, get_to_countersignatory_with_anchors_redeemscript(&counterparty_pubkeys.payment_point).to_v0_p2wsh());
1535 // Generate broadcaster output and anchor
1536 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1539 holder_pubkeys.funding_pubkey,
1540 counterparty_pubkeys.funding_pubkey,
1542 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1544 assert_eq!(tx.built.transaction.output.len(), 2);
1546 // Generate counterparty output and anchor
1547 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1550 holder_pubkeys.funding_pubkey,
1551 counterparty_pubkeys.funding_pubkey,
1553 &mut htlcs_with_aux, &channel_parameters.as_holder_broadcastable()
1555 assert_eq!(tx.built.transaction.output.len(), 2);
1557 let received_htlc = HTLCOutputInCommitment {
1559 amount_msat: 400000,
1561 payment_hash: PaymentHash([42; 32]),
1562 transaction_output_index: None,
1565 let offered_htlc = HTLCOutputInCommitment {
1567 amount_msat: 600000,
1569 payment_hash: PaymentHash([43; 32]),
1570 transaction_output_index: None,
1573 // Generate broadcaster output and received and offered HTLC outputs, w/o anchors
1574 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1577 holder_pubkeys.funding_pubkey,
1578 counterparty_pubkeys.funding_pubkey,
1580 &mut vec![(received_htlc.clone(), ()), (offered_htlc.clone(), ())],
1581 &channel_parameters.as_holder_broadcastable()
1583 assert_eq!(tx.built.transaction.output.len(), 3);
1584 assert_eq!(tx.built.transaction.output[0].script_pubkey, get_htlc_redeemscript(&received_htlc, false, &keys).to_v0_p2wsh());
1585 assert_eq!(tx.built.transaction.output[1].script_pubkey, get_htlc_redeemscript(&offered_htlc, false, &keys).to_v0_p2wsh());
1587 // Generate broadcaster output and received and offered HTLC outputs, with anchors
1588 channel_parameters.opt_anchors = Some(());
1589 let tx = CommitmentTransaction::new_with_auxiliary_htlc_data(
1592 holder_pubkeys.funding_pubkey,
1593 counterparty_pubkeys.funding_pubkey,
1595 &mut vec![(received_htlc.clone(), ()), (offered_htlc.clone(), ())],
1596 &channel_parameters.as_holder_broadcastable()
1598 assert_eq!(tx.built.transaction.output.len(), 5);
1599 assert_eq!(tx.built.transaction.output[2].script_pubkey, get_htlc_redeemscript(&received_htlc, true, &keys).to_v0_p2wsh());
1600 assert_eq!(tx.built.transaction.output[3].script_pubkey, get_htlc_redeemscript(&offered_htlc, true, &keys).to_v0_p2wsh());
1604 fn test_per_commitment_storage() {
1605 // Test vectors from BOLT 3:
1606 let mut secrets: Vec<[u8; 32]> = Vec::new();
1609 macro_rules! test_secrets {
1611 let mut idx = 281474976710655;
1612 for secret in secrets.iter() {
1613 assert_eq!(monitor.get_secret(idx).unwrap(), *secret);
1616 assert_eq!(monitor.get_min_seen_secret(), idx + 1);
1617 assert!(monitor.get_secret(idx).is_none());
1622 // insert_secret correct sequence
1623 monitor = CounterpartyCommitmentSecrets::new();
1626 secrets.push([0; 32]);
1627 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1628 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1631 secrets.push([0; 32]);
1632 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1633 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1636 secrets.push([0; 32]);
1637 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1638 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1641 secrets.push([0; 32]);
1642 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1643 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1646 secrets.push([0; 32]);
1647 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1648 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1651 secrets.push([0; 32]);
1652 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1653 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1656 secrets.push([0; 32]);
1657 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1658 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1661 secrets.push([0; 32]);
1662 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1663 monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).unwrap();
1668 // insert_secret #1 incorrect
1669 monitor = CounterpartyCommitmentSecrets::new();
1672 secrets.push([0; 32]);
1673 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1674 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1677 secrets.push([0; 32]);
1678 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1679 assert!(monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).is_err());
1683 // insert_secret #2 incorrect (#1 derived from incorrect)
1684 monitor = CounterpartyCommitmentSecrets::new();
1687 secrets.push([0; 32]);
1688 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1689 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1692 secrets.push([0; 32]);
1693 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
1694 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1697 secrets.push([0; 32]);
1698 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1699 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1702 secrets.push([0; 32]);
1703 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1704 assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
1708 // insert_secret #3 incorrect
1709 monitor = CounterpartyCommitmentSecrets::new();
1712 secrets.push([0; 32]);
1713 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1714 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1717 secrets.push([0; 32]);
1718 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1719 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1722 secrets.push([0; 32]);
1723 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
1724 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1727 secrets.push([0; 32]);
1728 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1729 assert!(monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).is_err());
1733 // insert_secret #4 incorrect (1,2,3 derived from incorrect)
1734 monitor = CounterpartyCommitmentSecrets::new();
1737 secrets.push([0; 32]);
1738 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("02a40c85b6f28da08dfdbe0926c53fab2de6d28c10301f8f7c4073d5e42e3148").unwrap());
1739 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1742 secrets.push([0; 32]);
1743 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("dddc3a8d14fddf2b68fa8c7fbad2748274937479dd0f8930d5ebb4ab6bd866a3").unwrap());
1744 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1747 secrets.push([0; 32]);
1748 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c51a18b13e8527e579ec56365482c62f180b7d5760b46e9477dae59e87ed423a").unwrap());
1749 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1752 secrets.push([0; 32]);
1753 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("ba65d7b0ef55a3ba300d4e87af29868f394f8f138d78a7011669c79b37b936f4").unwrap());
1754 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1757 secrets.push([0; 32]);
1758 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1759 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1762 secrets.push([0; 32]);
1763 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1764 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1767 secrets.push([0; 32]);
1768 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1769 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1772 secrets.push([0; 32]);
1773 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1774 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1778 // insert_secret #5 incorrect
1779 monitor = CounterpartyCommitmentSecrets::new();
1782 secrets.push([0; 32]);
1783 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1784 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1787 secrets.push([0; 32]);
1788 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1789 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1792 secrets.push([0; 32]);
1793 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1794 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1797 secrets.push([0; 32]);
1798 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1799 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1802 secrets.push([0; 32]);
1803 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
1804 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1807 secrets.push([0; 32]);
1808 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1809 assert!(monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).is_err());
1813 // insert_secret #6 incorrect (5 derived from incorrect)
1814 monitor = CounterpartyCommitmentSecrets::new();
1817 secrets.push([0; 32]);
1818 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1819 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1822 secrets.push([0; 32]);
1823 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1824 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1827 secrets.push([0; 32]);
1828 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1829 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1832 secrets.push([0; 32]);
1833 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1834 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1837 secrets.push([0; 32]);
1838 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("631373ad5f9ef654bb3dade742d09504c567edd24320d2fcd68e3cc47e2ff6a6").unwrap());
1839 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1842 secrets.push([0; 32]);
1843 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("b7e76a83668bde38b373970155c868a653304308f9896692f904a23731224bb1").unwrap());
1844 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1847 secrets.push([0; 32]);
1848 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1849 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1852 secrets.push([0; 32]);
1853 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1854 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1858 // insert_secret #7 incorrect
1859 monitor = CounterpartyCommitmentSecrets::new();
1862 secrets.push([0; 32]);
1863 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1864 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1867 secrets.push([0; 32]);
1868 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1869 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1872 secrets.push([0; 32]);
1873 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1874 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1877 secrets.push([0; 32]);
1878 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1879 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1882 secrets.push([0; 32]);
1883 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1884 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1887 secrets.push([0; 32]);
1888 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1889 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1892 secrets.push([0; 32]);
1893 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("e7971de736e01da8ed58b94c2fc216cb1dca9e326f3a96e7194fe8ea8af6c0a3").unwrap());
1894 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1897 secrets.push([0; 32]);
1898 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("05cde6323d949933f7f7b78776bcc1ea6d9b31447732e3802e1f7ac44b650e17").unwrap());
1899 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());
1903 // insert_secret #8 incorrect
1904 monitor = CounterpartyCommitmentSecrets::new();
1907 secrets.push([0; 32]);
1908 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
1909 monitor.provide_secret(281474976710655, secrets.last().unwrap().clone()).unwrap();
1912 secrets.push([0; 32]);
1913 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
1914 monitor.provide_secret(281474976710654, secrets.last().unwrap().clone()).unwrap();
1917 secrets.push([0; 32]);
1918 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
1919 monitor.provide_secret(281474976710653, secrets.last().unwrap().clone()).unwrap();
1922 secrets.push([0; 32]);
1923 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
1924 monitor.provide_secret(281474976710652, secrets.last().unwrap().clone()).unwrap();
1927 secrets.push([0; 32]);
1928 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("c65716add7aa98ba7acb236352d665cab17345fe45b55fb879ff80e6bd0c41dd").unwrap());
1929 monitor.provide_secret(281474976710651, secrets.last().unwrap().clone()).unwrap();
1932 secrets.push([0; 32]);
1933 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("969660042a28f32d9be17344e09374b379962d03db1574df5a8a5a47e19ce3f2").unwrap());
1934 monitor.provide_secret(281474976710650, secrets.last().unwrap().clone()).unwrap();
1937 secrets.push([0; 32]);
1938 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a5a64476122ca0925fb344bdc1854c1c0a59fc614298e50a33e331980a220f32").unwrap());
1939 monitor.provide_secret(281474976710649, secrets.last().unwrap().clone()).unwrap();
1942 secrets.push([0; 32]);
1943 secrets.last_mut().unwrap()[0..32].clone_from_slice(&hex::decode("a7efbc61aac46d34f77778bac22c8a20c6a46ca460addc49009bda875ec88fa4").unwrap());
1944 assert!(monitor.provide_secret(281474976710648, secrets.last().unwrap().clone()).is_err());