Move get_inbound_payment_key_material from KeysInterface to NodeSigner

Author: arik-so

fuzz/src/chanmon_consistency.rs

@@ -174,6 +174,10 @@ impl NodeSigner for KeyProvider {
 	fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> {
 		Ok(SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id]).unwrap())
 	}
+
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
+		KeyMaterial([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id])
+	}
 }
 
 impl SignerProvider for KeyProvider {
@@ -218,10 +222,6 @@ impl SignerProvider for KeyProvider {
 }
 
 impl KeysInterface for KeyProvider {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
-		KeyMaterial([0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, self.node_id])
-	}
-
 	fn get_destination_script(&self) -> Script {
 		let secp_ctx = Secp256k1::signing_only();
 		let channel_monitor_claim_key = SecretKey::from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, self.node_id]).unwrap();

fuzz/src/full_stack.rs

@@ -278,6 +278,10 @@ impl NodeSigner for KeyProvider {
 	fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> {
 		Ok(self.node_secret.clone())
 	}
+
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
+		self.inbound_payment_key.clone()
+	}
 }
 
 impl SignerProvider for KeyProvider {
@@ -335,10 +339,6 @@ impl SignerProvider for KeyProvider {
 }
 
 impl KeysInterface for KeyProvider {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
-		self.inbound_payment_key.clone()
-	}
-
 	fn get_destination_script(&self) -> Script {
 		let secp_ctx = Secp256k1::signing_only();
 		let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();

fuzz/src/onion_message.rs

@@ -103,6 +103,8 @@ impl NodeSigner for KeyProvider {
 	fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> {
 		Ok(self.node_secret.clone())
 	}
+
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!() }
 }
 
 impl SignerProvider for KeyProvider {
@@ -118,8 +120,6 @@ impl SignerProvider for KeyProvider {
 }
 
 impl KeysInterface for KeyProvider {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!() }
-
 	fn get_destination_script(&self) -> Script { unreachable!() }
 
 	fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!() }

lightning/src/chain/keysinterface.rs

@@ -448,6 +448,20 @@ pub trait NodeSigner {
 	/// Errors if the [`Recipient`] variant is not supported by the implementation.
 	fn get_node_secret(&self, recipient: Recipient) -> Result<SecretKey, ()>;
 
+	/// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
+	///
+	/// If the implementor of this trait supports [phantom node payments], then every node that is
+	/// intended to be included in the phantom invoice route hints must return the same value from
+	/// this method.
+	// This is because LDK avoids storing inbound payment data by encrypting payment data in the
+	// payment hash and/or payment secret, therefore for a payment to be receivable by multiple
+	// nodes, they must share the key that encrypts this payment data.
+	///
+	/// This method must return the same value each time it is called.
+	///
+	/// [phantom node payments]: PhantomKeysManager
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial;
+
 	/// Get node id based on the provided [`Recipient`]. This public key corresponds to the secret in
 	/// [`get_node_secret`].
 	///
@@ -533,20 +547,6 @@ pub trait SignerProvider {
 
 /// A trait to describe an object which can get user secrets and key material.
 pub trait KeysInterface: EntropySource + NodeSigner + SignerProvider {
-	/// Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
-	///
-	/// If the implementor of this trait supports [phantom node payments], then every node that is
-	/// intended to be included in the phantom invoice route hints must return the same value from
-	/// this method.
-	// This is because LDK avoids storing inbound payment data by encrypting payment data in the
-	// payment hash and/or payment secret, therefore for a payment to be receivable by multiple
-	// nodes, they must share the key that encrypts this payment data.
-	///
-	/// This method must return the same value each time it is called.
-	///
-	/// [phantom node payments]: PhantomKeysManager
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial;
-
 	/// Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
 	///
 	/// This method should return a different value each time it is called, to avoid linking
@@ -1273,6 +1273,10 @@ impl NodeSigner for KeysManager {
 			Recipient::PhantomNode => Err(())
 		}
 	}
+
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
+		self.inbound_payment_key.clone()
+	}
 }
 
 impl SignerProvider for KeysManager {
@@ -1299,10 +1303,6 @@ impl SignerProvider for KeysManager {
 }
 
 impl KeysInterface for KeysManager {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
-		self.inbound_payment_key.clone()
-	}
-
 	fn get_destination_script(&self) -> Script {
 		self.destination_script.clone()
 	}
@@ -1353,6 +1353,10 @@ impl NodeSigner for PhantomKeysManager {
 		}
 	}
 
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
+		self.inbound_payment_key.clone()
+	}
+
 	// We need to override the invoice signing implementation for phantom keys managers
 	fn sign_invoice<C: Signing>(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient, _secp_context: &Secp256k1<C>) -> Result<RecoverableSignature, ()> {
 		let preimage = construct_invoice_preimage(&hrp_bytes, &invoice_data);
@@ -1378,10 +1382,6 @@ impl SignerProvider for PhantomKeysManager {
 }
 
 impl KeysInterface for PhantomKeysManager {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial {
-		self.inbound_payment_key.clone()
-	}
-
 	fn get_destination_script(&self) -> Script {
 		self.inner.get_destination_script()
 	}

lightning/src/ln/channel.rs

@@ -6858,6 +6858,8 @@ mod tests {
 
 	impl NodeSigner for Keys {
 		fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> { panic!(); }
+
+		fn get_inbound_payment_key_material(&self) -> KeyMaterial { panic!(); }
 	}
 
 	impl SignerProvider for Keys {
@@ -6875,8 +6877,6 @@ mod tests {
 	}
 
 	impl KeysInterface for Keys {
-		fn get_inbound_payment_key_material(&self) -> KeyMaterial { panic!(); }
-
 		fn get_destination_script(&self) -> Script {
 			let secp_ctx = Secp256k1::signing_only();
 			let channel_monitor_claim_key = SecretKey::from_slice(&hex::decode("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();

lightning/src/util/test_utils.rs

@@ -77,6 +77,8 @@ impl EntropySource for OnlyReadsKeysInterface {
 
 impl NodeSigner for OnlyReadsKeysInterface {
 	fn get_node_secret(&self, _recipient: Recipient) -> Result<SecretKey, ()> { unreachable!(); }
+
+	fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!(); }
 }
 
 impl SignerProvider for OnlyReadsKeysInterface {
@@ -100,7 +102,6 @@ impl SignerProvider for OnlyReadsKeysInterface {
 }
 
 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
-	fn get_inbound_payment_key_material(&self) -> KeyMaterial { unreachable!(); }
 	fn get_destination_script(&self) -> Script { unreachable!(); }
 	fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); }
 }
@@ -625,6 +626,10 @@ impl NodeSigner for TestKeysInterface {
 		self.backing.get_node_secret(recipient)
 	}
 
+	fn get_inbound_payment_key_material(&self) -> keysinterface::KeyMaterial {
+		self.backing.get_inbound_payment_key_material()
+	}
+
 	fn sign_invoice<C: Signing>(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient, secp_context: &Secp256k1<C>) -> Result<RecoverableSignature, ()> {
 		self.backing.sign_invoice(hrp_bytes, invoice_data, recipient, secp_context)
 	}
@@ -658,10 +663,6 @@ impl SignerProvider for TestKeysInterface {
 }
 
 impl keysinterface::KeysInterface for TestKeysInterface {
-	fn get_inbound_payment_key_material(&self) -> keysinterface::KeyMaterial {
-		self.backing.get_inbound_payment_key_material()
-	}
-
 	fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 
 	fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {