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