]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/sign/mod.rs
Merge pull request #2226 from alecchendev/2023-04-persist-network-graph-on-rgs
[rust-lightning] / lightning / src / sign / mod.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 //! Provides keys to LDK and defines some useful objects describing spendable on-chain outputs.
11 //!
12 //! The provided output descriptors follow a custom LDK data format and are currently not fully
13 //! compatible with Bitcoin Core output descriptors.
14
15 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, EcdsaSighashType};
16 use bitcoin::blockdata::script::{Script, Builder};
17 use bitcoin::blockdata::opcodes;
18 use bitcoin::network::constants::Network;
19 use bitcoin::psbt::PartiallySignedTransaction;
20 use bitcoin::util::bip32::{ExtendedPrivKey, ExtendedPubKey, ChildNumber};
21 use bitcoin::util::sighash;
22
23 use bitcoin::bech32::u5;
24 use bitcoin::hashes::{Hash, HashEngine};
25 use bitcoin::hashes::sha256::Hash as Sha256;
26 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
27 use bitcoin::hash_types::WPubkeyHash;
28
29 use bitcoin::secp256k1::{SecretKey, PublicKey, Scalar};
30 use bitcoin::secp256k1::{Secp256k1, ecdsa::Signature, Signing};
31 use bitcoin::secp256k1::ecdh::SharedSecret;
32 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
33 use bitcoin::{PackedLockTime, secp256k1, Sequence, Witness};
34
35 use crate::util::transaction_utils;
36 use crate::util::crypto::{hkdf_extract_expand_twice, sign, sign_with_aux_rand};
37 use crate::util::ser::{Writeable, Writer, Readable, ReadableArgs};
38 use crate::chain::transaction::OutPoint;
39 #[cfg(anchors)]
40 use crate::events::bump_transaction::HTLCDescriptor;
41 use crate::ln::channel::ANCHOR_OUTPUT_VALUE_SATOSHI;
42 use crate::ln::{chan_utils, PaymentPreimage};
43 use crate::ln::chan_utils::{HTLCOutputInCommitment, make_funding_redeemscript, ChannelPublicKeys, HolderCommitmentTransaction, ChannelTransactionParameters, CommitmentTransaction, ClosingTransaction};
44 use crate::ln::msgs::{UnsignedChannelAnnouncement, UnsignedGossipMessage};
45 use crate::ln::script::ShutdownScript;
46
47 use crate::prelude::*;
48 use core::convert::TryInto;
49 use core::ops::Deref;
50 use core::sync::atomic::{AtomicUsize, Ordering};
51 use crate::io::{self, Error};
52 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
53 use crate::util::atomic_counter::AtomicCounter;
54 use crate::util::chacha20::ChaCha20;
55 use crate::util::invoice::construct_invoice_preimage;
56
57 /// Used as initial key material, to be expanded into multiple secret keys (but not to be used
58 /// directly). This is used within LDK to encrypt/decrypt inbound payment data.
59 ///
60 /// This is not exported to bindings users as we just use `[u8; 32]` directly
61 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
62 pub struct KeyMaterial(pub [u8; 32]);
63
64 /// Information about a spendable output to a P2WSH script.
65 ///
66 /// See [`SpendableOutputDescriptor::DelayedPaymentOutput`] for more details on how to spend this.
67 #[derive(Clone, Debug, PartialEq, Eq)]
68 pub struct DelayedPaymentOutputDescriptor {
69         /// The outpoint which is spendable.
70         pub outpoint: OutPoint,
71         /// Per commitment point to derive the delayed payment key by key holder.
72         pub per_commitment_point: PublicKey,
73         /// The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
74         /// the witness_script.
75         pub to_self_delay: u16,
76         /// The output which is referenced by the given outpoint.
77         pub output: TxOut,
78         /// The revocation point specific to the commitment transaction which was broadcast. Used to
79         /// derive the witnessScript for this output.
80         pub revocation_pubkey: PublicKey,
81         /// Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
82         /// This may be useful in re-deriving keys used in the channel to spend the output.
83         pub channel_keys_id: [u8; 32],
84         /// The value of the channel which this output originated from, possibly indirectly.
85         pub channel_value_satoshis: u64,
86 }
87 impl DelayedPaymentOutputDescriptor {
88         /// The maximum length a well-formed witness spending one of these should have.
89         /// Note: If you have the grind_signatures feature enabled, this will be at least 1 byte
90         /// shorter.
91         // Calculated as 1 byte length + 73 byte signature, 1 byte empty vec push, 1 byte length plus
92         // redeemscript push length.
93         pub const MAX_WITNESS_LENGTH: usize = 1 + 73 + 1 + chan_utils::REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH + 1;
94 }
95
96 impl_writeable_tlv_based!(DelayedPaymentOutputDescriptor, {
97         (0, outpoint, required),
98         (2, per_commitment_point, required),
99         (4, to_self_delay, required),
100         (6, output, required),
101         (8, revocation_pubkey, required),
102         (10, channel_keys_id, required),
103         (12, channel_value_satoshis, required),
104 });
105
106 /// Information about a spendable output to our "payment key".
107 ///
108 /// See [`SpendableOutputDescriptor::StaticPaymentOutput`] for more details on how to spend this.
109 #[derive(Clone, Debug, PartialEq, Eq)]
110 pub struct StaticPaymentOutputDescriptor {
111         /// The outpoint which is spendable.
112         pub outpoint: OutPoint,
113         /// The output which is referenced by the given outpoint.
114         pub output: TxOut,
115         /// Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
116         /// This may be useful in re-deriving keys used in the channel to spend the output.
117         pub channel_keys_id: [u8; 32],
118         /// The value of the channel which this transactions spends.
119         pub channel_value_satoshis: u64,
120 }
121 impl StaticPaymentOutputDescriptor {
122         /// The maximum length a well-formed witness spending one of these should have.
123         /// Note: If you have the grind_signatures feature enabled, this will be at least 1 byte
124         /// shorter.
125         // Calculated as 1 byte legnth + 73 byte signature, 1 byte empty vec push, 1 byte length plus
126         // redeemscript push length.
127         pub const MAX_WITNESS_LENGTH: usize = 1 + 73 + 34;
128 }
129 impl_writeable_tlv_based!(StaticPaymentOutputDescriptor, {
130         (0, outpoint, required),
131         (2, output, required),
132         (4, channel_keys_id, required),
133         (6, channel_value_satoshis, required),
134 });
135
136 /// Describes the necessary information to spend a spendable output.
137 ///
138 /// When on-chain outputs are created by LDK (which our counterparty is not able to claim at any
139 /// point in the future) a [`SpendableOutputs`] event is generated which you must track and be able
140 /// to spend on-chain. The information needed to do this is provided in this enum, including the
141 /// outpoint describing which `txid` and output `index` is available, the full output which exists
142 /// at that `txid`/`index`, and any keys or other information required to sign.
143 ///
144 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
145 #[derive(Clone, Debug, PartialEq, Eq)]
146 pub enum SpendableOutputDescriptor {
147         /// An output to a script which was provided via [`SignerProvider`] directly, either from
148         /// [`get_destination_script`] or [`get_shutdown_scriptpubkey`], thus you should already
149         /// know how to spend it. No secret keys are provided as LDK was never given any key.
150         /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
151         /// on-chain using the payment preimage or after it has timed out.
152         ///
153         /// [`get_shutdown_scriptpubkey`]: SignerProvider::get_shutdown_scriptpubkey
154         /// [`get_destination_script`]: SignerProvider::get_shutdown_scriptpubkey
155         StaticOutput {
156                 /// The outpoint which is spendable.
157                 outpoint: OutPoint,
158                 /// The output which is referenced by the given outpoint.
159                 output: TxOut,
160         },
161         /// An output to a P2WSH script which can be spent with a single signature after an `OP_CSV`
162         /// delay.
163         ///
164         /// The witness in the spending input should be:
165         /// ```bitcoin
166         /// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
167         /// ```
168         ///
169         /// Note that the `nSequence` field in the spending input must be set to
170         /// [`DelayedPaymentOutputDescriptor::to_self_delay`] (which means the transaction is not
171         /// broadcastable until at least [`DelayedPaymentOutputDescriptor::to_self_delay`] blocks after
172         /// the outpoint confirms, see [BIP
173         /// 68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki)). Also note that LDK
174         /// won't generate a [`SpendableOutputDescriptor`] until the corresponding block height
175         /// is reached.
176         ///
177         /// These are generally the result of a "revocable" output to us, spendable only by us unless
178         /// it is an output from an old state which we broadcast (which should never happen).
179         ///
180         /// To derive the delayed payment key which is used to sign this input, you must pass the
181         /// holder [`InMemorySigner::delayed_payment_base_key`] (i.e., the private key which corresponds to the
182         /// [`ChannelPublicKeys::delayed_payment_basepoint`] in [`ChannelSigner::pubkeys`]) and the provided
183         /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to [`chan_utils::derive_private_key`]. The public key can be
184         /// generated without the secret key using [`chan_utils::derive_public_key`] and only the
185         /// [`ChannelPublicKeys::delayed_payment_basepoint`] which appears in [`ChannelSigner::pubkeys`].
186         ///
187         /// To derive the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] provided here (which is
188         /// used in the witness script generation), you must pass the counterparty
189         /// [`ChannelPublicKeys::revocation_basepoint`] (which appears in the call to
190         /// [`ChannelSigner::provide_channel_parameters`]) and the provided
191         /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to
192         /// [`chan_utils::derive_public_revocation_key`].
193         ///
194         /// The witness script which is hashed and included in the output `script_pubkey` may be
195         /// regenerated by passing the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] (derived
196         /// as explained above), our delayed payment pubkey (derived as explained above), and the
197         /// [`DelayedPaymentOutputDescriptor::to_self_delay`] contained here to
198         /// [`chan_utils::get_revokeable_redeemscript`].
199         DelayedPaymentOutput(DelayedPaymentOutputDescriptor),
200         /// An output to a P2WPKH, spendable exclusively by our payment key (i.e., the private key
201         /// which corresponds to the `payment_point` in [`ChannelSigner::pubkeys`]). The witness
202         /// in the spending input is, thus, simply:
203         /// ```bitcoin
204         /// <BIP 143 signature> <payment key>
205         /// ```
206         ///
207         /// These are generally the result of our counterparty having broadcast the current state,
208         /// allowing us to claim the non-HTLC-encumbered outputs immediately.
209         StaticPaymentOutput(StaticPaymentOutputDescriptor),
210 }
211
212 impl_writeable_tlv_based_enum!(SpendableOutputDescriptor,
213         (0, StaticOutput) => {
214                 (0, outpoint, required),
215                 (2, output, required),
216         },
217 ;
218         (1, DelayedPaymentOutput),
219         (2, StaticPaymentOutput),
220 );
221
222 impl SpendableOutputDescriptor {
223         /// Turns this into a [`bitcoin::psbt::Input`] which can be used to create a
224         /// [`PartiallySignedTransaction`] which spends the given descriptor.
225         ///
226         /// Note that this does not include any signatures, just the information required to
227         /// construct the transaction and sign it.
228         pub fn to_psbt_input(&self) -> bitcoin::psbt::Input {
229                 match self {
230                         SpendableOutputDescriptor::StaticOutput { output, .. } => {
231                                 // Is a standard P2WPKH, no need for witness script
232                                 bitcoin::psbt::Input {
233                                         witness_utxo: Some(output.clone()),
234                                         ..Default::default()
235                                 }
236                         },
237                         SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
238                                 // TODO we could add the witness script as well
239                                 bitcoin::psbt::Input {
240                                         witness_utxo: Some(descriptor.output.clone()),
241                                         ..Default::default()
242                                 }
243                         },
244                         SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
245                                 // TODO we could add the witness script as well
246                                 bitcoin::psbt::Input {
247                                         witness_utxo: Some(descriptor.output.clone()),
248                                         ..Default::default()
249                                 }
250                         },
251                 }
252         }
253
254         /// Creates an unsigned [`PartiallySignedTransaction`] which spends the given descriptors to
255         /// the given outputs, plus an output to the given change destination (if sufficient
256         /// change value remains). The PSBT will have a feerate, at least, of the given value.
257         ///
258         /// The `locktime` argument is used to set the transaction's locktime. If `None`, the
259         /// transaction will have a locktime of 0. It it recommended to set this to the current block
260         /// height to avoid fee sniping, unless you have some specific reason to use a different
261         /// locktime.
262         ///
263         /// Returns the PSBT and expected max transaction weight.
264         ///
265         /// Returns `Err(())` if the output value is greater than the input value minus required fee,
266         /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
267         /// does not match the one we can spend.
268         ///
269         /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
270         pub fn create_spendable_outputs_psbt(descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: Script, feerate_sat_per_1000_weight: u32, locktime: Option<PackedLockTime>) -> Result<(PartiallySignedTransaction, usize), ()> {
271                 let mut input = Vec::with_capacity(descriptors.len());
272                 let mut input_value = 0;
273                 let mut witness_weight = 0;
274                 let mut output_set = HashSet::with_capacity(descriptors.len());
275                 for outp in descriptors {
276                         match outp {
277                                 SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
278                                         if !output_set.insert(descriptor.outpoint) { return Err(()); }
279                                         input.push(TxIn {
280                                                 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
281                                                 script_sig: Script::new(),
282                                                 sequence: Sequence::ZERO,
283                                                 witness: Witness::new(),
284                                         });
285                                         witness_weight += StaticPaymentOutputDescriptor::MAX_WITNESS_LENGTH;
286                                         #[cfg(feature = "grind_signatures")]
287                                         { witness_weight -= 1; } // Guarantees a low R signature
288                                         input_value += descriptor.output.value;
289                                 },
290                                 SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
291                                         if !output_set.insert(descriptor.outpoint) { return Err(()); }
292                                         input.push(TxIn {
293                                                 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
294                                                 script_sig: Script::new(),
295                                                 sequence: Sequence(descriptor.to_self_delay as u32),
296                                                 witness: Witness::new(),
297                                         });
298                                         witness_weight += DelayedPaymentOutputDescriptor::MAX_WITNESS_LENGTH;
299                                         #[cfg(feature = "grind_signatures")]
300                                         { witness_weight -= 1; } // Guarantees a low R signature
301                                         input_value += descriptor.output.value;
302                                 },
303                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
304                                         if !output_set.insert(*outpoint) { return Err(()); }
305                                         input.push(TxIn {
306                                                 previous_output: outpoint.into_bitcoin_outpoint(),
307                                                 script_sig: Script::new(),
308                                                 sequence: Sequence::ZERO,
309                                                 witness: Witness::new(),
310                                         });
311                                         witness_weight += 1 + 73 + 34;
312                                         #[cfg(feature = "grind_signatures")]
313                                         { witness_weight -= 1; } // Guarantees a low R signature
314                                         input_value += output.value;
315                                 }
316                         }
317                         if input_value > MAX_VALUE_MSAT / 1000 { return Err(()); }
318                 }
319                 let mut tx = Transaction {
320                         version: 2,
321                         lock_time: locktime.unwrap_or(PackedLockTime::ZERO),
322                         input,
323                         output: outputs,
324                 };
325                 let expected_max_weight =
326                         transaction_utils::maybe_add_change_output(&mut tx, input_value, witness_weight, feerate_sat_per_1000_weight, change_destination_script)?;
327
328                 let psbt_inputs = descriptors.iter().map(|d| d.to_psbt_input()).collect::<Vec<_>>();
329                 let psbt = PartiallySignedTransaction {
330                         inputs: psbt_inputs,
331                         outputs: vec![Default::default(); tx.output.len()],
332                         unsigned_tx: tx,
333                         xpub: Default::default(),
334                         version: 0,
335                         proprietary: Default::default(),
336                         unknown: Default::default(),
337                 };
338                 Ok((psbt, expected_max_weight))
339         }
340 }
341
342 /// A trait to handle Lightning channel key material without concretizing the channel type or
343 /// the signature mechanism.
344 pub trait ChannelSigner {
345         /// Gets the per-commitment point for a specific commitment number
346         ///
347         /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
348         fn get_per_commitment_point(&self, idx: u64, secp_ctx: &Secp256k1<secp256k1::All>) -> PublicKey;
349
350         /// Gets the commitment secret for a specific commitment number as part of the revocation process
351         ///
352         /// An external signer implementation should error here if the commitment was already signed
353         /// and should refuse to sign it in the future.
354         ///
355         /// May be called more than once for the same index.
356         ///
357         /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
358         // TODO: return a Result so we can signal a validation error
359         fn release_commitment_secret(&self, idx: u64) -> [u8; 32];
360
361         /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
362         ///
363         /// This is required in order for the signer to make sure that releasing a commitment
364         /// secret won't leave us without a broadcastable holder transaction.
365         /// Policy checks should be implemented in this function, including checking the amount
366         /// sent to us and checking the HTLCs.
367         ///
368         /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
369         /// A validating signer should ensure that an HTLC output is removed only when the matching
370         /// preimage is provided, or when the value to holder is restored.
371         ///
372         /// Note that all the relevant preimages will be provided, but there may also be additional
373         /// irrelevant or duplicate preimages.
374         fn validate_holder_commitment(&self, holder_tx: &HolderCommitmentTransaction,
375                 preimages: Vec<PaymentPreimage>) -> Result<(), ()>;
376
377         /// Returns the holder's channel public keys and basepoints.
378         fn pubkeys(&self) -> &ChannelPublicKeys;
379
380         /// Returns an arbitrary identifier describing the set of keys which are provided back to you in
381         /// some [`SpendableOutputDescriptor`] types. This should be sufficient to identify this
382         /// [`EcdsaChannelSigner`] object uniquely and lookup or re-derive its keys.
383         fn channel_keys_id(&self) -> [u8; 32];
384
385         /// Set the counterparty static channel data, including basepoints,
386         /// `counterparty_selected`/`holder_selected_contest_delay` and funding outpoint.
387         ///
388         /// This data is static, and will never change for a channel once set. For a given [`ChannelSigner`]
389         /// instance, LDK will call this method exactly once - either immediately after construction
390         /// (not including if done via [`SignerProvider::read_chan_signer`]) or when the funding
391         /// information has been generated.
392         ///
393         /// channel_parameters.is_populated() MUST be true.
394         fn provide_channel_parameters(&mut self, channel_parameters: &ChannelTransactionParameters);
395 }
396
397 /// A trait to sign Lightning channel transactions as described in
398 /// [BOLT 3](https://github.com/lightning/bolts/blob/master/03-transactions.md).
399 ///
400 /// Signing services could be implemented on a hardware wallet and should implement signing
401 /// policies in order to be secure. Please refer to the [VLS Policy
402 /// Controls](https://gitlab.com/lightning-signer/validating-lightning-signer/-/blob/main/docs/policy-controls.md)
403 /// for an example of such policies.
404 pub trait EcdsaChannelSigner: ChannelSigner {
405         /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
406         ///
407         /// Note that if signing fails or is rejected, the channel will be force-closed.
408         ///
409         /// Policy checks should be implemented in this function, including checking the amount
410         /// sent to us and checking the HTLCs.
411         ///
412         /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
413         /// A validating signer should ensure that an HTLC output is removed only when the matching
414         /// preimage is provided, or when the value to holder is restored.
415         ///
416         /// Note that all the relevant preimages will be provided, but there may also be additional
417         /// irrelevant or duplicate preimages.
418         //
419         // TODO: Document the things someone using this interface should enforce before signing.
420         fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction,
421                 preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<secp256k1::All>
422         ) -> Result<(Signature, Vec<Signature>), ()>;
423         /// Validate the counterparty's revocation.
424         ///
425         /// This is required in order for the signer to make sure that the state has moved
426         /// forward and it is safe to sign the next counterparty commitment.
427         fn validate_counterparty_revocation(&self, idx: u64, secret: &SecretKey) -> Result<(), ()>;
428         /// Creates a signature for a holder's commitment transaction and its claiming HTLC transactions.
429         ///
430         /// This will be called
431         /// - with a non-revoked `commitment_tx`.
432         /// - with the latest `commitment_tx` when we initiate a force-close.
433         /// - with the previous `commitment_tx`, just to get claiming HTLC
434         ///   signatures, if we are reacting to a [`ChannelMonitor`]
435         ///   [replica](https://github.com/lightningdevkit/rust-lightning/blob/main/GLOSSARY.md#monitor-replicas)
436         ///   that decided to broadcast before it had been updated to the latest `commitment_tx`.
437         ///
438         /// This may be called multiple times for the same transaction.
439         ///
440         /// An external signer implementation should check that the commitment has not been revoked.
441         ///
442         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
443         // TODO: Document the things someone using this interface should enforce before signing.
444         fn sign_holder_commitment_and_htlcs(&self, commitment_tx: &HolderCommitmentTransaction,
445                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()>;
446         /// Same as [`sign_holder_commitment_and_htlcs`], but exists only for tests to get access to
447         /// holder commitment transactions which will be broadcasted later, after the channel has moved
448         /// on to a newer state. Thus, needs its own method as [`sign_holder_commitment_and_htlcs`] may
449         /// enforce that we only ever get called once.
450         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
451         fn unsafe_sign_holder_commitment_and_htlcs(&self, commitment_tx: &HolderCommitmentTransaction,
452                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()>;
453         /// Create a signature for the given input in a transaction spending an HTLC transaction output
454         /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
455         ///
456         /// A justice transaction may claim multiple outputs at the same time if timelocks are
457         /// similar, but only a signature for the input at index `input` should be signed for here.
458         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
459         /// to an upcoming timelock expiration.
460         ///
461         /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
462         ///
463         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
464         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
465         /// not allow the spending of any funds by itself (you need our holder `revocation_secret` to do
466         /// so).
467         fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64,
468                 per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>
469         ) -> Result<Signature, ()>;
470         /// Create a signature for the given input in a transaction spending a commitment transaction
471         /// HTLC output when our counterparty broadcasts an old state.
472         ///
473         /// A justice transaction may claim multiple outputs at the same time if timelocks are
474         /// similar, but only a signature for the input at index `input` should be signed for here.
475         /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
476         /// to an upcoming timelock expiration.
477         ///
478         /// `amount` is the value of the output spent by this input, committed to in the BIP 143
479         /// signature.
480         ///
481         /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
482         /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
483         /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
484         /// so).
485         ///
486         /// `htlc` holds HTLC elements (hash, timelock), thus changing the format of the witness script
487         /// (which is committed to in the BIP 143 signatures).
488         fn sign_justice_revoked_htlc(&self, justice_tx: &Transaction, input: usize, amount: u64,
489                 per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment,
490                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
491         #[cfg(anchors)]
492         /// Computes the signature for a commitment transaction's HTLC output used as an input within
493         /// `htlc_tx`, which spends the commitment transaction at index `input`. The signature returned
494         /// must be be computed using [`EcdsaSighashType::All`]. Note that this should only be used to
495         /// sign HTLC transactions from channels supporting anchor outputs after all additional
496         /// inputs/outputs have been added to the transaction.
497         ///
498         /// [`EcdsaSighashType::All`]: bitcoin::blockdata::transaction::EcdsaSighashType::All
499         fn sign_holder_htlc_transaction(&self, htlc_tx: &Transaction, input: usize,
500                 htlc_descriptor: &HTLCDescriptor, secp_ctx: &Secp256k1<secp256k1::All>
501         ) -> Result<Signature, ()>;
502         /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
503         /// transaction, either offered or received.
504         ///
505         /// Such a transaction may claim multiples offered outputs at same time if we know the
506         /// preimage for each when we create it, but only the input at index `input` should be
507         /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
508         /// needed with regards to an upcoming timelock expiration.
509         ///
510         /// `witness_script` is either an offered or received script as defined in BOLT3 for HTLC
511         /// outputs.
512         ///
513         /// `amount` is value of the output spent by this input, committed to in the BIP 143 signature.
514         ///
515         /// `per_commitment_point` is the dynamic point corresponding to the channel state
516         /// detected onchain. It has been generated by our counterparty and is used to derive
517         /// channel state keys, which are then included in the witness script and committed to in the
518         /// BIP 143 signature.
519         fn sign_counterparty_htlc_transaction(&self, htlc_tx: &Transaction, input: usize, amount: u64,
520                 per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment,
521                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
522         /// Create a signature for a (proposed) closing transaction.
523         ///
524         /// Note that, due to rounding, there may be one "missing" satoshi, and either party may have
525         /// chosen to forgo their output as dust.
526         fn sign_closing_transaction(&self, closing_tx: &ClosingTransaction,
527                 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
528         /// Computes the signature for a commitment transaction's anchor output used as an
529         /// input within `anchor_tx`, which spends the commitment transaction, at index `input`.
530         fn sign_holder_anchor_input(
531                 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
532         ) -> Result<Signature, ()>;
533         /// Signs a channel announcement message with our funding key proving it comes from one of the
534         /// channel participants.
535         ///
536         /// Channel announcements also require a signature from each node's network key. Our node
537         /// signature is computed through [`NodeSigner::sign_gossip_message`].
538         ///
539         /// Note that if this fails or is rejected, the channel will not be publicly announced and
540         /// our counterparty may (though likely will not) close the channel on us for violating the
541         /// protocol.
542         fn sign_channel_announcement_with_funding_key(
543                 &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<secp256k1::All>
544         ) -> Result<Signature, ()>;
545 }
546
547 /// A writeable signer.
548 ///
549 /// There will always be two instances of a signer per channel, one occupied by the
550 /// [`ChannelManager`] and another by the channel's [`ChannelMonitor`].
551 ///
552 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
553 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
554 pub trait WriteableEcdsaChannelSigner: EcdsaChannelSigner + Writeable {}
555
556 /// Specifies the recipient of an invoice.
557 ///
558 /// This indicates to [`NodeSigner::sign_invoice`] what node secret key should be used to sign
559 /// the invoice.
560 pub enum Recipient {
561         /// The invoice should be signed with the local node secret key.
562         Node,
563         /// The invoice should be signed with the phantom node secret key. This secret key must be the
564         /// same for all nodes participating in the [phantom node payment].
565         ///
566         /// [phantom node payment]: PhantomKeysManager
567         PhantomNode,
568 }
569
570 /// A trait that describes a source of entropy.
571 pub trait EntropySource {
572         /// Gets a unique, cryptographically-secure, random 32-byte value. This method must return a
573         /// different value each time it is called.
574         fn get_secure_random_bytes(&self) -> [u8; 32];
575 }
576
577 /// A trait that can handle cryptographic operations at the scope level of a node.
578 pub trait NodeSigner {
579         /// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
580         ///
581         /// If the implementor of this trait supports [phantom node payments], then every node that is
582         /// intended to be included in the phantom invoice route hints must return the same value from
583         /// this method.
584         // This is because LDK avoids storing inbound payment data by encrypting payment data in the
585         // payment hash and/or payment secret, therefore for a payment to be receivable by multiple
586         // nodes, they must share the key that encrypts this payment data.
587         ///
588         /// This method must return the same value each time it is called.
589         ///
590         /// [phantom node payments]: PhantomKeysManager
591         fn get_inbound_payment_key_material(&self) -> KeyMaterial;
592
593         /// Get node id based on the provided [`Recipient`].
594         ///
595         /// This method must return the same value each time it is called with a given [`Recipient`]
596         /// parameter.
597         ///
598         /// Errors if the [`Recipient`] variant is not supported by the implementation.
599         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()>;
600
601         /// Gets the ECDH shared secret of our node secret and `other_key`, multiplying by `tweak` if
602         /// one is provided. Note that this tweak can be applied to `other_key` instead of our node
603         /// secret, though this is less efficient.
604         ///
605         /// Note that if this fails while attempting to forward an HTLC, LDK will panic. The error
606         /// should be resolved to allow LDK to resume forwarding HTLCs.
607         ///
608         /// Errors if the [`Recipient`] variant is not supported by the implementation.
609         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()>;
610
611         /// Sign an invoice.
612         ///
613         /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
614         /// this trait to parse the invoice and make sure they're signing what they expect, rather than
615         /// blindly signing the hash.
616         ///
617         /// The `hrp_bytes` are ASCII bytes, while the `invoice_data` is base32.
618         ///
619         /// The secret key used to sign the invoice is dependent on the [`Recipient`].
620         ///
621         /// Errors if the [`Recipient`] variant is not supported by the implementation.
622         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()>;
623
624         /// Sign a gossip message.
625         ///
626         /// Note that if this fails, LDK may panic and the message will not be broadcast to the network
627         /// or a possible channel counterparty. If LDK panics, the error should be resolved to allow the
628         /// message to be broadcast, as otherwise it may prevent one from receiving funds over the
629         /// corresponding channel.
630         fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()>;
631 }
632
633 /// A trait that can return signer instances for individual channels.
634 pub trait SignerProvider {
635         /// A type which implements [`WriteableEcdsaChannelSigner`] which will be returned by [`Self::derive_channel_signer`].
636         type Signer : WriteableEcdsaChannelSigner;
637
638         /// Generates a unique `channel_keys_id` that can be used to obtain a [`Self::Signer`] through
639         /// [`SignerProvider::derive_channel_signer`]. The `user_channel_id` is provided to allow
640         /// implementations of [`SignerProvider`] to maintain a mapping between itself and the generated
641         /// `channel_keys_id`.
642         ///
643         /// This method must return a different value each time it is called.
644         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32];
645
646         /// Derives the private key material backing a `Signer`.
647         ///
648         /// To derive a new `Signer`, a fresh `channel_keys_id` should be obtained through
649         /// [`SignerProvider::generate_channel_keys_id`]. Otherwise, an existing `Signer` can be
650         /// re-derived from its `channel_keys_id`, which can be obtained through its trait method
651         /// [`ChannelSigner::channel_keys_id`].
652         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer;
653
654         /// Reads a [`Signer`] for this [`SignerProvider`] from the given input stream.
655         /// This is only called during deserialization of other objects which contain
656         /// [`WriteableEcdsaChannelSigner`]-implementing objects (i.e., [`ChannelMonitor`]s and [`ChannelManager`]s).
657         /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
658         /// contain no versioning scheme. You may wish to include your own version prefix and ensure
659         /// you've read all of the provided bytes to ensure no corruption occurred.
660         ///
661         /// This method is slowly being phased out -- it will only be called when reading objects
662         /// written by LDK versions prior to 0.0.113.
663         ///
664         /// [`Signer`]: Self::Signer
665         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
666         /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
667         fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError>;
668
669         /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
670         ///
671         /// If this function returns an error, this will result in a channel failing to open.
672         ///
673         /// This method should return a different value each time it is called, to avoid linking
674         /// on-chain funds across channels as controlled to the same user.
675         fn get_destination_script(&self) -> Result<Script, ()>;
676
677         /// Get a script pubkey which we will send funds to when closing a channel.
678         ///
679         /// If this function returns an error, this will result in a channel failing to open or close.
680         /// In the event of a failure when the counterparty is initiating a close, this can result in a
681         /// channel force close.
682         ///
683         /// This method should return a different value each time it is called, to avoid linking
684         /// on-chain funds across channels as controlled to the same user.
685         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()>;
686 }
687
688 /// A simple implementation of [`WriteableEcdsaChannelSigner`] that just keeps the private keys in memory.
689 ///
690 /// This implementation performs no policy checks and is insufficient by itself as
691 /// a secure external signer.
692 pub struct InMemorySigner {
693         /// Holder secret key in the 2-of-2 multisig script of a channel. This key also backs the
694         /// holder's anchor output in a commitment transaction, if one is present.
695         pub funding_key: SecretKey,
696         /// Holder secret key for blinded revocation pubkey.
697         pub revocation_base_key: SecretKey,
698         /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions.
699         pub payment_key: SecretKey,
700         /// Holder secret key used in an HTLC transaction.
701         pub delayed_payment_base_key: SecretKey,
702         /// Holder HTLC secret key used in commitment transaction HTLC outputs.
703         pub htlc_base_key: SecretKey,
704         /// Commitment seed.
705         pub commitment_seed: [u8; 32],
706         /// Holder public keys and basepoints.
707         pub(crate) holder_channel_pubkeys: ChannelPublicKeys,
708         /// Counterparty public keys and counterparty/holder `selected_contest_delay`, populated on channel acceptance.
709         channel_parameters: Option<ChannelTransactionParameters>,
710         /// The total value of this channel.
711         channel_value_satoshis: u64,
712         /// Key derivation parameters.
713         channel_keys_id: [u8; 32],
714         /// Seed from which all randomness produced is derived from.
715         rand_bytes_unique_start: [u8; 32],
716         /// Tracks the number of times we've produced randomness to ensure we don't return the same
717         /// bytes twice.
718         rand_bytes_index: AtomicCounter,
719 }
720
721 impl Clone for InMemorySigner {
722         fn clone(&self) -> Self {
723                 Self {
724                         funding_key: self.funding_key.clone(),
725                         revocation_base_key: self.revocation_base_key.clone(),
726                         payment_key: self.payment_key.clone(),
727                         delayed_payment_base_key: self.delayed_payment_base_key.clone(),
728                         htlc_base_key: self.htlc_base_key.clone(),
729                         commitment_seed: self.commitment_seed.clone(),
730                         holder_channel_pubkeys: self.holder_channel_pubkeys.clone(),
731                         channel_parameters: self.channel_parameters.clone(),
732                         channel_value_satoshis: self.channel_value_satoshis,
733                         channel_keys_id: self.channel_keys_id,
734                         rand_bytes_unique_start: self.get_secure_random_bytes(),
735                         rand_bytes_index: AtomicCounter::new(),
736                 }
737         }
738 }
739
740 impl InMemorySigner {
741         /// Creates a new [`InMemorySigner`].
742         pub fn new<C: Signing>(
743                 secp_ctx: &Secp256k1<C>,
744                 funding_key: SecretKey,
745                 revocation_base_key: SecretKey,
746                 payment_key: SecretKey,
747                 delayed_payment_base_key: SecretKey,
748                 htlc_base_key: SecretKey,
749                 commitment_seed: [u8; 32],
750                 channel_value_satoshis: u64,
751                 channel_keys_id: [u8; 32],
752                 rand_bytes_unique_start: [u8; 32],
753         ) -> InMemorySigner {
754                 let holder_channel_pubkeys =
755                         InMemorySigner::make_holder_keys(secp_ctx, &funding_key, &revocation_base_key,
756                                 &payment_key, &delayed_payment_base_key,
757                                 &htlc_base_key);
758                 InMemorySigner {
759                         funding_key,
760                         revocation_base_key,
761                         payment_key,
762                         delayed_payment_base_key,
763                         htlc_base_key,
764                         commitment_seed,
765                         channel_value_satoshis,
766                         holder_channel_pubkeys,
767                         channel_parameters: None,
768                         channel_keys_id,
769                         rand_bytes_unique_start,
770                         rand_bytes_index: AtomicCounter::new(),
771                 }
772         }
773
774         fn make_holder_keys<C: Signing>(secp_ctx: &Secp256k1<C>,
775                         funding_key: &SecretKey,
776                         revocation_base_key: &SecretKey,
777                         payment_key: &SecretKey,
778                         delayed_payment_base_key: &SecretKey,
779                         htlc_base_key: &SecretKey) -> ChannelPublicKeys {
780                 let from_secret = |s: &SecretKey| PublicKey::from_secret_key(secp_ctx, s);
781                 ChannelPublicKeys {
782                         funding_pubkey: from_secret(&funding_key),
783                         revocation_basepoint: from_secret(&revocation_base_key),
784                         payment_point: from_secret(&payment_key),
785                         delayed_payment_basepoint: from_secret(&delayed_payment_base_key),
786                         htlc_basepoint: from_secret(&htlc_base_key),
787                 }
788         }
789
790         /// Returns the counterparty's pubkeys.
791         ///
792         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
793         pub fn counterparty_pubkeys(&self) -> &ChannelPublicKeys { &self.get_channel_parameters().counterparty_parameters.as_ref().unwrap().pubkeys }
794         /// Returns the `contest_delay` value specified by our counterparty and applied on holder-broadcastable
795         /// transactions, i.e., the amount of time that we have to wait to recover our funds if we
796         /// broadcast a transaction.
797         ///
798         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
799         pub fn counterparty_selected_contest_delay(&self) -> u16 { self.get_channel_parameters().counterparty_parameters.as_ref().unwrap().selected_contest_delay }
800         /// Returns the `contest_delay` value specified by us and applied on transactions broadcastable
801         /// by our counterparty, i.e., the amount of time that they have to wait to recover their funds
802         /// if they broadcast a transaction.
803         ///
804         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
805         pub fn holder_selected_contest_delay(&self) -> u16 { self.get_channel_parameters().holder_selected_contest_delay }
806         /// Returns whether the holder is the initiator.
807         ///
808         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
809         pub fn is_outbound(&self) -> bool { self.get_channel_parameters().is_outbound_from_holder }
810         /// Funding outpoint
811         ///
812         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
813         pub fn funding_outpoint(&self) -> &OutPoint { self.get_channel_parameters().funding_outpoint.as_ref().unwrap() }
814         /// Returns a [`ChannelTransactionParameters`] for this channel, to be used when verifying or
815         /// building transactions.
816         ///
817         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
818         pub fn get_channel_parameters(&self) -> &ChannelTransactionParameters {
819                 self.channel_parameters.as_ref().unwrap()
820         }
821         /// Returns whether anchors should be used.
822         ///
823         /// Will panic if [`ChannelSigner::provide_channel_parameters`] has not been called before.
824         pub fn opt_anchors(&self) -> bool {
825                 self.get_channel_parameters().opt_anchors.is_some()
826         }
827         /// Sign the single input of `spend_tx` at index `input_idx`, which spends the output described
828         /// by `descriptor`, returning the witness stack for the input.
829         ///
830         /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
831         /// is not spending the outpoint described by [`descriptor.outpoint`],
832         /// or if an output descriptor `script_pubkey` does not match the one we can spend.
833         ///
834         /// [`descriptor.outpoint`]: StaticPaymentOutputDescriptor::outpoint
835         pub fn sign_counterparty_payment_input<C: Signing>(&self, spend_tx: &Transaction, input_idx: usize, descriptor: &StaticPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>) -> Result<Vec<Vec<u8>>, ()> {
836                 // TODO: We really should be taking the SigHashCache as a parameter here instead of
837                 // spend_tx, but ideally the SigHashCache would expose the transaction's inputs read-only
838                 // so that we can check them. This requires upstream rust-bitcoin changes (as well as
839                 // bindings updates to support SigHashCache objects).
840                 if spend_tx.input.len() <= input_idx { return Err(()); }
841                 if !spend_tx.input[input_idx].script_sig.is_empty() { return Err(()); }
842                 if spend_tx.input[input_idx].previous_output != descriptor.outpoint.into_bitcoin_outpoint() { return Err(()); }
843
844                 let remotepubkey = self.pubkeys().payment_point;
845                 let witness_script = bitcoin::Address::p2pkh(&::bitcoin::PublicKey{compressed: true, inner: remotepubkey}, Network::Testnet).script_pubkey();
846                 let sighash = hash_to_message!(&sighash::SighashCache::new(spend_tx).segwit_signature_hash(input_idx, &witness_script, descriptor.output.value, EcdsaSighashType::All).unwrap()[..]);
847                 let remotesig = sign_with_aux_rand(secp_ctx, &sighash, &self.payment_key, &self);
848                 let payment_script = bitcoin::Address::p2wpkh(&::bitcoin::PublicKey{compressed: true, inner: remotepubkey}, Network::Bitcoin).unwrap().script_pubkey();
849
850                 if payment_script != descriptor.output.script_pubkey { return Err(()); }
851
852                 let mut witness = Vec::with_capacity(2);
853                 witness.push(remotesig.serialize_der().to_vec());
854                 witness[0].push(EcdsaSighashType::All as u8);
855                 witness.push(remotepubkey.serialize().to_vec());
856                 Ok(witness)
857         }
858
859         /// Sign the single input of `spend_tx` at index `input_idx` which spends the output
860         /// described by `descriptor`, returning the witness stack for the input.
861         ///
862         /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
863         /// is not spending the outpoint described by [`descriptor.outpoint`], does not have a
864         /// sequence set to [`descriptor.to_self_delay`], or if an output descriptor
865         /// `script_pubkey` does not match the one we can spend.
866         ///
867         /// [`descriptor.outpoint`]: DelayedPaymentOutputDescriptor::outpoint
868         /// [`descriptor.to_self_delay`]: DelayedPaymentOutputDescriptor::to_self_delay
869         pub fn sign_dynamic_p2wsh_input<C: Signing>(&self, spend_tx: &Transaction, input_idx: usize, descriptor: &DelayedPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>) -> Result<Vec<Vec<u8>>, ()> {
870                 // TODO: We really should be taking the SigHashCache as a parameter here instead of
871                 // spend_tx, but ideally the SigHashCache would expose the transaction's inputs read-only
872                 // so that we can check them. This requires upstream rust-bitcoin changes (as well as
873                 // bindings updates to support SigHashCache objects).
874                 if spend_tx.input.len() <= input_idx { return Err(()); }
875                 if !spend_tx.input[input_idx].script_sig.is_empty() { return Err(()); }
876                 if spend_tx.input[input_idx].previous_output != descriptor.outpoint.into_bitcoin_outpoint() { return Err(()); }
877                 if spend_tx.input[input_idx].sequence.0 != descriptor.to_self_delay as u32 { return Err(()); }
878
879                 let delayed_payment_key = chan_utils::derive_private_key(&secp_ctx, &descriptor.per_commitment_point, &self.delayed_payment_base_key);
880                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
881                 let witness_script = chan_utils::get_revokeable_redeemscript(&descriptor.revocation_pubkey, descriptor.to_self_delay, &delayed_payment_pubkey);
882                 let sighash = hash_to_message!(&sighash::SighashCache::new(spend_tx).segwit_signature_hash(input_idx, &witness_script, descriptor.output.value, EcdsaSighashType::All).unwrap()[..]);
883                 let local_delayedsig = sign_with_aux_rand(secp_ctx, &sighash, &delayed_payment_key, &self);
884                 let payment_script = bitcoin::Address::p2wsh(&witness_script, Network::Bitcoin).script_pubkey();
885
886                 if descriptor.output.script_pubkey != payment_script { return Err(()); }
887
888                 let mut witness = Vec::with_capacity(3);
889                 witness.push(local_delayedsig.serialize_der().to_vec());
890                 witness[0].push(EcdsaSighashType::All as u8);
891                 witness.push(vec!()); //MINIMALIF
892                 witness.push(witness_script.clone().into_bytes());
893                 Ok(witness)
894         }
895 }
896
897 impl EntropySource for InMemorySigner {
898         fn get_secure_random_bytes(&self) -> [u8; 32] {
899                 let index = self.rand_bytes_index.get_increment();
900                 let mut nonce = [0u8; 16];
901                 nonce[..8].copy_from_slice(&index.to_be_bytes());
902                 ChaCha20::get_single_block(&self.rand_bytes_unique_start, &nonce)
903         }
904 }
905
906 impl ChannelSigner for InMemorySigner {
907         fn get_per_commitment_point(&self, idx: u64, secp_ctx: &Secp256k1<secp256k1::All>) -> PublicKey {
908                 let commitment_secret = SecretKey::from_slice(&chan_utils::build_commitment_secret(&self.commitment_seed, idx)).unwrap();
909                 PublicKey::from_secret_key(secp_ctx, &commitment_secret)
910         }
911
912         fn release_commitment_secret(&self, idx: u64) -> [u8; 32] {
913                 chan_utils::build_commitment_secret(&self.commitment_seed, idx)
914         }
915
916         fn validate_holder_commitment(&self, _holder_tx: &HolderCommitmentTransaction, _preimages: Vec<PaymentPreimage>) -> Result<(), ()> {
917                 Ok(())
918         }
919
920         fn pubkeys(&self) -> &ChannelPublicKeys { &self.holder_channel_pubkeys }
921
922         fn channel_keys_id(&self) -> [u8; 32] { self.channel_keys_id }
923
924         fn provide_channel_parameters(&mut self, channel_parameters: &ChannelTransactionParameters) {
925                 assert!(self.channel_parameters.is_none() || self.channel_parameters.as_ref().unwrap() == channel_parameters);
926                 if self.channel_parameters.is_some() {
927                         // The channel parameters were already set and they match, return early.
928                         return;
929                 }
930                 assert!(channel_parameters.is_populated(), "Channel parameters must be fully populated");
931                 self.channel_parameters = Some(channel_parameters.clone());
932         }
933 }
934
935 impl EcdsaChannelSigner for InMemorySigner {
936         fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction, _preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()> {
937                 let trusted_tx = commitment_tx.trust();
938                 let keys = trusted_tx.keys();
939
940                 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
941                 let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &self.counterparty_pubkeys().funding_pubkey);
942
943                 let built_tx = trusted_tx.built_transaction();
944                 let commitment_sig = built_tx.sign_counterparty_commitment(&self.funding_key, &channel_funding_redeemscript, self.channel_value_satoshis, secp_ctx);
945                 let commitment_txid = built_tx.txid;
946
947                 let mut htlc_sigs = Vec::with_capacity(commitment_tx.htlcs().len());
948                 for htlc in commitment_tx.htlcs() {
949                         let channel_parameters = self.get_channel_parameters();
950                         let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_tx.feerate_per_kw(), self.holder_selected_contest_delay(), htlc, self.opt_anchors(), channel_parameters.opt_non_zero_fee_anchors.is_some(), &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
951                         let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, self.opt_anchors(), &keys);
952                         let htlc_sighashtype = if self.opt_anchors() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
953                         let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
954                         let holder_htlc_key = chan_utils::derive_private_key(&secp_ctx, &keys.per_commitment_point, &self.htlc_base_key);
955                         htlc_sigs.push(sign(secp_ctx, &htlc_sighash, &holder_htlc_key));
956                 }
957
958                 Ok((commitment_sig, htlc_sigs))
959         }
960
961         fn validate_counterparty_revocation(&self, _idx: u64, _secret: &SecretKey) -> Result<(), ()> {
962                 Ok(())
963         }
964
965         fn sign_holder_commitment_and_htlcs(&self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()> {
966                 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
967                 let funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &self.counterparty_pubkeys().funding_pubkey);
968                 let trusted_tx = commitment_tx.trust();
969                 let sig = trusted_tx.built_transaction().sign_holder_commitment(&self.funding_key, &funding_redeemscript, self.channel_value_satoshis, &self, secp_ctx);
970                 let channel_parameters = self.get_channel_parameters();
971                 let htlc_sigs = trusted_tx.get_htlc_sigs(&self.htlc_base_key, &channel_parameters.as_holder_broadcastable(), &self, secp_ctx)?;
972                 Ok((sig, htlc_sigs))
973         }
974
975         #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
976         fn unsafe_sign_holder_commitment_and_htlcs(&self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()> {
977                 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
978                 let funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &self.counterparty_pubkeys().funding_pubkey);
979                 let trusted_tx = commitment_tx.trust();
980                 let sig = trusted_tx.built_transaction().sign_holder_commitment(&self.funding_key, &funding_redeemscript, self.channel_value_satoshis, &self, secp_ctx);
981                 let channel_parameters = self.get_channel_parameters();
982                 let htlc_sigs = trusted_tx.get_htlc_sigs(&self.htlc_base_key, &channel_parameters.as_holder_broadcastable(), &self, secp_ctx)?;
983                 Ok((sig, htlc_sigs))
984         }
985
986         fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
987                 let revocation_key = chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_key, &self.revocation_base_key);
988                 let per_commitment_point = PublicKey::from_secret_key(secp_ctx, &per_commitment_key);
989                 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
990                 let witness_script = {
991                         let counterparty_delayedpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.counterparty_pubkeys().delayed_payment_basepoint);
992                         chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.holder_selected_contest_delay(), &counterparty_delayedpubkey)
993                 };
994                 let mut sighash_parts = sighash::SighashCache::new(justice_tx);
995                 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
996                 return Ok(sign_with_aux_rand(secp_ctx, &sighash, &revocation_key, &self))
997         }
998
999         fn sign_justice_revoked_htlc(&self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1000                 let revocation_key = chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_key, &self.revocation_base_key);
1001                 let per_commitment_point = PublicKey::from_secret_key(secp_ctx, &per_commitment_key);
1002                 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
1003                 let witness_script = {
1004                         let counterparty_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.counterparty_pubkeys().htlc_basepoint);
1005                         let holder_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.pubkeys().htlc_basepoint);
1006                         chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, self.opt_anchors(), &counterparty_htlcpubkey, &holder_htlcpubkey, &revocation_pubkey)
1007                 };
1008                 let mut sighash_parts = sighash::SighashCache::new(justice_tx);
1009                 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
1010                 return Ok(sign_with_aux_rand(secp_ctx, &sighash, &revocation_key, &self))
1011         }
1012
1013         #[cfg(anchors)]
1014         fn sign_holder_htlc_transaction(
1015                 &self, htlc_tx: &Transaction, input: usize, htlc_descriptor: &HTLCDescriptor,
1016                 secp_ctx: &Secp256k1<secp256k1::All>
1017         ) -> Result<Signature, ()> {
1018                 let per_commitment_point = self.get_per_commitment_point(
1019                         htlc_descriptor.per_commitment_number, &secp_ctx
1020                 );
1021                 let witness_script = htlc_descriptor.witness_script(&per_commitment_point, secp_ctx);
1022                 let sighash = &sighash::SighashCache::new(&*htlc_tx).segwit_signature_hash(
1023                         input, &witness_script, htlc_descriptor.htlc.amount_msat / 1000, EcdsaSighashType::All
1024                 ).map_err(|_| ())?;
1025                 let our_htlc_private_key = chan_utils::derive_private_key(
1026                         &secp_ctx, &per_commitment_point, &self.htlc_base_key
1027                 );
1028                 Ok(sign_with_aux_rand(&secp_ctx, &hash_to_message!(sighash), &our_htlc_private_key, &self))
1029         }
1030
1031         fn sign_counterparty_htlc_transaction(&self, htlc_tx: &Transaction, input: usize, amount: u64, per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1032                 let htlc_key = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &self.htlc_base_key);
1033                 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
1034                 let counterparty_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.counterparty_pubkeys().htlc_basepoint);
1035                 let htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.pubkeys().htlc_basepoint);
1036                 let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, self.opt_anchors(), &counterparty_htlcpubkey, &htlcpubkey, &revocation_pubkey);
1037                 let mut sighash_parts = sighash::SighashCache::new(htlc_tx);
1038                 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
1039                 Ok(sign_with_aux_rand(secp_ctx, &sighash, &htlc_key, &self))
1040         }
1041
1042         fn sign_closing_transaction(&self, closing_tx: &ClosingTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1043                 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
1044                 let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &self.counterparty_pubkeys().funding_pubkey);
1045                 Ok(closing_tx.trust().sign(&self.funding_key, &channel_funding_redeemscript, self.channel_value_satoshis, secp_ctx))
1046         }
1047
1048         fn sign_holder_anchor_input(
1049                 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
1050         ) -> Result<Signature, ()> {
1051                 let witness_script = chan_utils::get_anchor_redeemscript(&self.holder_channel_pubkeys.funding_pubkey);
1052                 let sighash = sighash::SighashCache::new(&*anchor_tx).segwit_signature_hash(
1053                         input, &witness_script, ANCHOR_OUTPUT_VALUE_SATOSHI, EcdsaSighashType::All,
1054                 ).unwrap();
1055                 Ok(sign_with_aux_rand(secp_ctx, &hash_to_message!(&sighash[..]), &self.funding_key, &self))
1056         }
1057
1058         fn sign_channel_announcement_with_funding_key(
1059                 &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<secp256k1::All>
1060         ) -> Result<Signature, ()> {
1061                 let msghash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1062                 Ok(secp_ctx.sign_ecdsa(&msghash, &self.funding_key))
1063         }
1064 }
1065
1066 const SERIALIZATION_VERSION: u8 = 1;
1067
1068 const MIN_SERIALIZATION_VERSION: u8 = 1;
1069
1070 impl WriteableEcdsaChannelSigner for InMemorySigner {}
1071
1072 impl Writeable for InMemorySigner {
1073         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
1074                 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
1075
1076                 self.funding_key.write(writer)?;
1077                 self.revocation_base_key.write(writer)?;
1078                 self.payment_key.write(writer)?;
1079                 self.delayed_payment_base_key.write(writer)?;
1080                 self.htlc_base_key.write(writer)?;
1081                 self.commitment_seed.write(writer)?;
1082                 self.channel_parameters.write(writer)?;
1083                 self.channel_value_satoshis.write(writer)?;
1084                 self.channel_keys_id.write(writer)?;
1085
1086                 write_tlv_fields!(writer, {});
1087
1088                 Ok(())
1089         }
1090 }
1091
1092 impl<ES: Deref> ReadableArgs<ES> for InMemorySigner where ES::Target: EntropySource {
1093         fn read<R: io::Read>(reader: &mut R, entropy_source: ES) -> Result<Self, DecodeError> {
1094                 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
1095
1096                 let funding_key = Readable::read(reader)?;
1097                 let revocation_base_key = Readable::read(reader)?;
1098                 let payment_key = Readable::read(reader)?;
1099                 let delayed_payment_base_key = Readable::read(reader)?;
1100                 let htlc_base_key = Readable::read(reader)?;
1101                 let commitment_seed = Readable::read(reader)?;
1102                 let counterparty_channel_data = Readable::read(reader)?;
1103                 let channel_value_satoshis = Readable::read(reader)?;
1104                 let secp_ctx = Secp256k1::signing_only();
1105                 let holder_channel_pubkeys =
1106                         InMemorySigner::make_holder_keys(&secp_ctx, &funding_key, &revocation_base_key,
1107                                  &payment_key, &delayed_payment_base_key, &htlc_base_key);
1108                 let keys_id = Readable::read(reader)?;
1109
1110                 read_tlv_fields!(reader, {});
1111
1112                 Ok(InMemorySigner {
1113                         funding_key,
1114                         revocation_base_key,
1115                         payment_key,
1116                         delayed_payment_base_key,
1117                         htlc_base_key,
1118                         commitment_seed,
1119                         channel_value_satoshis,
1120                         holder_channel_pubkeys,
1121                         channel_parameters: counterparty_channel_data,
1122                         channel_keys_id: keys_id,
1123                         rand_bytes_unique_start: entropy_source.get_secure_random_bytes(),
1124                         rand_bytes_index: AtomicCounter::new(),
1125                 })
1126         }
1127 }
1128
1129 /// Simple implementation of [`EntropySource`], [`NodeSigner`], and [`SignerProvider`] that takes a
1130 /// 32-byte seed for use as a BIP 32 extended key and derives keys from that.
1131 ///
1132 /// Your `node_id` is seed/0'.
1133 /// Unilateral closes may use seed/1'.
1134 /// Cooperative closes may use seed/2'.
1135 /// The two close keys may be needed to claim on-chain funds!
1136 ///
1137 /// This struct cannot be used for nodes that wish to support receiving phantom payments;
1138 /// [`PhantomKeysManager`] must be used instead.
1139 ///
1140 /// Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
1141 /// previously issued invoices and attempts to pay previous invoices will fail.
1142 pub struct KeysManager {
1143         secp_ctx: Secp256k1<secp256k1::All>,
1144         node_secret: SecretKey,
1145         node_id: PublicKey,
1146         inbound_payment_key: KeyMaterial,
1147         destination_script: Script,
1148         shutdown_pubkey: PublicKey,
1149         channel_master_key: ExtendedPrivKey,
1150         channel_child_index: AtomicUsize,
1151
1152         rand_bytes_unique_start: [u8; 32],
1153         rand_bytes_index: AtomicCounter,
1154
1155         seed: [u8; 32],
1156         starting_time_secs: u64,
1157         starting_time_nanos: u32,
1158 }
1159
1160 impl KeysManager {
1161         /// Constructs a [`KeysManager`] from a 32-byte seed. If the seed is in some way biased (e.g.,
1162         /// your CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1163         /// `starting_time` isn't strictly required to actually be a time, but it must absolutely,
1164         /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1165         /// `seed`, `starting_time` must be unique to each run. Thus, the easiest way to achieve this
1166         /// is to simply use the current time (with very high precision).
1167         ///
1168         /// The `seed` MUST be backed up safely prior to use so that the keys can be re-created, however,
1169         /// obviously, `starting_time` should be unique every time you reload the library - it is only
1170         /// used to generate new ephemeral key data (which will be stored by the individual channel if
1171         /// necessary).
1172         ///
1173         /// Note that the seed is required to recover certain on-chain funds independent of
1174         /// [`ChannelMonitor`] data, though a current copy of [`ChannelMonitor`] data is also required
1175         /// for any channel, and some on-chain during-closing funds.
1176         ///
1177         /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
1178         pub fn new(seed: &[u8; 32], starting_time_secs: u64, starting_time_nanos: u32) -> Self {
1179                 let secp_ctx = Secp256k1::new();
1180                 // Note that when we aren't serializing the key, network doesn't matter
1181                 match ExtendedPrivKey::new_master(Network::Testnet, seed) {
1182                         Ok(master_key) => {
1183                                 let node_secret = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(0).unwrap()).expect("Your RNG is busted").private_key;
1184                                 let node_id = PublicKey::from_secret_key(&secp_ctx, &node_secret);
1185                                 let destination_script = match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(1).unwrap()) {
1186                                         Ok(destination_key) => {
1187                                                 let wpubkey_hash = WPubkeyHash::hash(&ExtendedPubKey::from_priv(&secp_ctx, &destination_key).to_pub().to_bytes());
1188                                                 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1189                                                         .push_slice(&wpubkey_hash.into_inner())
1190                                                         .into_script()
1191                                         },
1192                                         Err(_) => panic!("Your RNG is busted"),
1193                                 };
1194                                 let shutdown_pubkey = match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(2).unwrap()) {
1195                                         Ok(shutdown_key) => ExtendedPubKey::from_priv(&secp_ctx, &shutdown_key).public_key,
1196                                         Err(_) => panic!("Your RNG is busted"),
1197                                 };
1198                                 let channel_master_key = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(3).unwrap()).expect("Your RNG is busted");
1199                                 let inbound_payment_key: SecretKey = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(5).unwrap()).expect("Your RNG is busted").private_key;
1200                                 let mut inbound_pmt_key_bytes = [0; 32];
1201                                 inbound_pmt_key_bytes.copy_from_slice(&inbound_payment_key[..]);
1202
1203                                 let mut rand_bytes_engine = Sha256::engine();
1204                                 rand_bytes_engine.input(&starting_time_secs.to_be_bytes());
1205                                 rand_bytes_engine.input(&starting_time_nanos.to_be_bytes());
1206                                 rand_bytes_engine.input(seed);
1207                                 rand_bytes_engine.input(b"LDK PRNG Seed");
1208                                 let rand_bytes_unique_start = Sha256::from_engine(rand_bytes_engine).into_inner();
1209
1210                                 let mut res = KeysManager {
1211                                         secp_ctx,
1212                                         node_secret,
1213                                         node_id,
1214                                         inbound_payment_key: KeyMaterial(inbound_pmt_key_bytes),
1215
1216                                         destination_script,
1217                                         shutdown_pubkey,
1218
1219                                         channel_master_key,
1220                                         channel_child_index: AtomicUsize::new(0),
1221
1222                                         rand_bytes_unique_start,
1223                                         rand_bytes_index: AtomicCounter::new(),
1224
1225                                         seed: *seed,
1226                                         starting_time_secs,
1227                                         starting_time_nanos,
1228                                 };
1229                                 let secp_seed = res.get_secure_random_bytes();
1230                                 res.secp_ctx.seeded_randomize(&secp_seed);
1231                                 res
1232                         },
1233                         Err(_) => panic!("Your rng is busted"),
1234                 }
1235         }
1236
1237         /// Gets the "node_id" secret key used to sign gossip announcements, decode onion data, etc.
1238         pub fn get_node_secret_key(&self) -> SecretKey {
1239                 self.node_secret
1240         }
1241
1242         /// Derive an old [`WriteableEcdsaChannelSigner`] containing per-channel secrets based on a key derivation parameters.
1243         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, params: &[u8; 32]) -> InMemorySigner {
1244                 let chan_id = u64::from_be_bytes(params[0..8].try_into().unwrap());
1245                 let mut unique_start = Sha256::engine();
1246                 unique_start.input(params);
1247                 unique_start.input(&self.seed);
1248
1249                 // We only seriously intend to rely on the channel_master_key for true secure
1250                 // entropy, everything else just ensures uniqueness. We rely on the unique_start (ie
1251                 // starting_time provided in the constructor) to be unique.
1252                 let child_privkey = self.channel_master_key.ckd_priv(&self.secp_ctx,
1253                                 ChildNumber::from_hardened_idx((chan_id as u32) % (1 << 31)).expect("key space exhausted")
1254                         ).expect("Your RNG is busted");
1255                 unique_start.input(&child_privkey.private_key[..]);
1256
1257                 let seed = Sha256::from_engine(unique_start).into_inner();
1258
1259                 let commitment_seed = {
1260                         let mut sha = Sha256::engine();
1261                         sha.input(&seed);
1262                         sha.input(&b"commitment seed"[..]);
1263                         Sha256::from_engine(sha).into_inner()
1264                 };
1265                 macro_rules! key_step {
1266                         ($info: expr, $prev_key: expr) => {{
1267                                 let mut sha = Sha256::engine();
1268                                 sha.input(&seed);
1269                                 sha.input(&$prev_key[..]);
1270                                 sha.input(&$info[..]);
1271                                 SecretKey::from_slice(&Sha256::from_engine(sha).into_inner()).expect("SHA-256 is busted")
1272                         }}
1273                 }
1274                 let funding_key = key_step!(b"funding key", commitment_seed);
1275                 let revocation_base_key = key_step!(b"revocation base key", funding_key);
1276                 let payment_key = key_step!(b"payment key", revocation_base_key);
1277                 let delayed_payment_base_key = key_step!(b"delayed payment base key", payment_key);
1278                 let htlc_base_key = key_step!(b"HTLC base key", delayed_payment_base_key);
1279                 let prng_seed = self.get_secure_random_bytes();
1280
1281                 InMemorySigner::new(
1282                         &self.secp_ctx,
1283                         funding_key,
1284                         revocation_base_key,
1285                         payment_key,
1286                         delayed_payment_base_key,
1287                         htlc_base_key,
1288                         commitment_seed,
1289                         channel_value_satoshis,
1290                         params.clone(),
1291                         prng_seed,
1292                 )
1293         }
1294
1295         /// Signs the given [`PartiallySignedTransaction`] which spends the given [`SpendableOutputDescriptor`]s.
1296         /// The resulting inputs will be finalized and the PSBT will be ready for broadcast if there
1297         /// are no other inputs that need signing.
1298         ///
1299         /// Returns `Err(())` if the PSBT is missing a descriptor or if we fail to sign.
1300         ///
1301         /// May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
1302         /// this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
1303         pub fn sign_spendable_outputs_psbt<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], psbt: &mut PartiallySignedTransaction, secp_ctx: &Secp256k1<C>) -> Result<(), ()> {
1304                 let mut keys_cache: Option<(InMemorySigner, [u8; 32])> = None;
1305                 for outp in descriptors {
1306                         match outp {
1307                                 SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
1308                                         let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == descriptor.outpoint.into_bitcoin_outpoint()).ok_or(())?;
1309                                         if keys_cache.is_none() || keys_cache.as_ref().unwrap().1 != descriptor.channel_keys_id {
1310                                                 keys_cache = Some((
1311                                                         self.derive_channel_keys(descriptor.channel_value_satoshis, &descriptor.channel_keys_id),
1312                                                         descriptor.channel_keys_id));
1313                                         }
1314                                         let witness = Witness::from_vec(keys_cache.as_ref().unwrap().0.sign_counterparty_payment_input(&psbt.unsigned_tx, input_idx, &descriptor, &secp_ctx)?);
1315                                         psbt.inputs[input_idx].final_script_witness = Some(witness);
1316                                 },
1317                                 SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
1318                                         let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == descriptor.outpoint.into_bitcoin_outpoint()).ok_or(())?;
1319                                         if keys_cache.is_none() || keys_cache.as_ref().unwrap().1 != descriptor.channel_keys_id {
1320                                                 keys_cache = Some((
1321                                                         self.derive_channel_keys(descriptor.channel_value_satoshis, &descriptor.channel_keys_id),
1322                                                         descriptor.channel_keys_id));
1323                                         }
1324                                         let witness = Witness::from_vec(keys_cache.as_ref().unwrap().0.sign_dynamic_p2wsh_input(&psbt.unsigned_tx, input_idx, &descriptor, &secp_ctx)?);
1325                                         psbt.inputs[input_idx].final_script_witness = Some(witness);
1326                                 },
1327                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
1328                                         let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == outpoint.into_bitcoin_outpoint()).ok_or(())?;
1329                                         let derivation_idx = if output.script_pubkey == self.destination_script {
1330                                                 1
1331                                         } else {
1332                                                 2
1333                                         };
1334                                         let secret = {
1335                                                 // Note that when we aren't serializing the key, network doesn't matter
1336                                                 match ExtendedPrivKey::new_master(Network::Testnet, &self.seed) {
1337                                                         Ok(master_key) => {
1338                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(derivation_idx).expect("key space exhausted")) {
1339                                                                         Ok(key) => key,
1340                                                                         Err(_) => panic!("Your RNG is busted"),
1341                                                                 }
1342                                                         }
1343                                                         Err(_) => panic!("Your rng is busted"),
1344                                                 }
1345                                         };
1346                                         let pubkey = ExtendedPubKey::from_priv(&secp_ctx, &secret).to_pub();
1347                                         if derivation_idx == 2 {
1348                                                 assert_eq!(pubkey.inner, self.shutdown_pubkey);
1349                                         }
1350                                         let witness_script = bitcoin::Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
1351                                         let payment_script = bitcoin::Address::p2wpkh(&pubkey, Network::Testnet).expect("uncompressed key found").script_pubkey();
1352
1353                                         if payment_script != output.script_pubkey { return Err(()); };
1354
1355                                         let sighash = hash_to_message!(&sighash::SighashCache::new(&psbt.unsigned_tx).segwit_signature_hash(input_idx, &witness_script, output.value, EcdsaSighashType::All).unwrap()[..]);
1356                                         let sig = sign_with_aux_rand(secp_ctx, &sighash, &secret.private_key, &self);
1357                                         let mut sig_ser = sig.serialize_der().to_vec();
1358                                         sig_ser.push(EcdsaSighashType::All as u8);
1359                                         let witness = Witness::from_vec(vec![sig_ser, pubkey.inner.serialize().to_vec()]);
1360                                         psbt.inputs[input_idx].final_script_witness = Some(witness);
1361                                 },
1362                         }
1363                 }
1364
1365                 Ok(())
1366         }
1367
1368         /// Creates a [`Transaction`] which spends the given descriptors to the given outputs, plus an
1369         /// output to the given change destination (if sufficient change value remains). The
1370         /// transaction will have a feerate, at least, of the given value.
1371         ///
1372         /// The `locktime` argument is used to set the transaction's locktime. If `None`, the
1373         /// transaction will have a locktime of 0. It it recommended to set this to the current block
1374         /// height to avoid fee sniping, unless you have some specific reason to use a different
1375         /// locktime.
1376         ///
1377         /// Returns `Err(())` if the output value is greater than the input value minus required fee,
1378         /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
1379         /// does not match the one we can spend.
1380         ///
1381         /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1382         ///
1383         /// May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
1384         /// this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
1385         pub fn spend_spendable_outputs<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: Script, feerate_sat_per_1000_weight: u32, locktime: Option<PackedLockTime>, secp_ctx: &Secp256k1<C>) -> Result<Transaction, ()> {
1386                 let (mut psbt, expected_max_weight) = SpendableOutputDescriptor::create_spendable_outputs_psbt(descriptors, outputs, change_destination_script, feerate_sat_per_1000_weight, locktime)?;
1387                 self.sign_spendable_outputs_psbt(descriptors, &mut psbt, secp_ctx)?;
1388
1389                 let spend_tx = psbt.extract_tx();
1390
1391                 debug_assert!(expected_max_weight >= spend_tx.weight());
1392                 // Note that witnesses with a signature vary somewhat in size, so allow
1393                 // `expected_max_weight` to overshoot by up to 3 bytes per input.
1394                 debug_assert!(expected_max_weight <= spend_tx.weight() + descriptors.len() * 3);
1395
1396                 Ok(spend_tx)
1397         }
1398 }
1399
1400 impl EntropySource for KeysManager {
1401         fn get_secure_random_bytes(&self) -> [u8; 32] {
1402                 let index = self.rand_bytes_index.get_increment();
1403                 let mut nonce = [0u8; 16];
1404                 nonce[..8].copy_from_slice(&index.to_be_bytes());
1405                 ChaCha20::get_single_block(&self.rand_bytes_unique_start, &nonce)
1406         }
1407 }
1408
1409 impl NodeSigner for KeysManager {
1410         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1411                 match recipient {
1412                         Recipient::Node => Ok(self.node_id.clone()),
1413                         Recipient::PhantomNode => Err(())
1414                 }
1415         }
1416
1417         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1418                 let mut node_secret = match recipient {
1419                         Recipient::Node => Ok(self.node_secret.clone()),
1420                         Recipient::PhantomNode => Err(())
1421                 }?;
1422                 if let Some(tweak) = tweak {
1423                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1424                 }
1425                 Ok(SharedSecret::new(other_key, &node_secret))
1426         }
1427
1428         fn get_inbound_payment_key_material(&self) -> KeyMaterial {
1429                 self.inbound_payment_key.clone()
1430         }
1431
1432         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1433                 let preimage = construct_invoice_preimage(&hrp_bytes, &invoice_data);
1434                 let secret = match recipient {
1435                         Recipient::Node => Ok(&self.node_secret),
1436                         Recipient::PhantomNode => Err(())
1437                 }?;
1438                 Ok(self.secp_ctx.sign_ecdsa_recoverable(&hash_to_message!(&Sha256::hash(&preimage)), secret))
1439         }
1440
1441         fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()> {
1442                 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1443                 Ok(self.secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
1444         }
1445 }
1446
1447 impl SignerProvider for KeysManager {
1448         type Signer = InMemorySigner;
1449
1450         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1451                 let child_idx = self.channel_child_index.fetch_add(1, Ordering::AcqRel);
1452                 // `child_idx` is the only thing guaranteed to make each channel unique without a restart
1453                 // (though `user_channel_id` should help, depending on user behavior). If it manages to
1454                 // roll over, we may generate duplicate keys for two different channels, which could result
1455                 // in loss of funds. Because we only support 32-bit+ systems, assert that our `AtomicUsize`
1456                 // doesn't reach `u32::MAX`.
1457                 assert!(child_idx < core::u32::MAX as usize, "2^32 channels opened without restart");
1458                 let mut id = [0; 32];
1459                 id[0..4].copy_from_slice(&(child_idx as u32).to_be_bytes());
1460                 id[4..8].copy_from_slice(&self.starting_time_nanos.to_be_bytes());
1461                 id[8..16].copy_from_slice(&self.starting_time_secs.to_be_bytes());
1462                 id[16..32].copy_from_slice(&user_channel_id.to_be_bytes());
1463                 id
1464         }
1465
1466         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
1467                 self.derive_channel_keys(channel_value_satoshis, &channel_keys_id)
1468         }
1469
1470         fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError> {
1471                 InMemorySigner::read(&mut io::Cursor::new(reader), self)
1472         }
1473
1474         fn get_destination_script(&self) -> Result<Script, ()> {
1475                 Ok(self.destination_script.clone())
1476         }
1477
1478         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1479                 Ok(ShutdownScript::new_p2wpkh_from_pubkey(self.shutdown_pubkey.clone()))
1480         }
1481 }
1482
1483 /// Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
1484 /// payments.
1485 ///
1486 /// A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
1487 /// paid to one of multiple nodes. This works because we encode the invoice route hints such that
1488 /// LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
1489 /// itself without ever needing to forward to this fake node.
1490 ///
1491 /// Phantom node payments are useful for load balancing between multiple LDK nodes. They also
1492 /// provide some fault tolerance, because payers will automatically retry paying other provided
1493 /// nodes in the case that one node goes down.
1494 ///
1495 /// Note that multi-path payments are not supported in phantom invoices for security reasons.
1496 // In the hypothetical case that we did support MPP phantom payments, there would be no way for
1497 // nodes to know when the full payment has been received (and the preimage can be released) without
1498 // significantly compromising on our safety guarantees. I.e., if we expose the ability for the user
1499 // to tell LDK when the preimage can be released, we open ourselves to attacks where the preimage
1500 // is released too early.
1501 //
1502 /// Switching between this struct and [`KeysManager`] will invalidate any previously issued
1503 /// invoices and attempts to pay previous invoices will fail.
1504 pub struct PhantomKeysManager {
1505         inner: KeysManager,
1506         inbound_payment_key: KeyMaterial,
1507         phantom_secret: SecretKey,
1508         phantom_node_id: PublicKey,
1509 }
1510
1511 impl EntropySource for PhantomKeysManager {
1512         fn get_secure_random_bytes(&self) -> [u8; 32] {
1513                 self.inner.get_secure_random_bytes()
1514         }
1515 }
1516
1517 impl NodeSigner for PhantomKeysManager {
1518         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1519                 match recipient {
1520                         Recipient::Node => self.inner.get_node_id(Recipient::Node),
1521                         Recipient::PhantomNode => Ok(self.phantom_node_id.clone()),
1522                 }
1523         }
1524
1525         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1526                 let mut node_secret = match recipient {
1527                         Recipient::Node => self.inner.node_secret.clone(),
1528                         Recipient::PhantomNode => self.phantom_secret.clone(),
1529                 };
1530                 if let Some(tweak) = tweak {
1531                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1532                 }
1533                 Ok(SharedSecret::new(other_key, &node_secret))
1534         }
1535
1536         fn get_inbound_payment_key_material(&self) -> KeyMaterial {
1537                 self.inbound_payment_key.clone()
1538         }
1539
1540         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1541                 let preimage = construct_invoice_preimage(&hrp_bytes, &invoice_data);
1542                 let secret = match recipient {
1543                         Recipient::Node => &self.inner.node_secret,
1544                         Recipient::PhantomNode => &self.phantom_secret,
1545                 };
1546                 Ok(self.inner.secp_ctx.sign_ecdsa_recoverable(&hash_to_message!(&Sha256::hash(&preimage)), secret))
1547         }
1548
1549         fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()> {
1550                 self.inner.sign_gossip_message(msg)
1551         }
1552 }
1553
1554 impl SignerProvider for PhantomKeysManager {
1555         type Signer = InMemorySigner;
1556
1557         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1558                 self.inner.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1559         }
1560
1561         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
1562                 self.inner.derive_channel_signer(channel_value_satoshis, channel_keys_id)
1563         }
1564
1565         fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError> {
1566                 self.inner.read_chan_signer(reader)
1567         }
1568
1569         fn get_destination_script(&self) -> Result<Script, ()> {
1570                 self.inner.get_destination_script()
1571         }
1572
1573         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1574                 self.inner.get_shutdown_scriptpubkey()
1575         }
1576 }
1577
1578 impl PhantomKeysManager {
1579         /// Constructs a [`PhantomKeysManager`] given a 32-byte seed and an additional `cross_node_seed`
1580         /// that is shared across all nodes that intend to participate in [phantom node payments]
1581         /// together.
1582         ///
1583         /// See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
1584         /// `starting_time_nanos`.
1585         ///
1586         /// `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
1587         /// same across restarts, or else inbound payments may fail.
1588         ///
1589         /// [phantom node payments]: PhantomKeysManager
1590         pub fn new(seed: &[u8; 32], starting_time_secs: u64, starting_time_nanos: u32, cross_node_seed: &[u8; 32]) -> Self {
1591                 let inner = KeysManager::new(seed, starting_time_secs, starting_time_nanos);
1592                 let (inbound_key, phantom_key) = hkdf_extract_expand_twice(b"LDK Inbound and Phantom Payment Key Expansion", cross_node_seed);
1593                 let phantom_secret = SecretKey::from_slice(&phantom_key).unwrap();
1594                 let phantom_node_id = PublicKey::from_secret_key(&inner.secp_ctx, &phantom_secret);
1595                 Self {
1596                         inner,
1597                         inbound_payment_key: KeyMaterial(inbound_key),
1598                         phantom_secret,
1599                         phantom_node_id,
1600                 }
1601         }
1602
1603         /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
1604         pub fn spend_spendable_outputs<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: Script, feerate_sat_per_1000_weight: u32, locktime: Option<PackedLockTime>, secp_ctx: &Secp256k1<C>) -> Result<Transaction, ()> {
1605                 self.inner.spend_spendable_outputs(descriptors, outputs, change_destination_script, feerate_sat_per_1000_weight, locktime, secp_ctx)
1606         }
1607
1608         /// See [`KeysManager::derive_channel_keys`] for documentation on this method.
1609         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, params: &[u8; 32]) -> InMemorySigner {
1610                 self.inner.derive_channel_keys(channel_value_satoshis, params)
1611         }
1612
1613         /// Gets the "node_id" secret key used to sign gossip announcements, decode onion data, etc.
1614         pub fn get_node_secret_key(&self) -> SecretKey {
1615                 self.inner.get_node_secret_key()
1616         }
1617
1618         /// Gets the "node_id" secret key of the phantom node used to sign invoices, decode the
1619         /// last-hop onion data, etc.
1620         pub fn get_phantom_node_secret_key(&self) -> SecretKey {
1621                 self.phantom_secret
1622         }
1623 }
1624
1625 // Ensure that EcdsaChannelSigner can have a vtable
1626 #[test]
1627 pub fn dyn_sign() {
1628         let _signer: Box<dyn EcdsaChannelSigner>;
1629 }
1630
1631 #[cfg(all(test, feature = "_bench_unstable", not(feature = "no-std")))]
1632 mod benches {
1633         use std::sync::{Arc, mpsc};
1634         use std::sync::mpsc::TryRecvError;
1635         use std::thread;
1636         use std::time::Duration;
1637         use bitcoin::blockdata::constants::genesis_block;
1638         use bitcoin::Network;
1639         use crate::sign::{EntropySource, KeysManager};
1640
1641         use test::Bencher;
1642
1643         #[bench]
1644         fn bench_get_secure_random_bytes(bench: &mut Bencher) {
1645                 let seed = [0u8; 32];
1646                 let now = Duration::from_secs(genesis_block(Network::Testnet).header.time as u64);
1647                 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_micros()));
1648
1649                 let mut handles = Vec::new();
1650                 let mut stops = Vec::new();
1651                 for _ in 1..5 {
1652                         let keys_manager_clone = Arc::clone(&keys_manager);
1653                         let (stop_sender, stop_receiver) = mpsc::channel();
1654                         let handle = thread::spawn(move || {
1655                                 loop {
1656                                         keys_manager_clone.get_secure_random_bytes();
1657                                         match stop_receiver.try_recv() {
1658                                                 Ok(_) | Err(TryRecvError::Disconnected) => {
1659                                                         println!("Terminating.");
1660                                                         break;
1661                                                 }
1662                                                 Err(TryRecvError::Empty) => {}
1663                                         }
1664                                 }
1665                         });
1666                         handles.push(handle);
1667                         stops.push(stop_sender);
1668                 }
1669
1670                 bench.iter(|| {
1671                         for _ in 1..100 {
1672                                 keys_manager.get_secure_random_bytes();
1673                         }
1674                 });
1675
1676                 for stop in stops {
1677                         let _ = stop.send(());
1678                 }
1679                 for handle in handles {
1680                         handle.join().unwrap();
1681                 }
1682         }
1683
1684 }