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