Have SignerProvider::get_shutdown_scriptpubkey take channel_keys_id

.. to allow users to return specific scripts per channel.

Author: tnull

fuzz/src/chanmon_consistency.rs

@@ -421,7 +421,7 @@ impl SignerProvider for KeyProvider {
 			.into_script())
 	}
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+	fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 		let secp_ctx = Secp256k1::signing_only();
 		#[rustfmt::skip]
 		let secret_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, 3, self.node_secret[31]]).unwrap();

fuzz/src/full_stack.rs

@@ -559,7 +559,7 @@ impl SignerProvider for KeyProvider {
 			.into_script())
 	}
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+	fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 		let secp_ctx = Secp256k1::signing_only();
 		let secret_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,

fuzz/src/onion_message.rs

@@ -278,7 +278,7 @@ impl SignerProvider for KeyProvider {
 		unreachable!()
 	}
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+	fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 		unreachable!()
 	}
 }

lightning/src/ln/async_signer_tests.rs

@@ -917,8 +917,9 @@ fn do_test_closing_signed(extra_closing_signed: bool, reconnect: bool) {
 	if extra_closing_signed {
 		let node_1_closing_signed_2_bad = {
 			let mut node_1_closing_signed_2 = node_1_closing_signed.clone();
-			let holder_script = nodes[0].keys_manager.get_shutdown_scriptpubkey().unwrap();
-			let counterparty_script = nodes[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
+			let channel_keys_id = [42u8; 32];
+			let holder_script = nodes[0].keys_manager.get_shutdown_scriptpubkey(channel_keys_id).unwrap();
+			let counterparty_script = nodes[1].keys_manager.get_shutdown_scriptpubkey(channel_keys_id).unwrap();
 			let funding_outpoint = bitcoin::OutPoint { txid: chan_1.3.compute_txid(), vout: 0 };
 			let closing_tx_2 = ClosingTransaction::new(50000, 0, holder_script.into(),
 				counterparty_script.into(), funding_outpoint);

lightning/src/ln/channel.rs

@@ -1805,7 +1805,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		} else { None };
 
 		let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
-			match signer_provider.get_shutdown_scriptpubkey() {
+			match signer_provider.get_shutdown_scriptpubkey(channel_keys_id) {
 				Ok(scriptpubkey) => Some(scriptpubkey),
 				Err(_) => return Err(ChannelError::close("Failed to get upfront shutdown scriptpubkey".to_owned())),
 			}
@@ -2050,7 +2050,7 @@ impl<SP: Deref> ChannelContext<SP> where SP::Target: SignerProvider {
 		secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
 
 		let shutdown_scriptpubkey = if config.channel_handshake_config.commit_upfront_shutdown_pubkey {
-			match signer_provider.get_shutdown_scriptpubkey() {
+			match signer_provider.get_shutdown_scriptpubkey(channel_keys_id) {
 				Ok(scriptpubkey) => Some(scriptpubkey),
 				Err(_) => return Err(APIError::ChannelUnavailable { err: "Failed to get shutdown scriptpubkey".to_owned()}),
 			}
@@ -6219,7 +6219,7 @@ impl<SP: Deref> Channel<SP> where
 			Some(_) => false,
 			None => {
 				assert!(send_shutdown);
-				let shutdown_scriptpubkey = match signer_provider.get_shutdown_scriptpubkey() {
+				let shutdown_scriptpubkey = match signer_provider.get_shutdown_scriptpubkey(self.context.channel_keys_id) {
 					Ok(scriptpubkey) => scriptpubkey,
 					Err(_) => return Err(ChannelError::close("Failed to get shutdown scriptpubkey".to_owned())),
 				};
@@ -7711,7 +7711,7 @@ impl<SP: Deref> Channel<SP> where
 					Some(script) => script,
 					None => {
 						// otherwise, use the shutdown scriptpubkey provided by the signer
-						match signer_provider.get_shutdown_scriptpubkey() {
+						match signer_provider.get_shutdown_scriptpubkey(self.context.channel_keys_id) {
 							Ok(scriptpubkey) => scriptpubkey,
 							Err(_) => return Err(APIError::ChannelUnavailable{err: "Failed to get shutdown scriptpubkey".to_owned()}),
 						}
@@ -9724,7 +9724,7 @@ mod tests {
 			Ok(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(channel_monitor_claim_key_hash).into_script())
 		}
 
-		fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+		fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 			let secp_ctx = Secp256k1::signing_only();
 			let channel_close_key = SecretKey::from_slice(&<Vec<u8>>::from_hex("0fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap()[..]).unwrap();
 			Ok(ShutdownScript::new_p2wpkh_from_pubkey(PublicKey::from_secret_key(&secp_ctx, &channel_close_key)))

lightning/src/ln/shutdown_tests.rs

@@ -984,7 +984,9 @@ fn test_unsupported_anysegwit_shutdown_script() {
 	let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 
 	// Check that using an unsupported shutdown script fails and a supported one succeeds.
-	let supported_shutdown_script = chanmon_cfgs[1].keys_manager.get_shutdown_scriptpubkey().unwrap();
+	let channel_keys_id = [42u8; 32];
+	let supported_shutdown_script = chanmon_cfgs[1].keys_manager
+		.get_shutdown_scriptpubkey(channel_keys_id).unwrap();
 	let unsupported_witness_program = WitnessProgram::new(WitnessVersion::V16, &[0, 40]).unwrap();
 	let unsupported_shutdown_script =
 		ShutdownScript::new_witness_program(&unsupported_witness_program).unwrap();

lightning/src/sign/mod.rs

@@ -1010,8 +1010,9 @@ pub trait SignerProvider {
 	/// channel force close.
 	///
 	/// This method should return a different value each time it is called, to avoid linking
-	/// on-chain funds across channels as controlled to the same user.
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()>;
+	/// on-chain funds across channels as controlled to the same user. `channel_keys_id` may be
+	/// used to derive a unique value for each channel.
+	fn get_shutdown_scriptpubkey(&self, channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()>;
 }
 
 /// A helper trait that describes an on-chain wallet capable of returning a (change) destination
@@ -2331,7 +2332,7 @@ impl SignerProvider for KeysManager {
 		Ok(self.destination_script.clone())
 	}
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+	fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 		Ok(ShutdownScript::new_p2wpkh_from_pubkey(self.shutdown_pubkey.clone()))
 	}
 }
@@ -2470,8 +2471,8 @@ impl SignerProvider for PhantomKeysManager {
 		self.inner.get_destination_script(channel_keys_id)
 	}
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
-		self.inner.get_shutdown_scriptpubkey()
+	fn get_shutdown_scriptpubkey(&self, channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
+		self.inner.get_shutdown_scriptpubkey(channel_keys_id)
 	}
 }
 

lightning/src/util/test_utils.rs

@@ -332,7 +332,7 @@ impl SignerProvider for OnlyReadsKeysInterface {
 	}
 
 	fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
+	fn get_shutdown_scriptpubkey(&self, _channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> { Err(()) }
 }
 
 pub struct TestChainMonitor<'a> {
@@ -1328,9 +1328,9 @@ impl SignerProvider for TestKeysInterface {
 
 	fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
 
-	fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
+	fn get_shutdown_scriptpubkey(&self, channel_keys_id: [u8; 32]) -> Result<ShutdownScript, ()> {
 		match &mut *self.expectations.lock().unwrap() {
-			None => self.backing.get_shutdown_scriptpubkey(),
+			None => self.backing.get_shutdown_scriptpubkey(channel_keys_id),
 			Some(expectations) => match expectations.pop_front() {
 				None => panic!("Unexpected get_shutdown_scriptpubkey"),
 				Some(expectation) => Ok(expectation.returns),