Fix doc errors and warnings.

Author: arik-so

lightning/src/chain/keysinterface.rs

@@ -143,8 +143,8 @@ pub enum SpendableOutputDescriptor {
 	/// These may include outputs from a transaction punishing our counterparty or claiming an HTLC
 	/// on-chain using the payment preimage or after it has timed out.
 	///
-	/// [`get_shutdown_scriptpubkey`]: KeysInterface::get_shutdown_scriptpubkey
-	/// [`get_destination_script`]: KeysInterface::get_shutdown_scriptpubkey
+	/// [`get_shutdown_scriptpubkey`]: SignerProvider::get_shutdown_scriptpubkey
+	/// [`get_destination_script`]: SignerProvider::get_shutdown_scriptpubkey
 	StaticOutput {
 		/// The outpoint which is spendable.
 		outpoint: OutPoint,
@@ -1021,7 +1021,6 @@ impl KeysManager {
 		match ExtendedPrivKey::new_master(Network::Testnet, seed) {
 			Ok(master_key) => {
 				let node_secret = master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(0).unwrap()).expect("Your RNG is busted").private_key;
-				let node_id = PublicKey::from_secret_key(&secp_ctx, &node_secret);
 				let destination_script = match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx(1).unwrap()) {
 					Ok(destination_key) => {
 						let wpubkey_hash = WPubkeyHash::hash(&ExtendedPubKey::from_priv(&secp_ctx, &destination_key).to_pub().to_bytes());
@@ -1408,7 +1407,6 @@ impl PhantomKeysManager {
 		let inner = KeysManager::new(seed, starting_time_secs, starting_time_nanos);
 		let (inbound_key, phantom_key) = hkdf_extract_expand_twice(b"LDK Inbound and Phantom Payment Key Expansion", cross_node_seed);
 		let phantom_secret = SecretKey::from_slice(&phantom_key).unwrap();
-		let phantom_node_id = PublicKey::from_secret_key(&inner.secp_ctx, &phantom_secret);
 		Self {
 			inner,
 			inbound_payment_key: KeyMaterial(inbound_key),

lightning/src/ln/inbound_payment.rs

@@ -35,9 +35,9 @@ const AMT_MSAT_LEN: usize = 8;
 const METHOD_TYPE_OFFSET: usize = 5;
 
 /// A set of keys that were HKDF-expanded from an initial call to
-/// [`KeysInterface::get_inbound_payment_key_material`].
+/// [`NodeSigner::get_inbound_payment_key_material`].
 ///
-/// [`KeysInterface::get_inbound_payment_key_material`]: crate::chain::keysinterface::KeysInterface::get_inbound_payment_key_material
+/// [`NodeSigner::get_inbound_payment_key_material`]: crate::chain::keysinterface::NodeSigner::get_inbound_payment_key_material
 pub struct ExpandedKey {
 	/// The key used to encrypt the bytes containing the payment metadata (i.e. the amount and
 	/// expiry, included for payment verification on decryption).
@@ -84,7 +84,7 @@ impl Method {
 /// `ChannelManager` is required. Useful for generating invoices for [phantom node payments] without
 /// a `ChannelManager`.
 ///
-/// `keys` is generated by calling [`KeysInterface::get_inbound_payment_key_material`] and then
+/// `keys` is generated by calling [`NodeSigner::get_inbound_payment_key_material`] and then
 /// calling [`ExpandedKey::new`] with its result. It is recommended to cache this value and not
 /// regenerate it for each new inbound payment.
 ///
@@ -176,7 +176,7 @@ fn construct_payment_secret(iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METAD
 ///
 /// The metadata is constructed as:
 ///   payment method (3 bits) || payment amount (8 bytes - 3 bits) || expiry (8 bytes)
-/// and encrypted using a key derived from [`KeysInterface::get_inbound_payment_key_material`].
+/// and encrypted using a key derived from [`NodeSigner::get_inbound_payment_key_material`].
 ///
 /// Then on payment receipt, we verify in this method that the payment preimage and payment secret
 /// match what was constructed.
@@ -197,7 +197,7 @@ fn construct_payment_secret(iv_bytes: &[u8; IV_LEN], metadata_bytes: &[u8; METAD
 ///
 /// See [`ExpandedKey`] docs for more info on the individual keys used.
 ///
-/// [`KeysInterface::get_inbound_payment_key_material`]: crate::chain::keysinterface::KeysInterface::get_inbound_payment_key_material
+/// [`NodeSigner::get_inbound_payment_key_material`]: crate::chain::keysinterface::NodeSigner::get_inbound_payment_key_material
 /// [`create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
 /// [`create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
 pub(super) fn verify<L: Deref>(payment_hash: PaymentHash, payment_data: &msgs::FinalOnionHopData, highest_seen_timestamp: u64, keys: &ExpandedKey, logger: &L) -> Result<Option<PaymentPreimage>, ()>

lightning/src/util/config.rs

@@ -120,11 +120,11 @@ pub struct ChannelHandshakeConfig {
 	/// any attacker who is able to take control of a channel can just as easily send the funds via
 	/// lightning payments, so we never require that our counterparties support this option.
 	///
-	/// The upfront key committed is provided from [`KeysInterface::get_shutdown_scriptpubkey`].
+	/// The upfront key committed is provided from [`SignerProvider::get_shutdown_scriptpubkey`].
 	///
 	/// Default value: true.
 	///
-	/// [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
+	/// [`SignerProvider::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::SignerProvider::get_shutdown_scriptpubkey
 	pub commit_upfront_shutdown_pubkey: bool,
 
 	/// The Proportion of the channel value to configure as counterparty's channel reserve,

lightning/src/util/errors.rs

@@ -55,13 +55,13 @@ pub enum APIError {
 	/// [`chain::Watch::update_channel`]: crate::chain::Watch::update_channel
 	/// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
 	MonitorUpdateInProgress,
-	/// [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
+	/// [`SignerProvider::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
 	/// with the channel counterparty as negotiated in [`InitFeatures`].
 	///
 	/// Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
 	/// a channel or cooperatively close one with this peer (and will have to force-close instead).
 	///
-	/// [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
+	/// [`SignerProvider::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::SignerProvider::get_shutdown_scriptpubkey
 	/// [`InitFeatures`]: crate::ln::features::InitFeatures
 	IncompatibleShutdownScript {
 		/// The incompatible shutdown script.

lightning/src/util/test_utils.rs

@@ -689,7 +689,7 @@ impl TestKeysInterface {
 		}
 	}
 
-	/// Sets an expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] is
+	/// Sets an expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] is
 	/// called.
 	pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
 		self.expectations.lock().unwrap()
@@ -737,7 +737,7 @@ impl Drop for TestKeysInterface {
 	}
 }
 
-/// An expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] was called and
+/// An expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] was called and
 /// returns a [`ShutdownScript`].
 pub struct OnGetShutdownScriptpubkey {
 	/// A shutdown script used to close a channel.