X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fln%2Fscript.rs;h=6c1d2102400786d41a124eafd26db70903bb82d2;hb=783e8188a7bd6470d5926bf5d1bae1350996801a;hp=b6fcdbd19045c0586eb65f5686092319592c6888;hpb=ecc70757f9863a76ab9d4cc8b6bfe1a9cc9f4977;p=rust-lightning

diff --git a/lightning/src/ln/script.rs b/lightning/src/ln/script.rs
index b6fcdbd1..6c1d2102 100644
--- a/lightning/src/ln/script.rs
+++ b/lightning/src/ln/script.rs
@@ -3,28 +3,34 @@
 use bitcoin::blockdata::opcodes::all::OP_PUSHBYTES_0 as SEGWIT_V0;
 use bitcoin::blockdata::script::{Builder, Script};
 use bitcoin::hashes::Hash;
-use bitcoin::hash_types::{PubkeyHash, ScriptHash, WPubkeyHash, WScriptHash};
-use bitcoin::secp256k1::key::PublicKey;
+use bitcoin::hash_types::{WPubkeyHash, WScriptHash};
+use bitcoin::secp256k1::PublicKey;
+use bitcoin::util::address::WitnessVersion;
 
-use ln::features::InitFeatures;
+use crate::ln::channelmanager;
+use crate::ln::features::InitFeatures;
+use crate::ln::msgs::DecodeError;
+use crate::util::ser::{Readable, Writeable, Writer};
 
 use core::convert::TryFrom;
-use core::num::NonZeroU8;
+use crate::io;
 
 /// A script pubkey for shutting down a channel as defined by [BOLT #2].
 ///
-/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
+/// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
+#[derive(Clone, PartialEq, Eq)]
 pub struct ShutdownScript(ShutdownScriptImpl);
 
 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
-#[derive(Debug)]
+#[derive(Clone, Debug)]
 pub struct InvalidShutdownScript {
 	/// The script that did not meet the requirements from [BOLT #2].
 	///
-	/// [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
+	/// [BOLT #2]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md
 	pub script: Script
 }
 
+#[derive(Clone, PartialEq, Eq)]
 enum ShutdownScriptImpl {
 	/// [`PublicKey`] used to form a P2WPKH script pubkey. Used to support backward-compatible
 	/// serialization.
@@ -34,40 +40,54 @@ enum ShutdownScriptImpl {
 	Bolt2(Script),
 }
 
-impl ShutdownScript {
-	/// Generates a P2WPKH script pubkey from the given [`PublicKey`].
-	pub fn new_p2wpkh_from_pubkey(pubkey: PublicKey) -> Self {
-		Self(ShutdownScriptImpl::Legacy(pubkey))
+impl Writeable for ShutdownScript {
+	fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
+		self.0.write(w)
 	}
 
-	/// Generates a P2PKH script pubkey from the given [`PubkeyHash`].
-	pub fn new_p2pkh(pubkey_hash: &PubkeyHash) -> Self {
-		Self(ShutdownScriptImpl::Bolt2(Script::new_p2pkh(pubkey_hash)))
+	fn serialized_length(&self) -> usize {
+		self.0.serialized_length()
 	}
+}
 
-	/// Generates a P2SH script pubkey from the given [`ScriptHash`].
-	pub fn new_p2sh(script_hash: &ScriptHash) -> Self {
-		Self(ShutdownScriptImpl::Bolt2(Script::new_p2sh(script_hash)))
+impl Readable for ShutdownScript {
+	fn read<R: io::Read>(r: &mut R) -> Result<Self, DecodeError> {
+		Ok(ShutdownScript(ShutdownScriptImpl::read(r)?))
+	}
+}
+
+impl_writeable_tlv_based_enum!(ShutdownScriptImpl, ;
+	(0, Legacy),
+	(1, Bolt2),
+);
+
+impl ShutdownScript {
+	/// Generates a P2WPKH script pubkey from the given [`PublicKey`].
+	pub(crate) fn new_p2wpkh_from_pubkey(pubkey: PublicKey) -> Self {
+		Self(ShutdownScriptImpl::Legacy(pubkey))
 	}
 
 	/// Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
 	pub fn new_p2wpkh(pubkey_hash: &WPubkeyHash) -> Self {
-		Self(ShutdownScriptImpl::Bolt2(Script::new_v0_wpkh(pubkey_hash)))
+		Self(ShutdownScriptImpl::Bolt2(Script::new_v0_p2wpkh(pubkey_hash)))
 	}
 
 	/// Generates a P2WSH script pubkey from the given [`WScriptHash`].
 	pub fn new_p2wsh(script_hash: &WScriptHash) -> Self {
-		Self(ShutdownScriptImpl::Bolt2(Script::new_v0_wsh(script_hash)))
+		Self(ShutdownScriptImpl::Bolt2(Script::new_v0_p2wsh(script_hash)))
 	}
 
-	/// Generates a P2WSH script pubkey from the given segwit version and program.
+	/// Generates a witness script pubkey from the given segwit version and program.
+	///
+	/// Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
+	/// [`ShutdownScript::new_p2wsh`] instead.
 	///
 	/// # Errors
 	///
 	/// This function may return an error if `program` is invalid for the segwit `version`.
-	pub fn new_witness_program(version: NonZeroU8, program: &[u8]) -> Result<Self, InvalidShutdownScript> {
+	pub fn new_witness_program(version: WitnessVersion, program: &[u8]) -> Result<Self, InvalidShutdownScript> {
 		let script = Builder::new()
-			.push_int(version.get().into())
+			.push_int(version as i64)
 			.push_slice(&program)
 			.into_script();
 		Self::try_from(script)
@@ -97,29 +117,35 @@ impl ShutdownScript {
 	}
 }
 
-fn is_bolt2_compliant(script: &Script, features: &InitFeatures) -> bool {
+/// Check if a given script is compliant with BOLT 2's shutdown script requirements for the given
+/// counterparty features.
+pub(crate) fn is_bolt2_compliant(script: &Script, features: &InitFeatures) -> bool {
 	if script.is_p2pkh() || script.is_p2sh() || script.is_v0_p2wpkh() || script.is_v0_p2wsh() {
 		true
 	} else if features.supports_shutdown_anysegwit() {
-		script.is_witness_program() && script.as_bytes()[0] != SEGWIT_V0.into_u8()
+		script.is_witness_program() && script.as_bytes()[0] != SEGWIT_V0.to_u8()
 	} else {
 		false
 	}
 }
 
+// Note that this is only for our own shutdown scripts. Counterparties are still allowed to send us
+// non-witness shutdown scripts which this rejects.
 impl TryFrom<Script> for ShutdownScript {
 	type Error = InvalidShutdownScript;
 
 	fn try_from(script: Script) -> Result<Self, Self::Error> {
-		Self::try_from((script, &InitFeatures::known()))
+		Self::try_from((script, &channelmanager::provided_init_features(&crate::util::config::UserConfig::default())))
 	}
 }
 
+// Note that this is only for our own shutdown scripts. Counterparties are still allowed to send us
+// non-witness shutdown scripts which this rejects.
 impl TryFrom<(Script, &InitFeatures)> for ShutdownScript {
 	type Error = InvalidShutdownScript;
 
 	fn try_from((script, features): (Script, &InitFeatures)) -> Result<Self, Self::Error> {
-		if is_bolt2_compliant(&script, features) {
+		if is_bolt2_compliant(&script, features) && script.is_witness_program() {
 			Ok(Self(ShutdownScriptImpl::Bolt2(script)))
 		} else {
 			Err(InvalidShutdownScript { script })
@@ -131,28 +157,36 @@ impl Into<Script> for ShutdownScript {
 	fn into(self) -> Script {
 		match self.0 {
 			ShutdownScriptImpl::Legacy(pubkey) =>
-				Script::new_v0_wpkh(&WPubkeyHash::hash(&pubkey.serialize())),
+				Script::new_v0_p2wpkh(&WPubkeyHash::hash(&pubkey.serialize())),
 			ShutdownScriptImpl::Bolt2(script_pubkey) => script_pubkey,
 		}
 	}
 }
 
+impl core::fmt::Display for ShutdownScript{
+	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
+		match &self.0 {
+			ShutdownScriptImpl::Legacy(_) => self.clone().into_inner().fmt(f),
+			ShutdownScriptImpl::Bolt2(script) => script.fmt(f),
+		}
+	}
+}
+
 #[cfg(test)]
 mod shutdown_script_tests {
 	use super::ShutdownScript;
-	use bitcoin::bech32::u5;
 	use bitcoin::blockdata::opcodes;
 	use bitcoin::blockdata::script::{Builder, Script};
 	use bitcoin::secp256k1::Secp256k1;
-	use bitcoin::secp256k1::key::{PublicKey, SecretKey};
-	use ln::features::InitFeatures;
+	use bitcoin::secp256k1::{PublicKey, SecretKey};
+	use crate::ln::features::InitFeatures;
 	use core::convert::TryFrom;
-	use core::num::NonZeroU8;
+	use bitcoin::util::address::WitnessVersion;
 
-	fn pubkey() -> bitcoin::util::ecdsa::PublicKey {
+	fn pubkey() -> bitcoin::util::key::PublicKey {
 		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, 0, 0, 1]).unwrap();
-		bitcoin::util::ecdsa::PublicKey::new(PublicKey::from_secret_key(&secp_ctx, &secret_key))
+		bitcoin::util::key::PublicKey::new(PublicKey::from_secret_key(&secp_ctx, &secret_key))
 	}
 
 	fn redeem_script() -> Script {
@@ -166,50 +200,32 @@ mod shutdown_script_tests {
 			.into_script()
 	}
 
+	fn any_segwit_features() -> InitFeatures {
+		let mut features = InitFeatures::empty();
+		features.set_shutdown_any_segwit_optional();
+		features
+	}
+
 	#[test]
 	fn generates_p2wpkh_from_pubkey() {
 		let pubkey = pubkey();
 		let pubkey_hash = pubkey.wpubkey_hash().unwrap();
-		let p2wpkh_script = Script::new_v0_wpkh(&pubkey_hash);
+		let p2wpkh_script = Script::new_v0_p2wpkh(&pubkey_hash);
 
-		let shutdown_script = ShutdownScript::new_p2wpkh_from_pubkey(pubkey.key);
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+		let shutdown_script = ShutdownScript::new_p2wpkh_from_pubkey(pubkey.inner);
+		assert!(shutdown_script.is_compatible(&any_segwit_features()));
+		assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
 		assert_eq!(shutdown_script.into_inner(), p2wpkh_script);
 	}
 
-	#[test]
-	fn generates_p2pkh_from_pubkey_hash() {
-		let pubkey_hash = pubkey().pubkey_hash();
-		let p2pkh_script = Script::new_p2pkh(&pubkey_hash);
-
-		let shutdown_script = ShutdownScript::new_p2pkh(&pubkey_hash);
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
-		assert_eq!(shutdown_script.into_inner(), p2pkh_script);
-		assert!(ShutdownScript::try_from(p2pkh_script).is_ok());
-	}
-
-	#[test]
-	fn generates_p2sh_from_script_hash() {
-		let script_hash = redeem_script().script_hash();
-		let p2sh_script = Script::new_p2sh(&script_hash);
-
-		let shutdown_script = ShutdownScript::new_p2sh(&script_hash);
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
-		assert_eq!(shutdown_script.into_inner(), p2sh_script);
-		assert!(ShutdownScript::try_from(p2sh_script).is_ok());
-	}
-
 	#[test]
 	fn generates_p2wpkh_from_pubkey_hash() {
 		let pubkey_hash = pubkey().wpubkey_hash().unwrap();
-		let p2wpkh_script = Script::new_v0_wpkh(&pubkey_hash);
+		let p2wpkh_script = Script::new_v0_p2wpkh(&pubkey_hash);
 
 		let shutdown_script = ShutdownScript::new_p2wpkh(&pubkey_hash);
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+		assert!(shutdown_script.is_compatible(&any_segwit_features()));
+		assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
 		assert_eq!(shutdown_script.into_inner(), p2wpkh_script);
 		assert!(ShutdownScript::try_from(p2wpkh_script).is_ok());
 	}
@@ -217,24 +233,21 @@ mod shutdown_script_tests {
 	#[test]
 	fn generates_p2wsh_from_script_hash() {
 		let script_hash = redeem_script().wscript_hash();
-		let p2wsh_script = Script::new_v0_wsh(&script_hash);
+		let p2wsh_script = Script::new_v0_p2wsh(&script_hash);
 
 		let shutdown_script = ShutdownScript::new_p2wsh(&script_hash);
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+		assert!(shutdown_script.is_compatible(&any_segwit_features()));
+		assert!(shutdown_script.is_compatible(&InitFeatures::empty()));
 		assert_eq!(shutdown_script.into_inner(), p2wsh_script);
 		assert!(ShutdownScript::try_from(p2wsh_script).is_ok());
 	}
 
 	#[test]
 	fn generates_segwit_from_non_v0_witness_program() {
-		let version = u5::try_from_u8(16).unwrap();
-		let witness_program = Script::new_witness_program(version, &[0; 40]);
-
-		let version = NonZeroU8::new(version.to_u8()).unwrap();
-		let shutdown_script = ShutdownScript::new_witness_program(version, &[0; 40]).unwrap();
-		assert!(shutdown_script.is_compatible(&InitFeatures::known()));
-		assert!(!shutdown_script.is_compatible(&InitFeatures::known().clear_shutdown_anysegwit()));
+		let witness_program = Script::new_witness_program(WitnessVersion::V16, &[0; 40]);
+		let shutdown_script = ShutdownScript::new_witness_program(WitnessVersion::V16, &[0; 40]).unwrap();
+		assert!(shutdown_script.is_compatible(&any_segwit_features()));
+		assert!(!shutdown_script.is_compatible(&InitFeatures::empty()));
 		assert_eq!(shutdown_script.into_inner(), witness_program);
 	}
 
@@ -244,25 +257,17 @@ mod shutdown_script_tests {
 		assert!(ShutdownScript::try_from(op_return).is_err());
 	}
 
-	#[test]
-	fn fails_from_invalid_segwit_version() {
-		let version = NonZeroU8::new(17).unwrap();
-		assert!(ShutdownScript::new_witness_program(version, &[0; 40]).is_err());
-	}
-
 	#[test]
 	fn fails_from_invalid_segwit_v0_witness_program() {
-		let witness_program = Script::new_witness_program(u5::try_from_u8(0).unwrap(), &[0; 2]);
+		let witness_program = Script::new_witness_program(WitnessVersion::V0, &[0; 2]);
 		assert!(ShutdownScript::try_from(witness_program).is_err());
 	}
 
 	#[test]
 	fn fails_from_invalid_segwit_non_v0_witness_program() {
-		let version = u5::try_from_u8(16).unwrap();
-		let witness_program = Script::new_witness_program(version, &[0; 42]);
+		let witness_program = Script::new_witness_program(WitnessVersion::V16, &[0; 42]);
 		assert!(ShutdownScript::try_from(witness_program).is_err());
 
-		let version = NonZeroU8::new(version.to_u8()).unwrap();
-		assert!(ShutdownScript::new_witness_program(version, &[0; 42]).is_err());
+		assert!(ShutdownScript::new_witness_program(WitnessVersion::V16, &[0; 42]).is_err());
 	}
 }