1 use ln::chan_utils::{HTLCOutputInCommitment, TxCreationKeys, ChannelPublicKeys, LocalCommitmentTransaction};
2 use ln::channelmanager::PaymentPreimage;
4 use chain::keysinterface::{ChannelKeys, InMemoryChannelKeys};
7 use std::sync::{Mutex, Arc};
9 use bitcoin::blockdata::transaction::Transaction;
10 use bitcoin::blockdata::script::Script;
13 use secp256k1::key::{SecretKey, PublicKey};
14 use secp256k1::{Secp256k1, Signature};
15 use util::ser::{Writeable, Writer, Readable};
17 use ln::msgs::DecodeError;
19 /// Enforces some rules on ChannelKeys calls. Eventually we will probably want to expose a variant
20 /// of this which would essentially be what you'd want to run on a hardware wallet.
22 pub struct EnforcingChannelKeys {
23 pub inner: InMemoryChannelKeys,
24 commitment_number_obscure_and_last: Arc<Mutex<(Option<u64>, u64)>>,
27 impl EnforcingChannelKeys {
28 pub fn new(inner: InMemoryChannelKeys) -> Self {
31 commitment_number_obscure_and_last: Arc::new(Mutex::new((None, 0))),
36 impl EnforcingChannelKeys {
37 fn check_keys<T: secp256k1::Signing + secp256k1::Verification>(&self, secp_ctx: &Secp256k1<T>,
38 keys: &TxCreationKeys) {
39 let revocation_base = PublicKey::from_secret_key(secp_ctx, &self.inner.revocation_base_key());
40 let payment_base = PublicKey::from_secret_key(secp_ctx, &self.inner.payment_base_key());
41 let htlc_base = PublicKey::from_secret_key(secp_ctx, &self.inner.htlc_base_key());
43 let remote_points = self.inner.remote_channel_pubkeys.as_ref().unwrap();
45 let keys_expected = TxCreationKeys::new(secp_ctx,
46 &keys.per_commitment_point,
47 &remote_points.delayed_payment_basepoint,
48 &remote_points.htlc_basepoint,
52 if keys != &keys_expected { panic!("derived different per-tx keys") }
56 impl ChannelKeys for EnforcingChannelKeys {
57 fn funding_key(&self) -> &SecretKey { self.inner.funding_key() }
58 fn revocation_base_key(&self) -> &SecretKey { self.inner.revocation_base_key() }
59 fn payment_base_key(&self) -> &SecretKey { self.inner.payment_base_key() }
60 fn delayed_payment_base_key(&self) -> &SecretKey { self.inner.delayed_payment_base_key() }
61 fn htlc_base_key(&self) -> &SecretKey { self.inner.htlc_base_key() }
62 fn commitment_seed(&self) -> &[u8; 32] { self.inner.commitment_seed() }
63 fn pubkeys<'a>(&'a self) -> &'a ChannelPublicKeys { self.inner.pubkeys() }
65 fn sign_remote_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1<T>) -> Result<(Signature, Vec<Signature>), ()> {
66 if commitment_tx.input.len() != 1 { panic!("lightning commitment transactions have a single input"); }
67 self.check_keys(secp_ctx, keys);
68 let obscured_commitment_transaction_number = (commitment_tx.lock_time & 0xffffff) as u64 | ((commitment_tx.input[0].sequence as u64 & 0xffffff) << 3*8);
71 let mut commitment_data = self.commitment_number_obscure_and_last.lock().unwrap();
72 if commitment_data.0.is_none() {
73 commitment_data.0 = Some(obscured_commitment_transaction_number ^ commitment_data.1);
75 let commitment_number = obscured_commitment_transaction_number ^ commitment_data.0.unwrap();
76 assert!(commitment_number == commitment_data.1 || commitment_number == commitment_data.1 + 1);
77 commitment_data.1 = cmp::max(commitment_number, commitment_data.1)
80 Ok(self.inner.sign_remote_commitment(feerate_per_kw, commitment_tx, keys, htlcs, to_self_delay, secp_ctx).unwrap())
83 fn sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &mut LocalCommitmentTransaction, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) {
84 self.inner.sign_local_commitment(local_commitment_tx, funding_redeemscript, channel_value_satoshis, secp_ctx)
88 fn unsafe_sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &mut LocalCommitmentTransaction, funding_redeemscript: &Script, channel_value_satoshis: u64, secp_ctx: &Secp256k1<T>) {
89 self.inner.unsafe_sign_local_commitment(local_commitment_tx, funding_redeemscript, channel_value_satoshis, secp_ctx);
92 fn sign_htlc_transaction<T: secp256k1::Signing>(&self, local_commitment_tx: &mut LocalCommitmentTransaction, htlc_index: u32, preimage: Option<PaymentPreimage>, local_csv: u16, secp_ctx: &Secp256k1<T>) {
93 self.inner.sign_htlc_transaction(local_commitment_tx, htlc_index, preimage, local_csv, secp_ctx);
96 fn sign_closing_transaction<T: secp256k1::Signing>(&self, closing_tx: &Transaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
97 Ok(self.inner.sign_closing_transaction(closing_tx, secp_ctx).unwrap())
100 fn sign_channel_announcement<T: secp256k1::Signing>(&self, msg: &msgs::UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
101 self.inner.sign_channel_announcement(msg, secp_ctx)
104 fn set_remote_channel_pubkeys(&mut self, channel_pubkeys: &ChannelPublicKeys) {
105 self.inner.set_remote_channel_pubkeys(channel_pubkeys)
109 impl Writeable for EnforcingChannelKeys {
110 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
111 self.inner.write(writer)?;
112 let (obscure, last) = *self.commitment_number_obscure_and_last.lock().unwrap();
113 obscure.write(writer)?;
119 impl Readable for EnforcingChannelKeys {
120 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
121 let inner = Readable::read(reader)?;
122 let obscure_and_last = Readable::read(reader)?;
123 Ok(EnforcingChannelKeys {
125 commitment_number_obscure_and_last: Arc::new(Mutex::new(obscure_and_last))