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::locktime::absolute::LockTime;
16 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn};
17 use bitcoin::blockdata::script::{Script, ScriptBuf, Builder};
18 use bitcoin::blockdata::opcodes;
19 use bitcoin::ecdsa::Signature as EcdsaSignature;
20 use bitcoin::network::constants::Network;
21 use bitcoin::psbt::PartiallySignedTransaction;
22 use bitcoin::bip32::{ExtendedPrivKey, ExtendedPubKey, ChildNumber};
24 use bitcoin::sighash::EcdsaSighashType;
26 use bitcoin::bech32::u5;
27 use bitcoin::hashes::{Hash, HashEngine};
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hash_types::WPubkeyHash;
32 use bitcoin::secp256k1::{KeyPair, PublicKey, Scalar, Secp256k1, SecretKey, Signing};
33 use bitcoin::secp256k1::ecdh::SharedSecret;
34 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
35 use bitcoin::secp256k1::schnorr;
36 use bitcoin::{secp256k1, Sequence, Witness, Txid};
38 use crate::util::transaction_utils;
39 use crate::util::crypto::{hkdf_extract_expand_twice, sign, sign_with_aux_rand};
40 use crate::util::ser::{Writeable, Writer, Readable, ReadableArgs};
41 use crate::chain::transaction::OutPoint;
42 use crate::ln::channel::ANCHOR_OUTPUT_VALUE_SATOSHI;
43 use crate::ln::{chan_utils, PaymentPreimage};
44 use crate::ln::chan_utils::{HTLCOutputInCommitment, make_funding_redeemscript, ChannelPublicKeys, HolderCommitmentTransaction, ChannelTransactionParameters, CommitmentTransaction, ClosingTransaction};
45 use crate::ln::msgs::{UnsignedChannelAnnouncement, UnsignedGossipMessage};
46 use crate::ln::script::ShutdownScript;
47 use crate::offers::invoice::UnsignedBolt12Invoice;
48 use crate::offers::invoice_request::UnsignedInvoiceRequest;
50 use crate::prelude::*;
51 use core::convert::TryInto;
53 use core::sync::atomic::{AtomicUsize, Ordering};
54 use crate::io::{self, Error};
55 use crate::ln::features::ChannelTypeFeatures;
56 use crate::ln::msgs::{DecodeError, MAX_VALUE_MSAT};
57 use crate::util::atomic_counter::AtomicCounter;
58 use crate::util::chacha20::ChaCha20;
59 use crate::util::invoice::construct_invoice_preimage;
61 pub(crate) mod type_resolver;
63 /// Used as initial key material, to be expanded into multiple secret keys (but not to be used
64 /// directly). This is used within LDK to encrypt/decrypt inbound payment data.
66 /// This is not exported to bindings users as we just use `[u8; 32]` directly
67 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
68 pub struct KeyMaterial(pub [u8; 32]);
70 /// Information about a spendable output to a P2WSH script.
72 /// See [`SpendableOutputDescriptor::DelayedPaymentOutput`] for more details on how to spend this.
73 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
74 pub struct DelayedPaymentOutputDescriptor {
75 /// The outpoint which is spendable.
76 pub outpoint: OutPoint,
77 /// Per commitment point to derive the delayed payment key by key holder.
78 pub per_commitment_point: PublicKey,
79 /// The `nSequence` value which must be set in the spending input to satisfy the `OP_CSV` in
80 /// the witness_script.
81 pub to_self_delay: u16,
82 /// The output which is referenced by the given outpoint.
84 /// The revocation point specific to the commitment transaction which was broadcast. Used to
85 /// derive the witnessScript for this output.
86 pub revocation_pubkey: PublicKey,
87 /// Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
88 /// This may be useful in re-deriving keys used in the channel to spend the output.
89 pub channel_keys_id: [u8; 32],
90 /// The value of the channel which this output originated from, possibly indirectly.
91 pub channel_value_satoshis: u64,
93 impl DelayedPaymentOutputDescriptor {
94 /// The maximum length a well-formed witness spending one of these should have.
95 /// Note: If you have the grind_signatures feature enabled, this will be at least 1 byte
97 // Calculated as 1 byte length + 73 byte signature, 1 byte empty vec push, 1 byte length plus
98 // redeemscript push length.
99 pub const MAX_WITNESS_LENGTH: u64 = 1 + 73 + 1 + chan_utils::REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH as u64 + 1;
102 impl_writeable_tlv_based!(DelayedPaymentOutputDescriptor, {
103 (0, outpoint, required),
104 (2, per_commitment_point, required),
105 (4, to_self_delay, required),
106 (6, output, required),
107 (8, revocation_pubkey, required),
108 (10, channel_keys_id, required),
109 (12, channel_value_satoshis, required),
112 pub(crate) const P2WPKH_WITNESS_WEIGHT: u64 = 1 /* num stack items */ +
114 73 /* sig including sighash flag */ +
115 1 /* pubkey length */ +
118 /// Information about a spendable output to our "payment key".
120 /// See [`SpendableOutputDescriptor::StaticPaymentOutput`] for more details on how to spend this.
121 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
122 pub struct StaticPaymentOutputDescriptor {
123 /// The outpoint which is spendable.
124 pub outpoint: OutPoint,
125 /// The output which is referenced by the given outpoint.
127 /// Arbitrary identification information returned by a call to [`ChannelSigner::channel_keys_id`].
128 /// This may be useful in re-deriving keys used in the channel to spend the output.
129 pub channel_keys_id: [u8; 32],
130 /// The value of the channel which this transactions spends.
131 pub channel_value_satoshis: u64,
132 /// The necessary channel parameters that need to be provided to the re-derived signer through
133 /// [`ChannelSigner::provide_channel_parameters`].
135 /// Added as optional, but always `Some` if the descriptor was produced in v0.0.117 or later.
136 pub channel_transaction_parameters: Option<ChannelTransactionParameters>,
138 impl StaticPaymentOutputDescriptor {
139 /// Returns the `witness_script` of the spendable output.
141 /// Note that this will only return `Some` for [`StaticPaymentOutputDescriptor`]s that
142 /// originated from an anchor outputs channel, as they take the form of a P2WSH script.
143 pub fn witness_script(&self) -> Option<ScriptBuf> {
144 self.channel_transaction_parameters.as_ref()
145 .and_then(|channel_params|
146 if channel_params.channel_type_features.supports_anchors_zero_fee_htlc_tx() {
147 let payment_point = channel_params.holder_pubkeys.payment_point;
148 Some(chan_utils::get_to_countersignatory_with_anchors_redeemscript(&payment_point))
155 /// The maximum length a well-formed witness spending one of these should have.
156 /// Note: If you have the grind_signatures feature enabled, this will be at least 1 byte
158 pub fn max_witness_length(&self) -> u64 {
159 if self.channel_transaction_parameters.as_ref()
160 .map(|channel_params| channel_params.channel_type_features.supports_anchors_zero_fee_htlc_tx())
163 let witness_script_weight = 1 /* pubkey push */ + 33 /* pubkey */ +
164 1 /* OP_CHECKSIGVERIFY */ + 1 /* OP_1 */ + 1 /* OP_CHECKSEQUENCEVERIFY */;
165 1 /* num witness items */ + 1 /* sig push */ + 73 /* sig including sighash flag */ +
166 1 /* witness script push */ + witness_script_weight
168 P2WPKH_WITNESS_WEIGHT
172 impl_writeable_tlv_based!(StaticPaymentOutputDescriptor, {
173 (0, outpoint, required),
174 (2, output, required),
175 (4, channel_keys_id, required),
176 (6, channel_value_satoshis, required),
177 (7, channel_transaction_parameters, option),
180 /// Describes the necessary information to spend a spendable output.
182 /// When on-chain outputs are created by LDK (which our counterparty is not able to claim at any
183 /// point in the future) a [`SpendableOutputs`] event is generated which you must track and be able
184 /// to spend on-chain. The information needed to do this is provided in this enum, including the
185 /// outpoint describing which `txid` and output `index` is available, the full output which exists
186 /// at that `txid`/`index`, and any keys or other information required to sign.
188 /// [`SpendableOutputs`]: crate::events::Event::SpendableOutputs
189 #[derive(Clone, Debug, Hash, PartialEq, Eq)]
190 pub enum SpendableOutputDescriptor {
191 /// An output to a script which was provided via [`SignerProvider`] directly, either from
192 /// [`get_destination_script`] or [`get_shutdown_scriptpubkey`], thus you should already
193 /// know how to spend it. No secret keys are provided as LDK was never given any key.
194 /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
195 /// on-chain using the payment preimage or after it has timed out.
197 /// [`get_shutdown_scriptpubkey`]: SignerProvider::get_shutdown_scriptpubkey
198 /// [`get_destination_script`]: SignerProvider::get_shutdown_scriptpubkey
200 /// The outpoint which is spendable.
202 /// The output which is referenced by the given outpoint.
205 /// An output to a P2WSH script which can be spent with a single signature after an `OP_CSV`
208 /// The witness in the spending input should be:
210 /// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
213 /// Note that the `nSequence` field in the spending input must be set to
214 /// [`DelayedPaymentOutputDescriptor::to_self_delay`] (which means the transaction is not
215 /// broadcastable until at least [`DelayedPaymentOutputDescriptor::to_self_delay`] blocks after
216 /// the outpoint confirms, see [BIP
217 /// 68](https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki)). Also note that LDK
218 /// won't generate a [`SpendableOutputDescriptor`] until the corresponding block height
221 /// These are generally the result of a "revocable" output to us, spendable only by us unless
222 /// it is an output from an old state which we broadcast (which should never happen).
224 /// To derive the delayed payment key which is used to sign this input, you must pass the
225 /// holder [`InMemorySigner::delayed_payment_base_key`] (i.e., the private key which corresponds to the
226 /// [`ChannelPublicKeys::delayed_payment_basepoint`] in [`ChannelSigner::pubkeys`]) and the provided
227 /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to [`chan_utils::derive_private_key`]. The public key can be
228 /// generated without the secret key using [`chan_utils::derive_public_key`] and only the
229 /// [`ChannelPublicKeys::delayed_payment_basepoint`] which appears in [`ChannelSigner::pubkeys`].
231 /// To derive the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] provided here (which is
232 /// used in the witness script generation), you must pass the counterparty
233 /// [`ChannelPublicKeys::revocation_basepoint`] (which appears in the call to
234 /// [`ChannelSigner::provide_channel_parameters`]) and the provided
235 /// [`DelayedPaymentOutputDescriptor::per_commitment_point`] to
236 /// [`chan_utils::derive_public_revocation_key`].
238 /// The witness script which is hashed and included in the output `script_pubkey` may be
239 /// regenerated by passing the [`DelayedPaymentOutputDescriptor::revocation_pubkey`] (derived
240 /// as explained above), our delayed payment pubkey (derived as explained above), and the
241 /// [`DelayedPaymentOutputDescriptor::to_self_delay`] contained here to
242 /// [`chan_utils::get_revokeable_redeemscript`].
243 DelayedPaymentOutput(DelayedPaymentOutputDescriptor),
244 /// An output spendable exclusively by our payment key (i.e., the private key that corresponds
245 /// to the `payment_point` in [`ChannelSigner::pubkeys`]). The output type depends on the
246 /// channel type negotiated.
248 /// On an anchor outputs channel, the witness in the spending input is:
250 /// <BIP 143 signature> <witness script>
253 /// Otherwise, it is:
255 /// <BIP 143 signature> <payment key>
258 /// These are generally the result of our counterparty having broadcast the current state,
259 /// allowing us to claim the non-HTLC-encumbered outputs immediately, or after one confirmation
260 /// in the case of anchor outputs channels.
261 StaticPaymentOutput(StaticPaymentOutputDescriptor),
264 impl_writeable_tlv_based_enum!(SpendableOutputDescriptor,
265 (0, StaticOutput) => {
266 (0, outpoint, required),
267 (2, output, required),
270 (1, DelayedPaymentOutput),
271 (2, StaticPaymentOutput),
274 impl SpendableOutputDescriptor {
275 /// Turns this into a [`bitcoin::psbt::Input`] which can be used to create a
276 /// [`PartiallySignedTransaction`] which spends the given descriptor.
278 /// Note that this does not include any signatures, just the information required to
279 /// construct the transaction and sign it.
281 /// This is not exported to bindings users as there is no standard serialization for an input.
282 /// See [`Self::create_spendable_outputs_psbt`] instead.
283 pub fn to_psbt_input(&self) -> bitcoin::psbt::Input {
285 SpendableOutputDescriptor::StaticOutput { output, .. } => {
286 // Is a standard P2WPKH, no need for witness script
287 bitcoin::psbt::Input {
288 witness_utxo: Some(output.clone()),
292 SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
293 // TODO we could add the witness script as well
294 bitcoin::psbt::Input {
295 witness_utxo: Some(descriptor.output.clone()),
299 SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
300 // TODO we could add the witness script as well
301 bitcoin::psbt::Input {
302 witness_utxo: Some(descriptor.output.clone()),
309 /// Creates an unsigned [`PartiallySignedTransaction`] which spends the given descriptors to
310 /// the given outputs, plus an output to the given change destination (if sufficient
311 /// change value remains). The PSBT will have a feerate, at least, of the given value.
313 /// The `locktime` argument is used to set the transaction's locktime. If `None`, the
314 /// transaction will have a locktime of 0. It it recommended to set this to the current block
315 /// height to avoid fee sniping, unless you have some specific reason to use a different
318 /// Returns the PSBT and expected max transaction weight.
320 /// Returns `Err(())` if the output value is greater than the input value minus required fee,
321 /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
322 /// does not match the one we can spend.
324 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
325 pub fn create_spendable_outputs_psbt(descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: ScriptBuf, feerate_sat_per_1000_weight: u32, locktime: Option<LockTime>) -> Result<(PartiallySignedTransaction, u64), ()> {
326 let mut input = Vec::with_capacity(descriptors.len());
327 let mut input_value = 0;
328 let mut witness_weight = 0;
329 let mut output_set = HashSet::with_capacity(descriptors.len());
330 for outp in descriptors {
332 SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
333 if !output_set.insert(descriptor.outpoint) { return Err(()); }
335 if descriptor.channel_transaction_parameters.as_ref()
336 .map(|channel_params| channel_params.channel_type_features.supports_anchors_zero_fee_htlc_tx())
339 Sequence::from_consensus(1)
344 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
345 script_sig: ScriptBuf::new(),
347 witness: Witness::new(),
349 witness_weight += descriptor.max_witness_length();
350 #[cfg(feature = "grind_signatures")]
351 { witness_weight -= 1; } // Guarantees a low R signature
352 input_value += descriptor.output.value;
354 SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
355 if !output_set.insert(descriptor.outpoint) { return Err(()); }
357 previous_output: descriptor.outpoint.into_bitcoin_outpoint(),
358 script_sig: ScriptBuf::new(),
359 sequence: Sequence(descriptor.to_self_delay as u32),
360 witness: Witness::new(),
362 witness_weight += DelayedPaymentOutputDescriptor::MAX_WITNESS_LENGTH;
363 #[cfg(feature = "grind_signatures")]
364 { witness_weight -= 1; } // Guarantees a low R signature
365 input_value += descriptor.output.value;
367 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
368 if !output_set.insert(*outpoint) { return Err(()); }
370 previous_output: outpoint.into_bitcoin_outpoint(),
371 script_sig: ScriptBuf::new(),
372 sequence: Sequence::ZERO,
373 witness: Witness::new(),
375 witness_weight += 1 + 73 + 34;
376 #[cfg(feature = "grind_signatures")]
377 { witness_weight -= 1; } // Guarantees a low R signature
378 input_value += output.value;
381 if input_value > MAX_VALUE_MSAT / 1000 { return Err(()); }
383 let mut tx = Transaction {
385 lock_time: locktime.unwrap_or(LockTime::ZERO),
389 let expected_max_weight =
390 transaction_utils::maybe_add_change_output(&mut tx, input_value, witness_weight, feerate_sat_per_1000_weight, change_destination_script)?;
392 let psbt_inputs = descriptors.iter().map(|d| d.to_psbt_input()).collect::<Vec<_>>();
393 let psbt = PartiallySignedTransaction {
395 outputs: vec![Default::default(); tx.output.len()],
397 xpub: Default::default(),
399 proprietary: Default::default(),
400 unknown: Default::default(),
402 Ok((psbt, expected_max_weight))
406 /// The parameters required to derive a channel signer via [`SignerProvider`].
407 #[derive(Clone, Debug, PartialEq, Eq)]
408 pub struct ChannelDerivationParameters {
409 /// The value in satoshis of the channel we're attempting to spend the anchor output of.
410 pub value_satoshis: u64,
411 /// The unique identifier to re-derive the signer for the associated channel.
412 pub keys_id: [u8; 32],
413 /// The necessary channel parameters that need to be provided to the re-derived signer through
414 /// [`ChannelSigner::provide_channel_parameters`].
415 pub transaction_parameters: ChannelTransactionParameters,
418 impl_writeable_tlv_based!(ChannelDerivationParameters, {
419 (0, value_satoshis, required),
420 (2, keys_id, required),
421 (4, transaction_parameters, required),
424 /// A descriptor used to sign for a commitment transaction's HTLC output.
425 #[derive(Clone, Debug, PartialEq, Eq)]
426 pub struct HTLCDescriptor {
427 /// The parameters required to derive the signer for the HTLC input.
428 pub channel_derivation_parameters: ChannelDerivationParameters,
429 /// The txid of the commitment transaction in which the HTLC output lives.
430 pub commitment_txid: Txid,
431 /// The number of the commitment transaction in which the HTLC output lives.
432 pub per_commitment_number: u64,
433 /// The key tweak corresponding to the number of the commitment transaction in which the HTLC
434 /// output lives. This tweak is applied to all the basepoints for both parties in the channel to
435 /// arrive at unique keys per commitment.
437 /// See <https://github.com/lightning/bolts/blob/master/03-transactions.md#keys> for more info.
438 pub per_commitment_point: PublicKey,
439 /// The feerate to use on the HTLC claiming transaction. This is always `0` for HTLCs
440 /// originating from a channel supporting anchor outputs, otherwise it is the channel's
441 /// negotiated feerate at the time the commitment transaction was built.
442 pub feerate_per_kw: u32,
443 /// The details of the HTLC as it appears in the commitment transaction.
444 pub htlc: HTLCOutputInCommitment,
445 /// The preimage, if `Some`, to claim the HTLC output with. If `None`, the timeout path must be
447 pub preimage: Option<PaymentPreimage>,
448 /// The counterparty's signature required to spend the HTLC output.
449 pub counterparty_sig: Signature
452 impl_writeable_tlv_based!(HTLCDescriptor, {
453 (0, channel_derivation_parameters, required),
454 (1, feerate_per_kw, (default_value, 0)),
455 (2, commitment_txid, required),
456 (4, per_commitment_number, required),
457 (6, per_commitment_point, required),
459 (10, preimage, option),
460 (12, counterparty_sig, required),
463 impl HTLCDescriptor {
464 /// Returns the outpoint of the HTLC output in the commitment transaction. This is the outpoint
465 /// being spent by the HTLC input in the HTLC transaction.
466 pub fn outpoint(&self) -> bitcoin::OutPoint {
468 txid: self.commitment_txid,
469 vout: self.htlc.transaction_output_index.unwrap(),
473 /// Returns the UTXO to be spent by the HTLC input, which can be obtained via
474 /// [`Self::unsigned_tx_input`].
475 pub fn previous_utxo<C: secp256k1::Signing + secp256k1::Verification>(&self, secp: &Secp256k1<C>) -> TxOut {
477 script_pubkey: self.witness_script(secp).to_v0_p2wsh(),
478 value: self.htlc.amount_msat / 1000,
482 /// Returns the unsigned transaction input spending the HTLC output in the commitment
484 pub fn unsigned_tx_input(&self) -> TxIn {
485 chan_utils::build_htlc_input(
486 &self.commitment_txid, &self.htlc, &self.channel_derivation_parameters.transaction_parameters.channel_type_features
490 /// Returns the delayed output created as a result of spending the HTLC output in the commitment
492 pub fn tx_output<C: secp256k1::Signing + secp256k1::Verification>(&self, secp: &Secp256k1<C>) -> TxOut {
493 let channel_params = self.channel_derivation_parameters.transaction_parameters.as_holder_broadcastable();
494 let broadcaster_keys = channel_params.broadcaster_pubkeys();
495 let counterparty_keys = channel_params.countersignatory_pubkeys();
496 let broadcaster_delayed_key = chan_utils::derive_public_key(
497 secp, &self.per_commitment_point, &broadcaster_keys.delayed_payment_basepoint
499 let counterparty_revocation_key = chan_utils::derive_public_revocation_key(
500 secp, &self.per_commitment_point, &counterparty_keys.revocation_basepoint
502 chan_utils::build_htlc_output(
503 self.feerate_per_kw, channel_params.contest_delay(), &self.htlc,
504 channel_params.channel_type_features(), &broadcaster_delayed_key, &counterparty_revocation_key
508 /// Returns the witness script of the HTLC output in the commitment transaction.
509 pub fn witness_script<C: secp256k1::Signing + secp256k1::Verification>(&self, secp: &Secp256k1<C>) -> ScriptBuf {
510 let channel_params = self.channel_derivation_parameters.transaction_parameters.as_holder_broadcastable();
511 let broadcaster_keys = channel_params.broadcaster_pubkeys();
512 let counterparty_keys = channel_params.countersignatory_pubkeys();
513 let broadcaster_htlc_key = chan_utils::derive_public_key(
514 secp, &self.per_commitment_point, &broadcaster_keys.htlc_basepoint
516 let counterparty_htlc_key = chan_utils::derive_public_key(
517 secp, &self.per_commitment_point, &counterparty_keys.htlc_basepoint
519 let counterparty_revocation_key = chan_utils::derive_public_revocation_key(
520 secp, &self.per_commitment_point, &counterparty_keys.revocation_basepoint
522 chan_utils::get_htlc_redeemscript_with_explicit_keys(
523 &self.htlc, channel_params.channel_type_features(), &broadcaster_htlc_key, &counterparty_htlc_key,
524 &counterparty_revocation_key,
528 /// Returns the fully signed witness required to spend the HTLC output in the commitment
530 pub fn tx_input_witness(&self, signature: &Signature, witness_script: &Script) -> Witness {
531 chan_utils::build_htlc_input_witness(
532 signature, &self.counterparty_sig, &self.preimage, witness_script,
533 &self.channel_derivation_parameters.transaction_parameters.channel_type_features
537 /// Derives the channel signer required to sign the HTLC input.
538 pub fn derive_channel_signer<S: WriteableEcdsaChannelSigner, SP: Deref>(&self, signer_provider: &SP) -> S
540 SP::Target: SignerProvider<Signer = S>
542 let mut signer = signer_provider.derive_channel_signer(
543 self.channel_derivation_parameters.value_satoshis,
544 self.channel_derivation_parameters.keys_id,
546 signer.provide_channel_parameters(&self.channel_derivation_parameters.transaction_parameters);
551 /// A trait to handle Lightning channel key material without concretizing the channel type or
552 /// the signature mechanism.
553 pub trait ChannelSigner {
554 /// Gets the per-commitment point for a specific commitment number
556 /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
557 fn get_per_commitment_point(&self, idx: u64, secp_ctx: &Secp256k1<secp256k1::All>) -> PublicKey;
559 /// Gets the commitment secret for a specific commitment number as part of the revocation process
561 /// An external signer implementation should error here if the commitment was already signed
562 /// and should refuse to sign it in the future.
564 /// May be called more than once for the same index.
566 /// Note that the commitment number starts at `(1 << 48) - 1` and counts backwards.
567 // TODO: return a Result so we can signal a validation error
568 fn release_commitment_secret(&self, idx: u64) -> [u8; 32];
570 /// Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
572 /// This is required in order for the signer to make sure that releasing a commitment
573 /// secret won't leave us without a broadcastable holder transaction.
574 /// Policy checks should be implemented in this function, including checking the amount
575 /// sent to us and checking the HTLCs.
577 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
578 /// A validating signer should ensure that an HTLC output is removed only when the matching
579 /// preimage is provided, or when the value to holder is restored.
581 /// Note that all the relevant preimages will be provided, but there may also be additional
582 /// irrelevant or duplicate preimages.
583 fn validate_holder_commitment(&self, holder_tx: &HolderCommitmentTransaction,
584 preimages: Vec<PaymentPreimage>) -> Result<(), ()>;
586 /// Returns the holder's channel public keys and basepoints.
587 fn pubkeys(&self) -> &ChannelPublicKeys;
589 /// Returns an arbitrary identifier describing the set of keys which are provided back to you in
590 /// some [`SpendableOutputDescriptor`] types. This should be sufficient to identify this
591 /// [`EcdsaChannelSigner`] object uniquely and lookup or re-derive its keys.
592 fn channel_keys_id(&self) -> [u8; 32];
594 /// Set the counterparty static channel data, including basepoints,
595 /// `counterparty_selected`/`holder_selected_contest_delay` and funding outpoint.
597 /// This data is static, and will never change for a channel once set. For a given [`ChannelSigner`]
598 /// instance, LDK will call this method exactly once - either immediately after construction
599 /// (not including if done via [`SignerProvider::read_chan_signer`]) or when the funding
600 /// information has been generated.
602 /// channel_parameters.is_populated() MUST be true.
603 fn provide_channel_parameters(&mut self, channel_parameters: &ChannelTransactionParameters);
606 /// A trait to sign Lightning channel transactions as described in
607 /// [BOLT 3](https://github.com/lightning/bolts/blob/master/03-transactions.md).
609 /// Signing services could be implemented on a hardware wallet and should implement signing
610 /// policies in order to be secure. Please refer to the [VLS Policy
611 /// Controls](https://gitlab.com/lightning-signer/validating-lightning-signer/-/blob/main/docs/policy-controls.md)
612 /// for an example of such policies.
613 pub trait EcdsaChannelSigner: ChannelSigner {
614 /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
616 /// Note that if signing fails or is rejected, the channel will be force-closed.
618 /// Policy checks should be implemented in this function, including checking the amount
619 /// sent to us and checking the HTLCs.
621 /// The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
622 /// A validating signer should ensure that an HTLC output is removed only when the matching
623 /// preimage is provided, or when the value to holder is restored.
625 /// Note that all the relevant preimages will be provided, but there may also be additional
626 /// irrelevant or duplicate preimages.
628 // TODO: Document the things someone using this interface should enforce before signing.
629 fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction,
630 preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<secp256k1::All>
631 ) -> Result<(Signature, Vec<Signature>), ()>;
632 /// Validate the counterparty's revocation.
634 /// This is required in order for the signer to make sure that the state has moved
635 /// forward and it is safe to sign the next counterparty commitment.
636 fn validate_counterparty_revocation(&self, idx: u64, secret: &SecretKey) -> Result<(), ()>;
637 /// Creates a signature for a holder's commitment transaction.
639 /// This will be called
640 /// - with a non-revoked `commitment_tx`.
641 /// - with the latest `commitment_tx` when we initiate a force-close.
643 /// This may be called multiple times for the same transaction.
645 /// An external signer implementation should check that the commitment has not been revoked.
647 // TODO: Document the things someone using this interface should enforce before signing.
648 fn sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction,
649 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
650 /// Same as [`sign_holder_commitment`], but exists only for tests to get access to holder
651 /// commitment transactions which will be broadcasted later, after the channel has moved on to a
652 /// newer state. Thus, needs its own method as [`sign_holder_commitment`] may enforce that we
653 /// only ever get called once.
654 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
655 fn unsafe_sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction,
656 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
657 /// Create a signature for the given input in a transaction spending an HTLC transaction output
658 /// or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
660 /// A justice transaction may claim multiple outputs at the same time if timelocks are
661 /// similar, but only a signature for the input at index `input` should be signed for here.
662 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
663 /// to an upcoming timelock expiration.
665 /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
667 /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
668 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
669 /// not allow the spending of any funds by itself (you need our holder `revocation_secret` to do
671 fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64,
672 per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>
673 ) -> Result<Signature, ()>;
674 /// Create a signature for the given input in a transaction spending a commitment transaction
675 /// HTLC output when our counterparty broadcasts an old state.
677 /// A justice transaction may claim multiple outputs at the same time if timelocks are
678 /// similar, but only a signature for the input at index `input` should be signed for here.
679 /// It may be called multiple times for same output(s) if a fee-bump is needed with regards
680 /// to an upcoming timelock expiration.
682 /// `amount` is the value of the output spent by this input, committed to in the BIP 143
685 /// `per_commitment_key` is revocation secret which was provided by our counterparty when they
686 /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
687 /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
690 /// `htlc` holds HTLC elements (hash, timelock), thus changing the format of the witness script
691 /// (which is committed to in the BIP 143 signatures).
692 fn sign_justice_revoked_htlc(&self, justice_tx: &Transaction, input: usize, amount: u64,
693 per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment,
694 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
695 /// Computes the signature for a commitment transaction's HTLC output used as an input within
696 /// `htlc_tx`, which spends the commitment transaction at index `input`. The signature returned
697 /// must be be computed using [`EcdsaSighashType::All`].
699 /// Note that this may be called for HTLCs in the penultimate commitment transaction if a
700 /// [`ChannelMonitor`] [replica](https://github.com/lightningdevkit/rust-lightning/blob/main/GLOSSARY.md#monitor-replicas)
701 /// broadcasts it before receiving the update for the latest commitment transaction.
703 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
704 fn sign_holder_htlc_transaction(&self, htlc_tx: &Transaction, input: usize,
705 htlc_descriptor: &HTLCDescriptor, secp_ctx: &Secp256k1<secp256k1::All>
706 ) -> Result<Signature, ()>;
707 /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
708 /// transaction, either offered or received.
710 /// Such a transaction may claim multiples offered outputs at same time if we know the
711 /// preimage for each when we create it, but only the input at index `input` should be
712 /// signed for here. It may be called multiple times for same output(s) if a fee-bump is
713 /// needed with regards to an upcoming timelock expiration.
715 /// `witness_script` is either an offered or received script as defined in BOLT3 for HTLC
718 /// `amount` is value of the output spent by this input, committed to in the BIP 143 signature.
720 /// `per_commitment_point` is the dynamic point corresponding to the channel state
721 /// detected onchain. It has been generated by our counterparty and is used to derive
722 /// channel state keys, which are then included in the witness script and committed to in the
723 /// BIP 143 signature.
724 fn sign_counterparty_htlc_transaction(&self, htlc_tx: &Transaction, input: usize, amount: u64,
725 per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment,
726 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
727 /// Create a signature for a (proposed) closing transaction.
729 /// Note that, due to rounding, there may be one "missing" satoshi, and either party may have
730 /// chosen to forgo their output as dust.
731 fn sign_closing_transaction(&self, closing_tx: &ClosingTransaction,
732 secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()>;
733 /// Computes the signature for a commitment transaction's anchor output used as an
734 /// input within `anchor_tx`, which spends the commitment transaction, at index `input`.
735 fn sign_holder_anchor_input(
736 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
737 ) -> Result<Signature, ()>;
738 /// Signs a channel announcement message with our funding key proving it comes from one of the
739 /// channel participants.
741 /// Channel announcements also require a signature from each node's network key. Our node
742 /// signature is computed through [`NodeSigner::sign_gossip_message`].
744 /// Note that if this fails or is rejected, the channel will not be publicly announced and
745 /// our counterparty may (though likely will not) close the channel on us for violating the
747 fn sign_channel_announcement_with_funding_key(
748 &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<secp256k1::All>
749 ) -> Result<Signature, ()>;
752 /// A writeable signer.
754 /// There will always be two instances of a signer per channel, one occupied by the
755 /// [`ChannelManager`] and another by the channel's [`ChannelMonitor`].
757 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
758 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
759 pub trait WriteableEcdsaChannelSigner: EcdsaChannelSigner + Writeable {}
761 /// Specifies the recipient of an invoice.
763 /// This indicates to [`NodeSigner::sign_invoice`] what node secret key should be used to sign
766 /// The invoice should be signed with the local node secret key.
768 /// The invoice should be signed with the phantom node secret key. This secret key must be the
769 /// same for all nodes participating in the [phantom node payment].
771 /// [phantom node payment]: PhantomKeysManager
775 /// A trait that describes a source of entropy.
776 pub trait EntropySource {
777 /// Gets a unique, cryptographically-secure, random 32-byte value. This method must return a
778 /// different value each time it is called.
779 fn get_secure_random_bytes(&self) -> [u8; 32];
782 /// A trait that can handle cryptographic operations at the scope level of a node.
783 pub trait NodeSigner {
784 /// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
786 /// If the implementor of this trait supports [phantom node payments], then every node that is
787 /// intended to be included in the phantom invoice route hints must return the same value from
789 // This is because LDK avoids storing inbound payment data by encrypting payment data in the
790 // payment hash and/or payment secret, therefore for a payment to be receivable by multiple
791 // nodes, they must share the key that encrypts this payment data.
793 /// This method must return the same value each time it is called.
795 /// [phantom node payments]: PhantomKeysManager
796 fn get_inbound_payment_key_material(&self) -> KeyMaterial;
798 /// Get node id based on the provided [`Recipient`].
800 /// This method must return the same value each time it is called with a given [`Recipient`]
803 /// Errors if the [`Recipient`] variant is not supported by the implementation.
804 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()>;
806 /// Gets the ECDH shared secret of our node secret and `other_key`, multiplying by `tweak` if
807 /// one is provided. Note that this tweak can be applied to `other_key` instead of our node
808 /// secret, though this is less efficient.
810 /// Note that if this fails while attempting to forward an HTLC, LDK will panic. The error
811 /// should be resolved to allow LDK to resume forwarding HTLCs.
813 /// Errors if the [`Recipient`] variant is not supported by the implementation.
814 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()>;
818 /// By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
819 /// this trait to parse the invoice and make sure they're signing what they expect, rather than
820 /// blindly signing the hash.
822 /// The `hrp_bytes` are ASCII bytes, while the `invoice_data` is base32.
824 /// The secret key used to sign the invoice is dependent on the [`Recipient`].
826 /// Errors if the [`Recipient`] variant is not supported by the implementation.
827 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()>;
829 /// Signs the [`TaggedHash`] of a BOLT 12 invoice request.
831 /// May be called by a function passed to [`UnsignedInvoiceRequest::sign`] where
832 /// `invoice_request` is the callee.
834 /// Implementors may check that the `invoice_request` is expected rather than blindly signing
835 /// the tagged hash. An `Ok` result should sign `invoice_request.tagged_hash().as_digest()` with
836 /// the node's signing key or an ephemeral key to preserve privacy, whichever is associated with
837 /// [`UnsignedInvoiceRequest::payer_id`].
839 /// [`TaggedHash`]: crate::offers::merkle::TaggedHash
840 fn sign_bolt12_invoice_request(
841 &self, invoice_request: &UnsignedInvoiceRequest
842 ) -> Result<schnorr::Signature, ()>;
844 /// Signs the [`TaggedHash`] of a BOLT 12 invoice.
846 /// May be called by a function passed to [`UnsignedBolt12Invoice::sign`] where `invoice` is the
849 /// Implementors may check that the `invoice` is expected rather than blindly signing the tagged
850 /// hash. An `Ok` result should sign `invoice.tagged_hash().as_digest()` with the node's signing
851 /// key or an ephemeral key to preserve privacy, whichever is associated with
852 /// [`UnsignedBolt12Invoice::signing_pubkey`].
854 /// [`TaggedHash`]: crate::offers::merkle::TaggedHash
855 fn sign_bolt12_invoice(
856 &self, invoice: &UnsignedBolt12Invoice
857 ) -> Result<schnorr::Signature, ()>;
859 /// Sign a gossip message.
861 /// Note that if this fails, LDK may panic and the message will not be broadcast to the network
862 /// or a possible channel counterparty. If LDK panics, the error should be resolved to allow the
863 /// message to be broadcast, as otherwise it may prevent one from receiving funds over the
864 /// corresponding channel.
865 fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()>;
868 /// A trait that can return signer instances for individual channels.
869 pub trait SignerProvider {
870 /// A type which implements [`WriteableEcdsaChannelSigner`] which will be returned by [`Self::derive_channel_signer`].
871 type Signer : WriteableEcdsaChannelSigner;
873 /// Generates a unique `channel_keys_id` that can be used to obtain a [`Self::Signer`] through
874 /// [`SignerProvider::derive_channel_signer`]. The `user_channel_id` is provided to allow
875 /// implementations of [`SignerProvider`] to maintain a mapping between itself and the generated
876 /// `channel_keys_id`.
878 /// This method must return a different value each time it is called.
879 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32];
881 /// Derives the private key material backing a `Signer`.
883 /// To derive a new `Signer`, a fresh `channel_keys_id` should be obtained through
884 /// [`SignerProvider::generate_channel_keys_id`]. Otherwise, an existing `Signer` can be
885 /// re-derived from its `channel_keys_id`, which can be obtained through its trait method
886 /// [`ChannelSigner::channel_keys_id`].
887 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer;
889 /// Reads a [`Signer`] for this [`SignerProvider`] from the given input stream.
890 /// This is only called during deserialization of other objects which contain
891 /// [`WriteableEcdsaChannelSigner`]-implementing objects (i.e., [`ChannelMonitor`]s and [`ChannelManager`]s).
892 /// The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
893 /// contain no versioning scheme. You may wish to include your own version prefix and ensure
894 /// you've read all of the provided bytes to ensure no corruption occurred.
896 /// This method is slowly being phased out -- it will only be called when reading objects
897 /// written by LDK versions prior to 0.0.113.
899 /// [`Signer`]: Self::Signer
900 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
901 /// [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
902 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError>;
904 /// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
906 /// If this function returns an error, this will result in a channel failing to open.
908 /// This method should return a different value each time it is called, to avoid linking
909 /// on-chain funds across channels as controlled to the same user.
910 fn get_destination_script(&self) -> Result<ScriptBuf, ()>;
912 /// Get a script pubkey which we will send funds to when closing a channel.
914 /// If this function returns an error, this will result in a channel failing to open or close.
915 /// In the event of a failure when the counterparty is initiating a close, this can result in a
916 /// channel force close.
918 /// This method should return a different value each time it is called, to avoid linking
919 /// on-chain funds across channels as controlled to the same user.
920 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()>;
923 /// A simple implementation of [`WriteableEcdsaChannelSigner`] that just keeps the private keys in memory.
925 /// This implementation performs no policy checks and is insufficient by itself as
926 /// a secure external signer.
928 pub struct InMemorySigner {
929 /// Holder secret key in the 2-of-2 multisig script of a channel. This key also backs the
930 /// holder's anchor output in a commitment transaction, if one is present.
931 pub funding_key: SecretKey,
932 /// Holder secret key for blinded revocation pubkey.
933 pub revocation_base_key: SecretKey,
934 /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions.
935 pub payment_key: SecretKey,
936 /// Holder secret key used in an HTLC transaction.
937 pub delayed_payment_base_key: SecretKey,
938 /// Holder HTLC secret key used in commitment transaction HTLC outputs.
939 pub htlc_base_key: SecretKey,
941 pub commitment_seed: [u8; 32],
942 /// Holder public keys and basepoints.
943 pub(crate) holder_channel_pubkeys: ChannelPublicKeys,
944 /// Counterparty public keys and counterparty/holder `selected_contest_delay`, populated on channel acceptance.
945 channel_parameters: Option<ChannelTransactionParameters>,
946 /// The total value of this channel.
947 channel_value_satoshis: u64,
948 /// Key derivation parameters.
949 channel_keys_id: [u8; 32],
950 /// Seed from which all randomness produced is derived from.
951 rand_bytes_unique_start: [u8; 32],
952 /// Tracks the number of times we've produced randomness to ensure we don't return the same
954 rand_bytes_index: AtomicCounter,
957 impl PartialEq for InMemorySigner {
958 fn eq(&self, other: &Self) -> bool {
959 self.funding_key == other.funding_key &&
960 self.revocation_base_key == other.revocation_base_key &&
961 self.payment_key == other.payment_key &&
962 self.delayed_payment_base_key == other.delayed_payment_base_key &&
963 self.htlc_base_key == other.htlc_base_key &&
964 self.commitment_seed == other.commitment_seed &&
965 self.holder_channel_pubkeys == other.holder_channel_pubkeys &&
966 self.channel_parameters == other.channel_parameters &&
967 self.channel_value_satoshis == other.channel_value_satoshis &&
968 self.channel_keys_id == other.channel_keys_id
972 impl Clone for InMemorySigner {
973 fn clone(&self) -> Self {
975 funding_key: self.funding_key.clone(),
976 revocation_base_key: self.revocation_base_key.clone(),
977 payment_key: self.payment_key.clone(),
978 delayed_payment_base_key: self.delayed_payment_base_key.clone(),
979 htlc_base_key: self.htlc_base_key.clone(),
980 commitment_seed: self.commitment_seed.clone(),
981 holder_channel_pubkeys: self.holder_channel_pubkeys.clone(),
982 channel_parameters: self.channel_parameters.clone(),
983 channel_value_satoshis: self.channel_value_satoshis,
984 channel_keys_id: self.channel_keys_id,
985 rand_bytes_unique_start: self.get_secure_random_bytes(),
986 rand_bytes_index: AtomicCounter::new(),
991 impl InMemorySigner {
992 /// Creates a new [`InMemorySigner`].
993 pub fn new<C: Signing>(
994 secp_ctx: &Secp256k1<C>,
995 funding_key: SecretKey,
996 revocation_base_key: SecretKey,
997 payment_key: SecretKey,
998 delayed_payment_base_key: SecretKey,
999 htlc_base_key: SecretKey,
1000 commitment_seed: [u8; 32],
1001 channel_value_satoshis: u64,
1002 channel_keys_id: [u8; 32],
1003 rand_bytes_unique_start: [u8; 32],
1004 ) -> InMemorySigner {
1005 let holder_channel_pubkeys =
1006 InMemorySigner::make_holder_keys(secp_ctx, &funding_key, &revocation_base_key,
1007 &payment_key, &delayed_payment_base_key,
1011 revocation_base_key,
1013 delayed_payment_base_key,
1016 channel_value_satoshis,
1017 holder_channel_pubkeys,
1018 channel_parameters: None,
1020 rand_bytes_unique_start,
1021 rand_bytes_index: AtomicCounter::new(),
1025 fn make_holder_keys<C: Signing>(secp_ctx: &Secp256k1<C>,
1026 funding_key: &SecretKey,
1027 revocation_base_key: &SecretKey,
1028 payment_key: &SecretKey,
1029 delayed_payment_base_key: &SecretKey,
1030 htlc_base_key: &SecretKey) -> ChannelPublicKeys {
1031 let from_secret = |s: &SecretKey| PublicKey::from_secret_key(secp_ctx, s);
1033 funding_pubkey: from_secret(&funding_key),
1034 revocation_basepoint: from_secret(&revocation_base_key),
1035 payment_point: from_secret(&payment_key),
1036 delayed_payment_basepoint: from_secret(&delayed_payment_base_key),
1037 htlc_basepoint: from_secret(&htlc_base_key),
1041 /// Returns the counterparty's pubkeys.
1043 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1044 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1045 pub fn counterparty_pubkeys(&self) -> Option<&ChannelPublicKeys> {
1046 self.get_channel_parameters()
1047 .and_then(|params| params.counterparty_parameters.as_ref().map(|params| ¶ms.pubkeys))
1050 /// Returns the `contest_delay` value specified by our counterparty and applied on holder-broadcastable
1051 /// transactions, i.e., the amount of time that we have to wait to recover our funds if we
1052 /// broadcast a transaction.
1054 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1055 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1056 pub fn counterparty_selected_contest_delay(&self) -> Option<u16> {
1057 self.get_channel_parameters()
1058 .and_then(|params| params.counterparty_parameters.as_ref().map(|params| params.selected_contest_delay))
1061 /// Returns the `contest_delay` value specified by us and applied on transactions broadcastable
1062 /// by our counterparty, i.e., the amount of time that they have to wait to recover their funds
1063 /// if they broadcast a transaction.
1065 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1066 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1067 pub fn holder_selected_contest_delay(&self) -> Option<u16> {
1068 self.get_channel_parameters().map(|params| params.holder_selected_contest_delay)
1071 /// Returns whether the holder is the initiator.
1073 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1074 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1075 pub fn is_outbound(&self) -> Option<bool> {
1076 self.get_channel_parameters().map(|params| params.is_outbound_from_holder)
1079 /// Funding outpoint
1081 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1082 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1083 pub fn funding_outpoint(&self) -> Option<&OutPoint> {
1084 self.get_channel_parameters().map(|params| params.funding_outpoint.as_ref()).flatten()
1087 /// Returns a [`ChannelTransactionParameters`] for this channel, to be used when verifying or
1088 /// building transactions.
1090 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1091 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1092 pub fn get_channel_parameters(&self) -> Option<&ChannelTransactionParameters> {
1093 self.channel_parameters.as_ref()
1096 /// Returns the channel type features of the channel parameters. Should be helpful for
1097 /// determining a channel's category, i. e. legacy/anchors/taproot/etc.
1099 /// Will return `None` if [`ChannelSigner::provide_channel_parameters`] has not been called.
1100 /// In general, this is safe to `unwrap` only in [`ChannelSigner`] implementation.
1101 pub fn channel_type_features(&self) -> Option<&ChannelTypeFeatures> {
1102 self.get_channel_parameters().map(|params| ¶ms.channel_type_features)
1105 /// Sign the single input of `spend_tx` at index `input_idx`, which spends the output described
1106 /// by `descriptor`, returning the witness stack for the input.
1108 /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
1109 /// is not spending the outpoint described by [`descriptor.outpoint`],
1110 /// or if an output descriptor `script_pubkey` does not match the one we can spend.
1112 /// [`descriptor.outpoint`]: StaticPaymentOutputDescriptor::outpoint
1113 pub fn sign_counterparty_payment_input<C: Signing>(&self, spend_tx: &Transaction, input_idx: usize, descriptor: &StaticPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>) -> Result<Witness, ()> {
1114 // TODO: We really should be taking the SigHashCache as a parameter here instead of
1115 // spend_tx, but ideally the SigHashCache would expose the transaction's inputs read-only
1116 // so that we can check them. This requires upstream rust-bitcoin changes (as well as
1117 // bindings updates to support SigHashCache objects).
1118 if spend_tx.input.len() <= input_idx { return Err(()); }
1119 if !spend_tx.input[input_idx].script_sig.is_empty() { return Err(()); }
1120 if spend_tx.input[input_idx].previous_output != descriptor.outpoint.into_bitcoin_outpoint() { return Err(()); }
1122 let remotepubkey = bitcoin::PublicKey::new(self.pubkeys().payment_point);
1123 // We cannot always assume that `channel_parameters` is set, so can't just call
1124 // `self.channel_parameters()` or anything that relies on it
1125 let supports_anchors_zero_fee_htlc_tx = self.channel_type_features()
1126 .map(|features| features.supports_anchors_zero_fee_htlc_tx())
1129 let witness_script = if supports_anchors_zero_fee_htlc_tx {
1130 chan_utils::get_to_countersignatory_with_anchors_redeemscript(&remotepubkey.inner)
1132 ScriptBuf::new_p2pkh(&remotepubkey.pubkey_hash())
1134 let sighash = hash_to_message!(&sighash::SighashCache::new(spend_tx).segwit_signature_hash(input_idx, &witness_script, descriptor.output.value, EcdsaSighashType::All).unwrap()[..]);
1135 let remotesig = sign_with_aux_rand(secp_ctx, &sighash, &self.payment_key, &self);
1136 let payment_script = if supports_anchors_zero_fee_htlc_tx {
1137 witness_script.to_v0_p2wsh()
1139 ScriptBuf::new_v0_p2wpkh(&remotepubkey.wpubkey_hash().unwrap())
1142 if payment_script != descriptor.output.script_pubkey { return Err(()); }
1144 let mut witness = Vec::with_capacity(2);
1145 witness.push(remotesig.serialize_der().to_vec());
1146 witness[0].push(EcdsaSighashType::All as u8);
1147 if supports_anchors_zero_fee_htlc_tx {
1148 witness.push(witness_script.to_bytes());
1150 witness.push(remotepubkey.to_bytes());
1155 /// Sign the single input of `spend_tx` at index `input_idx` which spends the output
1156 /// described by `descriptor`, returning the witness stack for the input.
1158 /// Returns an error if the input at `input_idx` does not exist, has a non-empty `script_sig`,
1159 /// is not spending the outpoint described by [`descriptor.outpoint`], does not have a
1160 /// sequence set to [`descriptor.to_self_delay`], or if an output descriptor
1161 /// `script_pubkey` does not match the one we can spend.
1163 /// [`descriptor.outpoint`]: DelayedPaymentOutputDescriptor::outpoint
1164 /// [`descriptor.to_self_delay`]: DelayedPaymentOutputDescriptor::to_self_delay
1165 pub fn sign_dynamic_p2wsh_input<C: Signing>(&self, spend_tx: &Transaction, input_idx: usize, descriptor: &DelayedPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>) -> Result<Witness, ()> {
1166 // TODO: We really should be taking the SigHashCache as a parameter here instead of
1167 // spend_tx, but ideally the SigHashCache would expose the transaction's inputs read-only
1168 // so that we can check them. This requires upstream rust-bitcoin changes (as well as
1169 // bindings updates to support SigHashCache objects).
1170 if spend_tx.input.len() <= input_idx { return Err(()); }
1171 if !spend_tx.input[input_idx].script_sig.is_empty() { return Err(()); }
1172 if spend_tx.input[input_idx].previous_output != descriptor.outpoint.into_bitcoin_outpoint() { return Err(()); }
1173 if spend_tx.input[input_idx].sequence.0 != descriptor.to_self_delay as u32 { return Err(()); }
1175 let delayed_payment_key = chan_utils::derive_private_key(&secp_ctx, &descriptor.per_commitment_point, &self.delayed_payment_base_key);
1176 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
1177 let witness_script = chan_utils::get_revokeable_redeemscript(&descriptor.revocation_pubkey, descriptor.to_self_delay, &delayed_payment_pubkey);
1178 let sighash = hash_to_message!(&sighash::SighashCache::new(spend_tx).segwit_signature_hash(input_idx, &witness_script, descriptor.output.value, EcdsaSighashType::All).unwrap()[..]);
1179 let local_delayedsig = EcdsaSignature {
1180 sig: sign_with_aux_rand(secp_ctx, &sighash, &delayed_payment_key, &self),
1181 hash_ty: EcdsaSighashType::All,
1183 let payment_script = bitcoin::Address::p2wsh(&witness_script, Network::Bitcoin).script_pubkey();
1185 if descriptor.output.script_pubkey != payment_script { return Err(()); }
1187 Ok(Witness::from_slice(&[
1188 &local_delayedsig.serialize()[..],
1190 witness_script.as_bytes(),
1195 impl EntropySource for InMemorySigner {
1196 fn get_secure_random_bytes(&self) -> [u8; 32] {
1197 let index = self.rand_bytes_index.get_increment();
1198 let mut nonce = [0u8; 16];
1199 nonce[..8].copy_from_slice(&index.to_be_bytes());
1200 ChaCha20::get_single_block(&self.rand_bytes_unique_start, &nonce)
1204 impl ChannelSigner for InMemorySigner {
1205 fn get_per_commitment_point(&self, idx: u64, secp_ctx: &Secp256k1<secp256k1::All>) -> PublicKey {
1206 let commitment_secret = SecretKey::from_slice(&chan_utils::build_commitment_secret(&self.commitment_seed, idx)).unwrap();
1207 PublicKey::from_secret_key(secp_ctx, &commitment_secret)
1210 fn release_commitment_secret(&self, idx: u64) -> [u8; 32] {
1211 chan_utils::build_commitment_secret(&self.commitment_seed, idx)
1214 fn validate_holder_commitment(&self, _holder_tx: &HolderCommitmentTransaction, _preimages: Vec<PaymentPreimage>) -> Result<(), ()> {
1218 fn pubkeys(&self) -> &ChannelPublicKeys { &self.holder_channel_pubkeys }
1220 fn channel_keys_id(&self) -> [u8; 32] { self.channel_keys_id }
1222 fn provide_channel_parameters(&mut self, channel_parameters: &ChannelTransactionParameters) {
1223 assert!(self.channel_parameters.is_none() || self.channel_parameters.as_ref().unwrap() == channel_parameters);
1224 if self.channel_parameters.is_some() {
1225 // The channel parameters were already set and they match, return early.
1228 assert!(channel_parameters.is_populated(), "Channel parameters must be fully populated");
1229 self.channel_parameters = Some(channel_parameters.clone());
1233 const MISSING_PARAMS_ERR: &'static str = "ChannelSigner::provide_channel_parameters must be called before signing operations";
1235 impl EcdsaChannelSigner for InMemorySigner {
1236 fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction, _preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()> {
1237 let trusted_tx = commitment_tx.trust();
1238 let keys = trusted_tx.keys();
1240 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
1241 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1242 let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &counterparty_keys.funding_pubkey);
1244 let built_tx = trusted_tx.built_transaction();
1245 let commitment_sig = built_tx.sign_counterparty_commitment(&self.funding_key, &channel_funding_redeemscript, self.channel_value_satoshis, secp_ctx);
1246 let commitment_txid = built_tx.txid;
1248 let mut htlc_sigs = Vec::with_capacity(commitment_tx.htlcs().len());
1249 for htlc in commitment_tx.htlcs() {
1250 let channel_parameters = self.get_channel_parameters().expect(MISSING_PARAMS_ERR);
1251 let holder_selected_contest_delay =
1252 self.holder_selected_contest_delay().expect(MISSING_PARAMS_ERR);
1253 let chan_type = &channel_parameters.channel_type_features;
1254 let htlc_tx = chan_utils::build_htlc_transaction(&commitment_txid, commitment_tx.feerate_per_kw(), holder_selected_contest_delay, htlc, chan_type, &keys.broadcaster_delayed_payment_key, &keys.revocation_key);
1255 let htlc_redeemscript = chan_utils::get_htlc_redeemscript(&htlc, chan_type, &keys);
1256 let htlc_sighashtype = if chan_type.supports_anchors_zero_fee_htlc_tx() { EcdsaSighashType::SinglePlusAnyoneCanPay } else { EcdsaSighashType::All };
1257 let htlc_sighash = hash_to_message!(&sighash::SighashCache::new(&htlc_tx).segwit_signature_hash(0, &htlc_redeemscript, htlc.amount_msat / 1000, htlc_sighashtype).unwrap()[..]);
1258 let holder_htlc_key = chan_utils::derive_private_key(&secp_ctx, &keys.per_commitment_point, &self.htlc_base_key);
1259 htlc_sigs.push(sign(secp_ctx, &htlc_sighash, &holder_htlc_key));
1262 Ok((commitment_sig, htlc_sigs))
1265 fn validate_counterparty_revocation(&self, _idx: u64, _secret: &SecretKey) -> Result<(), ()> {
1269 fn sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1270 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
1271 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1272 let funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &counterparty_keys.funding_pubkey);
1273 let trusted_tx = commitment_tx.trust();
1274 Ok(trusted_tx.built_transaction().sign_holder_commitment(&self.funding_key, &funding_redeemscript, self.channel_value_satoshis, &self, secp_ctx))
1277 #[cfg(any(test,feature = "unsafe_revoked_tx_signing"))]
1278 fn unsafe_sign_holder_commitment(&self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1279 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
1280 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1281 let funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &counterparty_keys.funding_pubkey);
1282 let trusted_tx = commitment_tx.trust();
1283 Ok(trusted_tx.built_transaction().sign_holder_commitment(&self.funding_key, &funding_redeemscript, self.channel_value_satoshis, &self, secp_ctx))
1286 fn sign_justice_revoked_output(&self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1287 let revocation_key = chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_key, &self.revocation_base_key);
1288 let per_commitment_point = PublicKey::from_secret_key(secp_ctx, &per_commitment_key);
1289 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
1290 let witness_script = {
1291 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1292 let holder_selected_contest_delay =
1293 self.holder_selected_contest_delay().expect(MISSING_PARAMS_ERR);
1294 let counterparty_delayedpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &counterparty_keys.delayed_payment_basepoint);
1295 chan_utils::get_revokeable_redeemscript(&revocation_pubkey, holder_selected_contest_delay, &counterparty_delayedpubkey)
1297 let mut sighash_parts = sighash::SighashCache::new(justice_tx);
1298 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
1299 return Ok(sign_with_aux_rand(secp_ctx, &sighash, &revocation_key, &self))
1302 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, ()> {
1303 let revocation_key = chan_utils::derive_private_revocation_key(&secp_ctx, &per_commitment_key, &self.revocation_base_key);
1304 let per_commitment_point = PublicKey::from_secret_key(secp_ctx, &per_commitment_key);
1305 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
1306 let witness_script = {
1307 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1308 let counterparty_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &counterparty_keys.htlc_basepoint);
1309 let holder_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.pubkeys().htlc_basepoint);
1310 let chan_type = self.channel_type_features().expect(MISSING_PARAMS_ERR);
1311 chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, chan_type, &counterparty_htlcpubkey, &holder_htlcpubkey, &revocation_pubkey)
1313 let mut sighash_parts = sighash::SighashCache::new(justice_tx);
1314 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
1315 return Ok(sign_with_aux_rand(secp_ctx, &sighash, &revocation_key, &self))
1318 fn sign_holder_htlc_transaction(
1319 &self, htlc_tx: &Transaction, input: usize, htlc_descriptor: &HTLCDescriptor,
1320 secp_ctx: &Secp256k1<secp256k1::All>
1321 ) -> Result<Signature, ()> {
1322 let witness_script = htlc_descriptor.witness_script(secp_ctx);
1323 let sighash = &sighash::SighashCache::new(&*htlc_tx).segwit_signature_hash(
1324 input, &witness_script, htlc_descriptor.htlc.amount_msat / 1000, EcdsaSighashType::All
1326 let our_htlc_private_key = chan_utils::derive_private_key(
1327 &secp_ctx, &htlc_descriptor.per_commitment_point, &self.htlc_base_key
1329 Ok(sign_with_aux_rand(&secp_ctx, &hash_to_message!(sighash.as_byte_array()), &our_htlc_private_key, &self))
1332 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, ()> {
1333 let htlc_key = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &self.htlc_base_key);
1334 let revocation_pubkey = chan_utils::derive_public_revocation_key(&secp_ctx, &per_commitment_point, &self.pubkeys().revocation_basepoint);
1335 let counterparty_keys = self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR);
1336 let counterparty_htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &counterparty_keys.htlc_basepoint);
1337 let htlcpubkey = chan_utils::derive_public_key(&secp_ctx, &per_commitment_point, &self.pubkeys().htlc_basepoint);
1338 let chan_type = self.channel_type_features().expect(MISSING_PARAMS_ERR);
1339 let witness_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, chan_type, &counterparty_htlcpubkey, &htlcpubkey, &revocation_pubkey);
1340 let mut sighash_parts = sighash::SighashCache::new(htlc_tx);
1341 let sighash = hash_to_message!(&sighash_parts.segwit_signature_hash(input, &witness_script, amount, EcdsaSighashType::All).unwrap()[..]);
1342 Ok(sign_with_aux_rand(secp_ctx, &sighash, &htlc_key, &self))
1345 fn sign_closing_transaction(&self, closing_tx: &ClosingTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<Signature, ()> {
1346 let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key);
1347 let counterparty_funding_key = &self.counterparty_pubkeys().expect(MISSING_PARAMS_ERR).funding_pubkey;
1348 let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, counterparty_funding_key);
1349 Ok(closing_tx.trust().sign(&self.funding_key, &channel_funding_redeemscript, self.channel_value_satoshis, secp_ctx))
1352 fn sign_holder_anchor_input(
1353 &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<secp256k1::All>,
1354 ) -> Result<Signature, ()> {
1355 let witness_script = chan_utils::get_anchor_redeemscript(&self.holder_channel_pubkeys.funding_pubkey);
1356 let sighash = sighash::SighashCache::new(&*anchor_tx).segwit_signature_hash(
1357 input, &witness_script, ANCHOR_OUTPUT_VALUE_SATOSHI, EcdsaSighashType::All,
1359 Ok(sign_with_aux_rand(secp_ctx, &hash_to_message!(&sighash[..]), &self.funding_key, &self))
1362 fn sign_channel_announcement_with_funding_key(
1363 &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<secp256k1::All>
1364 ) -> Result<Signature, ()> {
1365 let msghash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1366 Ok(secp_ctx.sign_ecdsa(&msghash, &self.funding_key))
1370 const SERIALIZATION_VERSION: u8 = 1;
1372 const MIN_SERIALIZATION_VERSION: u8 = 1;
1374 impl WriteableEcdsaChannelSigner for InMemorySigner {}
1376 impl Writeable for InMemorySigner {
1377 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error> {
1378 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
1380 self.funding_key.write(writer)?;
1381 self.revocation_base_key.write(writer)?;
1382 self.payment_key.write(writer)?;
1383 self.delayed_payment_base_key.write(writer)?;
1384 self.htlc_base_key.write(writer)?;
1385 self.commitment_seed.write(writer)?;
1386 self.channel_parameters.write(writer)?;
1387 self.channel_value_satoshis.write(writer)?;
1388 self.channel_keys_id.write(writer)?;
1390 write_tlv_fields!(writer, {});
1396 impl<ES: Deref> ReadableArgs<ES> for InMemorySigner where ES::Target: EntropySource {
1397 fn read<R: io::Read>(reader: &mut R, entropy_source: ES) -> Result<Self, DecodeError> {
1398 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
1400 let funding_key = Readable::read(reader)?;
1401 let revocation_base_key = Readable::read(reader)?;
1402 let payment_key = Readable::read(reader)?;
1403 let delayed_payment_base_key = Readable::read(reader)?;
1404 let htlc_base_key = Readable::read(reader)?;
1405 let commitment_seed = Readable::read(reader)?;
1406 let counterparty_channel_data = Readable::read(reader)?;
1407 let channel_value_satoshis = Readable::read(reader)?;
1408 let secp_ctx = Secp256k1::signing_only();
1409 let holder_channel_pubkeys =
1410 InMemorySigner::make_holder_keys(&secp_ctx, &funding_key, &revocation_base_key,
1411 &payment_key, &delayed_payment_base_key, &htlc_base_key);
1412 let keys_id = Readable::read(reader)?;
1414 read_tlv_fields!(reader, {});
1418 revocation_base_key,
1420 delayed_payment_base_key,
1423 channel_value_satoshis,
1424 holder_channel_pubkeys,
1425 channel_parameters: counterparty_channel_data,
1426 channel_keys_id: keys_id,
1427 rand_bytes_unique_start: entropy_source.get_secure_random_bytes(),
1428 rand_bytes_index: AtomicCounter::new(),
1433 /// Simple implementation of [`EntropySource`], [`NodeSigner`], and [`SignerProvider`] that takes a
1434 /// 32-byte seed for use as a BIP 32 extended key and derives keys from that.
1436 /// Your `node_id` is seed/0'.
1437 /// Unilateral closes may use seed/1'.
1438 /// Cooperative closes may use seed/2'.
1439 /// The two close keys may be needed to claim on-chain funds!
1441 /// This struct cannot be used for nodes that wish to support receiving phantom payments;
1442 /// [`PhantomKeysManager`] must be used instead.
1444 /// Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
1445 /// previously issued invoices and attempts to pay previous invoices will fail.
1446 pub struct KeysManager {
1447 secp_ctx: Secp256k1<secp256k1::All>,
1448 node_secret: SecretKey,
1450 inbound_payment_key: KeyMaterial,
1451 destination_script: ScriptBuf,
1452 shutdown_pubkey: PublicKey,
1453 channel_master_key: ExtendedPrivKey,
1454 channel_child_index: AtomicUsize,
1456 rand_bytes_unique_start: [u8; 32],
1457 rand_bytes_index: AtomicCounter,
1460 starting_time_secs: u64,
1461 starting_time_nanos: u32,
1465 /// Constructs a [`KeysManager`] from a 32-byte seed. If the seed is in some way biased (e.g.,
1466 /// your CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
1467 /// `starting_time` isn't strictly required to actually be a time, but it must absolutely,
1468 /// without a doubt, be unique to this instance. ie if you start multiple times with the same
1469 /// `seed`, `starting_time` must be unique to each run. Thus, the easiest way to achieve this
1470 /// is to simply use the current time (with very high precision).
1472 /// The `seed` MUST be backed up safely prior to use so that the keys can be re-created, however,
1473 /// obviously, `starting_time` should be unique every time you reload the library - it is only
1474 /// used to generate new ephemeral key data (which will be stored by the individual channel if
1477 /// Note that the seed is required to recover certain on-chain funds independent of
1478 /// [`ChannelMonitor`] data, though a current copy of [`ChannelMonitor`] data is also required
1479 /// for any channel, and some on-chain during-closing funds.
1481 /// [`ChannelMonitor`]: crate::chain::channelmonitor::ChannelMonitor
1482 pub fn new(seed: &[u8; 32], starting_time_secs: u64, starting_time_nanos: u32) -> Self {
1483 let secp_ctx = Secp256k1::new();
1484 // Note that when we aren't serializing the key, network doesn't matter
1485 match ExtendedPrivKey::new_master(Network::Testnet, seed) {
1487 let node_secret = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(0).unwrap()).expect("Your RNG is busted").private_key;
1488 let node_id = PublicKey::from_secret_key(&secp_ctx, &node_secret);
1489 let destination_script = match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(1).unwrap()) {
1490 Ok(destination_key) => {
1491 let wpubkey_hash = WPubkeyHash::hash(&ExtendedPubKey::from_priv(&secp_ctx, &destination_key).to_pub().to_bytes());
1492 Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1493 .push_slice(&wpubkey_hash.to_byte_array())
1496 Err(_) => panic!("Your RNG is busted"),
1498 let shutdown_pubkey = match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(2).unwrap()) {
1499 Ok(shutdown_key) => ExtendedPubKey::from_priv(&secp_ctx, &shutdown_key).public_key,
1500 Err(_) => panic!("Your RNG is busted"),
1502 let channel_master_key = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(3).unwrap()).expect("Your RNG is busted");
1503 let inbound_payment_key: SecretKey = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(5).unwrap()).expect("Your RNG is busted").private_key;
1504 let mut inbound_pmt_key_bytes = [0; 32];
1505 inbound_pmt_key_bytes.copy_from_slice(&inbound_payment_key[..]);
1507 let mut rand_bytes_engine = Sha256::engine();
1508 rand_bytes_engine.input(&starting_time_secs.to_be_bytes());
1509 rand_bytes_engine.input(&starting_time_nanos.to_be_bytes());
1510 rand_bytes_engine.input(seed);
1511 rand_bytes_engine.input(b"LDK PRNG Seed");
1512 let rand_bytes_unique_start = Sha256::from_engine(rand_bytes_engine).to_byte_array();
1514 let mut res = KeysManager {
1518 inbound_payment_key: KeyMaterial(inbound_pmt_key_bytes),
1524 channel_child_index: AtomicUsize::new(0),
1526 rand_bytes_unique_start,
1527 rand_bytes_index: AtomicCounter::new(),
1531 starting_time_nanos,
1533 let secp_seed = res.get_secure_random_bytes();
1534 res.secp_ctx.seeded_randomize(&secp_seed);
1537 Err(_) => panic!("Your rng is busted"),
1541 /// Gets the "node_id" secret key used to sign gossip announcements, decode onion data, etc.
1542 pub fn get_node_secret_key(&self) -> SecretKey {
1546 /// Derive an old [`WriteableEcdsaChannelSigner`] containing per-channel secrets based on a key derivation parameters.
1547 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, params: &[u8; 32]) -> InMemorySigner {
1548 let chan_id = u64::from_be_bytes(params[0..8].try_into().unwrap());
1549 let mut unique_start = Sha256::engine();
1550 unique_start.input(params);
1551 unique_start.input(&self.seed);
1553 // We only seriously intend to rely on the channel_master_key for true secure
1554 // entropy, everything else just ensures uniqueness. We rely on the unique_start (ie
1555 // starting_time provided in the constructor) to be unique.
1556 let child_privkey = self.channel_master_key.ckd_priv(&self.secp_ctx,
1557 ChildNumber::from_hardened_idx((chan_id as u32) % (1 << 31)).expect("key space exhausted")
1558 ).expect("Your RNG is busted");
1559 unique_start.input(&child_privkey.private_key[..]);
1561 let seed = Sha256::from_engine(unique_start).to_byte_array();
1563 let commitment_seed = {
1564 let mut sha = Sha256::engine();
1566 sha.input(&b"commitment seed"[..]);
1567 Sha256::from_engine(sha).to_byte_array()
1569 macro_rules! key_step {
1570 ($info: expr, $prev_key: expr) => {{
1571 let mut sha = Sha256::engine();
1573 sha.input(&$prev_key[..]);
1574 sha.input(&$info[..]);
1575 SecretKey::from_slice(&Sha256::from_engine(sha).to_byte_array()).expect("SHA-256 is busted")
1578 let funding_key = key_step!(b"funding key", commitment_seed);
1579 let revocation_base_key = key_step!(b"revocation base key", funding_key);
1580 let payment_key = key_step!(b"payment key", revocation_base_key);
1581 let delayed_payment_base_key = key_step!(b"delayed payment base key", payment_key);
1582 let htlc_base_key = key_step!(b"HTLC base key", delayed_payment_base_key);
1583 let prng_seed = self.get_secure_random_bytes();
1585 InMemorySigner::new(
1588 revocation_base_key,
1590 delayed_payment_base_key,
1593 channel_value_satoshis,
1599 /// Signs the given [`PartiallySignedTransaction`] which spends the given [`SpendableOutputDescriptor`]s.
1600 /// The resulting inputs will be finalized and the PSBT will be ready for broadcast if there
1601 /// are no other inputs that need signing.
1603 /// Returns `Err(())` if the PSBT is missing a descriptor or if we fail to sign.
1605 /// May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
1606 /// this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
1607 pub fn sign_spendable_outputs_psbt<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], mut psbt: PartiallySignedTransaction, secp_ctx: &Secp256k1<C>) -> Result<PartiallySignedTransaction, ()> {
1608 let mut keys_cache: Option<(InMemorySigner, [u8; 32])> = None;
1609 for outp in descriptors {
1611 SpendableOutputDescriptor::StaticPaymentOutput(descriptor) => {
1612 let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == descriptor.outpoint.into_bitcoin_outpoint()).ok_or(())?;
1613 if keys_cache.is_none() || keys_cache.as_ref().unwrap().1 != descriptor.channel_keys_id {
1614 let mut signer = self.derive_channel_keys(descriptor.channel_value_satoshis, &descriptor.channel_keys_id);
1615 if let Some(channel_params) = descriptor.channel_transaction_parameters.as_ref() {
1616 signer.provide_channel_parameters(channel_params);
1618 keys_cache = Some((signer, descriptor.channel_keys_id));
1620 let witness = keys_cache.as_ref().unwrap().0.sign_counterparty_payment_input(&psbt.unsigned_tx, input_idx, &descriptor, &secp_ctx)?;
1621 psbt.inputs[input_idx].final_script_witness = Some(witness);
1623 SpendableOutputDescriptor::DelayedPaymentOutput(descriptor) => {
1624 let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == descriptor.outpoint.into_bitcoin_outpoint()).ok_or(())?;
1625 if keys_cache.is_none() || keys_cache.as_ref().unwrap().1 != descriptor.channel_keys_id {
1627 self.derive_channel_keys(descriptor.channel_value_satoshis, &descriptor.channel_keys_id),
1628 descriptor.channel_keys_id));
1630 let witness = keys_cache.as_ref().unwrap().0.sign_dynamic_p2wsh_input(&psbt.unsigned_tx, input_idx, &descriptor, &secp_ctx)?;
1631 psbt.inputs[input_idx].final_script_witness = Some(witness);
1633 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
1634 let input_idx = psbt.unsigned_tx.input.iter().position(|i| i.previous_output == outpoint.into_bitcoin_outpoint()).ok_or(())?;
1635 let derivation_idx = if output.script_pubkey == self.destination_script {
1641 // Note that when we aren't serializing the key, network doesn't matter
1642 match ExtendedPrivKey::new_master(Network::Testnet, &self.seed) {
1644 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(derivation_idx).expect("key space exhausted")) {
1646 Err(_) => panic!("Your RNG is busted"),
1649 Err(_) => panic!("Your rng is busted"),
1652 let pubkey = ExtendedPubKey::from_priv(&secp_ctx, &secret).to_pub();
1653 if derivation_idx == 2 {
1654 assert_eq!(pubkey.inner, self.shutdown_pubkey);
1656 let witness_script = bitcoin::Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
1657 let payment_script = bitcoin::Address::p2wpkh(&pubkey, Network::Testnet).expect("uncompressed key found").script_pubkey();
1659 if payment_script != output.script_pubkey { return Err(()); };
1661 let sighash = hash_to_message!(&sighash::SighashCache::new(&psbt.unsigned_tx).segwit_signature_hash(input_idx, &witness_script, output.value, EcdsaSighashType::All).unwrap()[..]);
1662 let sig = sign_with_aux_rand(secp_ctx, &sighash, &secret.private_key, &self);
1663 let mut sig_ser = sig.serialize_der().to_vec();
1664 sig_ser.push(EcdsaSighashType::All as u8);
1665 let witness = Witness::from_slice(&[&sig_ser, &pubkey.inner.serialize().to_vec()]);
1666 psbt.inputs[input_idx].final_script_witness = Some(witness);
1674 /// Creates a [`Transaction`] which spends the given descriptors to the given outputs, plus an
1675 /// output to the given change destination (if sufficient change value remains). The
1676 /// transaction will have a feerate, at least, of the given value.
1678 /// The `locktime` argument is used to set the transaction's locktime. If `None`, the
1679 /// transaction will have a locktime of 0. It it recommended to set this to the current block
1680 /// height to avoid fee sniping, unless you have some specific reason to use a different
1683 /// Returns `Err(())` if the output value is greater than the input value minus required fee,
1684 /// if a descriptor was duplicated, or if an output descriptor `script_pubkey`
1685 /// does not match the one we can spend.
1687 /// We do not enforce that outputs meet the dust limit or that any output scripts are standard.
1689 /// May panic if the [`SpendableOutputDescriptor`]s were not generated by channels which used
1690 /// this [`KeysManager`] or one of the [`InMemorySigner`] created by this [`KeysManager`].
1691 pub fn spend_spendable_outputs<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: ScriptBuf, feerate_sat_per_1000_weight: u32, locktime: Option<LockTime>, secp_ctx: &Secp256k1<C>) -> Result<Transaction, ()> {
1692 let (mut psbt, expected_max_weight) = SpendableOutputDescriptor::create_spendable_outputs_psbt(descriptors, outputs, change_destination_script, feerate_sat_per_1000_weight, locktime)?;
1693 psbt = self.sign_spendable_outputs_psbt(descriptors, psbt, secp_ctx)?;
1695 let spend_tx = psbt.extract_tx();
1697 debug_assert!(expected_max_weight >= spend_tx.weight().to_wu());
1698 // Note that witnesses with a signature vary somewhat in size, so allow
1699 // `expected_max_weight` to overshoot by up to 3 bytes per input.
1700 debug_assert!(expected_max_weight <= spend_tx.weight().to_wu() + descriptors.len() as u64 * 3);
1706 impl EntropySource for KeysManager {
1707 fn get_secure_random_bytes(&self) -> [u8; 32] {
1708 let index = self.rand_bytes_index.get_increment();
1709 let mut nonce = [0u8; 16];
1710 nonce[..8].copy_from_slice(&index.to_be_bytes());
1711 ChaCha20::get_single_block(&self.rand_bytes_unique_start, &nonce)
1715 impl NodeSigner for KeysManager {
1716 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1718 Recipient::Node => Ok(self.node_id.clone()),
1719 Recipient::PhantomNode => Err(())
1723 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1724 let mut node_secret = match recipient {
1725 Recipient::Node => Ok(self.node_secret.clone()),
1726 Recipient::PhantomNode => Err(())
1728 if let Some(tweak) = tweak {
1729 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1731 Ok(SharedSecret::new(other_key, &node_secret))
1734 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
1735 self.inbound_payment_key.clone()
1738 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1739 let preimage = construct_invoice_preimage(&hrp_bytes, &invoice_data);
1740 let secret = match recipient {
1741 Recipient::Node => Ok(&self.node_secret),
1742 Recipient::PhantomNode => Err(())
1744 Ok(self.secp_ctx.sign_ecdsa_recoverable(&hash_to_message!(&Sha256::hash(&preimage).to_byte_array()), secret))
1747 fn sign_bolt12_invoice_request(
1748 &self, invoice_request: &UnsignedInvoiceRequest
1749 ) -> Result<schnorr::Signature, ()> {
1750 let message = invoice_request.tagged_hash().as_digest();
1751 let keys = KeyPair::from_secret_key(&self.secp_ctx, &self.node_secret);
1752 let aux_rand = self.get_secure_random_bytes();
1753 Ok(self.secp_ctx.sign_schnorr_with_aux_rand(message, &keys, &aux_rand))
1756 fn sign_bolt12_invoice(
1757 &self, invoice: &UnsignedBolt12Invoice
1758 ) -> Result<schnorr::Signature, ()> {
1759 let message = invoice.tagged_hash().as_digest();
1760 let keys = KeyPair::from_secret_key(&self.secp_ctx, &self.node_secret);
1761 let aux_rand = self.get_secure_random_bytes();
1762 Ok(self.secp_ctx.sign_schnorr_with_aux_rand(message, &keys, &aux_rand))
1765 fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()> {
1766 let msg_hash = hash_to_message!(&Sha256dHash::hash(&msg.encode()[..])[..]);
1767 Ok(self.secp_ctx.sign_ecdsa(&msg_hash, &self.node_secret))
1771 impl SignerProvider for KeysManager {
1772 type Signer = InMemorySigner;
1774 fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1775 let child_idx = self.channel_child_index.fetch_add(1, Ordering::AcqRel);
1776 // `child_idx` is the only thing guaranteed to make each channel unique without a restart
1777 // (though `user_channel_id` should help, depending on user behavior). If it manages to
1778 // roll over, we may generate duplicate keys for two different channels, which could result
1779 // in loss of funds. Because we only support 32-bit+ systems, assert that our `AtomicUsize`
1780 // doesn't reach `u32::MAX`.
1781 assert!(child_idx < core::u32::MAX as usize, "2^32 channels opened without restart");
1782 let mut id = [0; 32];
1783 id[0..4].copy_from_slice(&(child_idx as u32).to_be_bytes());
1784 id[4..8].copy_from_slice(&self.starting_time_nanos.to_be_bytes());
1785 id[8..16].copy_from_slice(&self.starting_time_secs.to_be_bytes());
1786 id[16..32].copy_from_slice(&user_channel_id.to_be_bytes());
1790 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
1791 self.derive_channel_keys(channel_value_satoshis, &channel_keys_id)
1794 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError> {
1795 InMemorySigner::read(&mut io::Cursor::new(reader), self)
1798 fn get_destination_script(&self) -> Result<ScriptBuf, ()> {
1799 Ok(self.destination_script.clone())
1802 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1803 Ok(ShutdownScript::new_p2wpkh_from_pubkey(self.shutdown_pubkey.clone()))
1807 /// Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
1810 /// A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
1811 /// paid to one of multiple nodes. This works because we encode the invoice route hints such that
1812 /// LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
1813 /// itself without ever needing to forward to this fake node.
1815 /// Phantom node payments are useful for load balancing between multiple LDK nodes. They also
1816 /// provide some fault tolerance, because payers will automatically retry paying other provided
1817 /// nodes in the case that one node goes down.
1819 /// Note that multi-path payments are not supported in phantom invoices for security reasons.
1820 // In the hypothetical case that we did support MPP phantom payments, there would be no way for
1821 // nodes to know when the full payment has been received (and the preimage can be released) without
1822 // significantly compromising on our safety guarantees. I.e., if we expose the ability for the user
1823 // to tell LDK when the preimage can be released, we open ourselves to attacks where the preimage
1824 // is released too early.
1826 /// Switching between this struct and [`KeysManager`] will invalidate any previously issued
1827 /// invoices and attempts to pay previous invoices will fail.
1828 pub struct PhantomKeysManager {
1830 inbound_payment_key: KeyMaterial,
1831 phantom_secret: SecretKey,
1832 phantom_node_id: PublicKey,
1835 impl EntropySource for PhantomKeysManager {
1836 fn get_secure_random_bytes(&self) -> [u8; 32] {
1837 self.inner.get_secure_random_bytes()
1841 impl NodeSigner for PhantomKeysManager {
1842 fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1844 Recipient::Node => self.inner.get_node_id(Recipient::Node),
1845 Recipient::PhantomNode => Ok(self.phantom_node_id.clone()),
1849 fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1850 let mut node_secret = match recipient {
1851 Recipient::Node => self.inner.node_secret.clone(),
1852 Recipient::PhantomNode => self.phantom_secret.clone(),
1854 if let Some(tweak) = tweak {
1855 node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1857 Ok(SharedSecret::new(other_key, &node_secret))
1860 fn get_inbound_payment_key_material(&self) -> KeyMaterial {
1861 self.inbound_payment_key.clone()
1864 fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1865 let preimage = construct_invoice_preimage(&hrp_bytes, &invoice_data);
1866 let secret = match recipient {
1867 Recipient::Node => &self.inner.node_secret,
1868 Recipient::PhantomNode => &self.phantom_secret,
1870 Ok(self.inner.secp_ctx.sign_ecdsa_recoverable(&hash_to_message!(&Sha256::hash(&preimage).to_byte_array()), secret))
1873 fn sign_bolt12_invoice_request(
1874 &self, invoice_request: &UnsignedInvoiceRequest
1875 ) -> Result<schnorr::Signature, ()> {
1876 self.inner.sign_bolt12_invoice_request(invoice_request)
1879 fn sign_bolt12_invoice(
1880 &self, invoice: &UnsignedBolt12Invoice
1881 ) -> Result<schnorr::Signature, ()> {
1882 self.inner.sign_bolt12_invoice(invoice)
1885 fn sign_gossip_message(&self, msg: UnsignedGossipMessage) -> Result<Signature, ()> {
1886 self.inner.sign_gossip_message(msg)
1890 impl SignerProvider for PhantomKeysManager {
1891 type Signer = InMemorySigner;
1893 fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1894 self.inner.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1897 fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> Self::Signer {
1898 self.inner.derive_channel_signer(channel_value_satoshis, channel_keys_id)
1901 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, DecodeError> {
1902 self.inner.read_chan_signer(reader)
1905 fn get_destination_script(&self) -> Result<ScriptBuf, ()> {
1906 self.inner.get_destination_script()
1909 fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1910 self.inner.get_shutdown_scriptpubkey()
1914 impl PhantomKeysManager {
1915 /// Constructs a [`PhantomKeysManager`] given a 32-byte seed and an additional `cross_node_seed`
1916 /// that is shared across all nodes that intend to participate in [phantom node payments]
1919 /// See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
1920 /// `starting_time_nanos`.
1922 /// `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
1923 /// same across restarts, or else inbound payments may fail.
1925 /// [phantom node payments]: PhantomKeysManager
1926 pub fn new(seed: &[u8; 32], starting_time_secs: u64, starting_time_nanos: u32, cross_node_seed: &[u8; 32]) -> Self {
1927 let inner = KeysManager::new(seed, starting_time_secs, starting_time_nanos);
1928 let (inbound_key, phantom_key) = hkdf_extract_expand_twice(b"LDK Inbound and Phantom Payment Key Expansion", cross_node_seed);
1929 let phantom_secret = SecretKey::from_slice(&phantom_key).unwrap();
1930 let phantom_node_id = PublicKey::from_secret_key(&inner.secp_ctx, &phantom_secret);
1933 inbound_payment_key: KeyMaterial(inbound_key),
1939 /// See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
1940 pub fn spend_spendable_outputs<C: Signing>(&self, descriptors: &[&SpendableOutputDescriptor], outputs: Vec<TxOut>, change_destination_script: ScriptBuf, feerate_sat_per_1000_weight: u32, locktime: Option<LockTime>, secp_ctx: &Secp256k1<C>) -> Result<Transaction, ()> {
1941 self.inner.spend_spendable_outputs(descriptors, outputs, change_destination_script, feerate_sat_per_1000_weight, locktime, secp_ctx)
1944 /// See [`KeysManager::derive_channel_keys`] for documentation on this method.
1945 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, params: &[u8; 32]) -> InMemorySigner {
1946 self.inner.derive_channel_keys(channel_value_satoshis, params)
1949 /// Gets the "node_id" secret key used to sign gossip announcements, decode onion data, etc.
1950 pub fn get_node_secret_key(&self) -> SecretKey {
1951 self.inner.get_node_secret_key()
1954 /// Gets the "node_id" secret key of the phantom node used to sign invoices, decode the
1955 /// last-hop onion data, etc.
1956 pub fn get_phantom_node_secret_key(&self) -> SecretKey {
1961 // Ensure that EcdsaChannelSigner can have a vtable
1964 let _signer: Box<dyn EcdsaChannelSigner>;
1969 use std::sync::{Arc, mpsc};
1970 use std::sync::mpsc::TryRecvError;
1972 use std::time::Duration;
1973 use bitcoin::blockdata::constants::genesis_block;
1974 use bitcoin::Network;
1975 use crate::sign::{EntropySource, KeysManager};
1977 use criterion::Criterion;
1979 pub fn bench_get_secure_random_bytes(bench: &mut Criterion) {
1980 let seed = [0u8; 32];
1981 let now = Duration::from_secs(genesis_block(Network::Testnet).header.time as u64);
1982 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_micros()));
1984 let mut handles = Vec::new();
1985 let mut stops = Vec::new();
1987 let keys_manager_clone = Arc::clone(&keys_manager);
1988 let (stop_sender, stop_receiver) = mpsc::channel();
1989 let handle = thread::spawn(move || {
1991 keys_manager_clone.get_secure_random_bytes();
1992 match stop_receiver.try_recv() {
1993 Ok(_) | Err(TryRecvError::Disconnected) => {
1994 println!("Terminating.");
1997 Err(TryRecvError::Empty) => {}
2001 handles.push(handle);
2002 stops.push(stop_sender);
2005 bench.bench_function("get_secure_random_bytes", |b| b.iter(||
2006 keys_manager.get_secure_random_bytes()));
2009 let _ = stop.send(());
2011 for handle in handles {
2012 handle.join().unwrap();