Switch all feerate u64's to u32's.
[rust-lightning] / lightning / src / util / enforcing_trait_impls.rs
1 use ln::chan_utils::{HTLCOutputInCommitment, TxCreationKeys, ChannelPublicKeys, LocalCommitmentTransaction};
2 use ln::{chan_utils, msgs};
3 use chain::keysinterface::{ChannelKeys, InMemoryChannelKeys};
4
5 use std::cmp;
6 use std::sync::{Mutex, Arc};
7
8 use bitcoin::blockdata::transaction::Transaction;
9 use bitcoin::util::bip143;
10
11 use bitcoin::secp256k1;
12 use bitcoin::secp256k1::key::{SecretKey, PublicKey};
13 use bitcoin::secp256k1::{Secp256k1, Signature};
14 use util::ser::{Writeable, Writer, Readable};
15 use std::io::Error;
16 use ln::msgs::DecodeError;
17
18 /// Enforces some rules on ChannelKeys calls. Eventually we will probably want to expose a variant
19 /// of this which would essentially be what you'd want to run on a hardware wallet.
20 #[derive(Clone)]
21 pub struct EnforcingChannelKeys {
22         pub inner: InMemoryChannelKeys,
23         commitment_number_obscure_and_last: Arc<Mutex<(Option<u64>, u64)>>,
24 }
25
26 impl EnforcingChannelKeys {
27         pub fn new(inner: InMemoryChannelKeys) -> Self {
28                 Self {
29                         inner,
30                         commitment_number_obscure_and_last: Arc::new(Mutex::new((None, 0))),
31                 }
32         }
33 }
34
35 impl EnforcingChannelKeys {
36         fn check_keys<T: secp256k1::Signing + secp256k1::Verification>(&self, secp_ctx: &Secp256k1<T>,
37                                                                        keys: &TxCreationKeys) {
38                 let remote_points = self.inner.remote_channel_pubkeys.as_ref().unwrap();
39
40                 let keys_expected = TxCreationKeys::new(secp_ctx,
41                                                         &keys.per_commitment_point,
42                                                         &remote_points.delayed_payment_basepoint,
43                                                         &remote_points.htlc_basepoint,
44                                                         &self.inner.pubkeys().revocation_basepoint,
45                                                         &self.inner.pubkeys().htlc_basepoint).unwrap();
46                 if keys != &keys_expected { panic!("derived different per-tx keys") }
47         }
48 }
49
50 impl ChannelKeys for EnforcingChannelKeys {
51         fn commitment_seed(&self) -> &[u8; 32] { self.inner.commitment_seed() }
52         fn pubkeys<'a>(&'a self) -> &'a ChannelPublicKeys { self.inner.pubkeys() }
53         fn key_derivation_params(&self) -> (u64, u64) { self.inner.key_derivation_params() }
54
55         fn sign_remote_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, feerate_per_kw: u32, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1<T>) -> Result<(Signature, Vec<Signature>), ()> {
56                 if commitment_tx.input.len() != 1 { panic!("lightning commitment transactions have a single input"); }
57                 self.check_keys(secp_ctx, keys);
58                 let obscured_commitment_transaction_number = (commitment_tx.lock_time & 0xffffff) as u64 | ((commitment_tx.input[0].sequence as u64 & 0xffffff) << 3*8);
59
60                 {
61                         let mut commitment_data = self.commitment_number_obscure_and_last.lock().unwrap();
62                         if commitment_data.0.is_none() {
63                                 commitment_data.0 = Some(obscured_commitment_transaction_number ^ commitment_data.1);
64                         }
65                         let commitment_number = obscured_commitment_transaction_number ^ commitment_data.0.unwrap();
66                         assert!(commitment_number == commitment_data.1 || commitment_number == commitment_data.1 + 1);
67                         commitment_data.1 = cmp::max(commitment_number, commitment_data.1)
68                 }
69
70                 Ok(self.inner.sign_remote_commitment(feerate_per_kw, commitment_tx, keys, htlcs, to_self_delay, secp_ctx).unwrap())
71         }
72
73         fn sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
74                 Ok(self.inner.sign_local_commitment(local_commitment_tx, secp_ctx).unwrap())
75         }
76
77         #[cfg(test)]
78         fn unsafe_sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
79                 Ok(self.inner.unsafe_sign_local_commitment(local_commitment_tx, secp_ctx).unwrap())
80         }
81
82         fn sign_local_commitment_htlc_transactions<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, local_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Vec<Option<Signature>>, ()> {
83                 let commitment_txid = local_commitment_tx.txid();
84
85                 for this_htlc in local_commitment_tx.per_htlc.iter() {
86                         if this_htlc.0.transaction_output_index.is_some() {
87                                 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, local_commitment_tx.feerate_per_kw, local_csv, &this_htlc.0, &local_commitment_tx.local_keys.a_delayed_payment_key, &local_commitment_tx.local_keys.revocation_key);
88
89                                 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&this_htlc.0, &local_commitment_tx.local_keys);
90
91                                 let sighash = hash_to_message!(&bip143::SighashComponents::new(&htlc_tx).sighash_all(&htlc_tx.input[0], &htlc_redeemscript, this_htlc.0.amount_msat / 1000)[..]);
92                                 secp_ctx.verify(&sighash, this_htlc.1.as_ref().unwrap(), &local_commitment_tx.local_keys.b_htlc_key).unwrap();
93                         }
94                 }
95
96                 Ok(self.inner.sign_local_commitment_htlc_transactions(local_commitment_tx, local_csv, secp_ctx).unwrap())
97         }
98
99         fn sign_justice_transaction<T: secp256k1::Signing + secp256k1::Verification>(&self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, htlc: &Option<HTLCOutputInCommitment>, on_remote_tx_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
100                 Ok(self.inner.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc, on_remote_tx_csv, secp_ctx).unwrap())
101         }
102
103         fn sign_remote_htlc_transaction<T: secp256k1::Signing + secp256k1::Verification>(&self, htlc_tx: &Transaction, input: usize, amount: u64, per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
104                 Ok(self.inner.sign_remote_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc, secp_ctx).unwrap())
105         }
106
107         fn sign_closing_transaction<T: secp256k1::Signing>(&self, closing_tx: &Transaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
108                 Ok(self.inner.sign_closing_transaction(closing_tx, secp_ctx).unwrap())
109         }
110
111         fn sign_channel_announcement<T: secp256k1::Signing>(&self, msg: &msgs::UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()> {
112                 self.inner.sign_channel_announcement(msg, secp_ctx)
113         }
114
115         fn set_remote_channel_pubkeys(&mut self, channel_pubkeys: &ChannelPublicKeys) {
116                 self.inner.set_remote_channel_pubkeys(channel_pubkeys)
117         }
118 }
119
120 impl Writeable for EnforcingChannelKeys {
121         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
122                 self.inner.write(writer)?;
123                 let (obscure, last) = *self.commitment_number_obscure_and_last.lock().unwrap();
124                 obscure.write(writer)?;
125                 last.write(writer)?;
126                 Ok(())
127         }
128 }
129
130 impl Readable for EnforcingChannelKeys {
131         fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
132                 let inner = Readable::read(reader)?;
133                 let obscure_and_last = Readable::read(reader)?;
134                 Ok(EnforcingChannelKeys {
135                         inner: inner,
136                         commitment_number_obscure_and_last: Arc::new(Mutex::new(obscure_and_last))
137                 })
138         }
139 }