Support all shutdown scripts defined in BOLT 2
[rust-lightning] / lightning / src / ln / script.rs
index 589c3f311936c7885e1363c96b42055465f09991..a01866de679e8762bce76b9fe3a7df4fe666b301 100644 (file)
@@ -8,19 +8,24 @@ use bitcoin::hash_types::{PubkeyHash, ScriptHash, WPubkeyHash, WScriptHash};
 use bitcoin::secp256k1::key::PublicKey;
 
 use ln::features::InitFeatures;
+use ln::msgs::DecodeError;
+use util::ser::{Readable, Writeable, Writer};
 
 use std::convert::TryFrom;
+use std::io::Read;
 use core::num::NonZeroU8;
 
 /// 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
+#[derive(Clone)]
 pub struct ShutdownScript(ShutdownScriptImpl);
 
 /// An error occurring when converting from [`Script`] to [`ShutdownScript`].
 #[derive(Debug)]
 pub struct InvalidShutdownScript(Script);
 
+#[derive(Clone)]
 enum ShutdownScriptImpl {
        /// [`PublicKey`] used to form a P2WPKH script pubkey. Used to support backward-compatible
        /// serialization.
@@ -30,9 +35,30 @@ enum ShutdownScriptImpl {
        Bolt2(Script),
 }
 
+impl Writeable for ShutdownScript {
+       fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
+               self.0.write(w)
+       }
+
+       fn serialized_length(&self) -> usize {
+               self.0.serialized_length()
+       }
+}
+
+impl Readable for ShutdownScript {
+       fn read<R: 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 fn new_p2wpkh_from_pubkey(pubkey: PublicKey) -> Self {
+       pub(crate) fn new_p2wpkh_from_pubkey(pubkey: PublicKey) -> Self {
                Self(ShutdownScriptImpl::Legacy(pubkey))
        }
 
@@ -71,6 +97,14 @@ impl ShutdownScript {
        pub fn into_inner(self) -> Script {
                self.into()
        }
+
+       /// Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
+       pub fn as_legacy_pubkey(&self) -> Option<&PublicKey> {
+               match &self.0 {
+                       ShutdownScriptImpl::Legacy(pubkey) => Some(pubkey),
+                       ShutdownScriptImpl::Bolt2(_) => None,
+               }
+       }
 }
 
 impl TryFrom<Script> for ShutdownScript {