Remove address() from DescriptorTrait

Now that `Descriptor` no longer implements `DesciptorTrait` we can
remove the `address` method from the trait entirely and rename the
`addr` helper method to `address` for each descriptor.

Author: tcharding

src/descriptor/bare.rs

@@ -139,13 +139,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Bare<Pk> {
         Ok(())
     }
 
-    fn address(&self, _network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        Err(Error::BareDescriptorAddr)
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,
@@ -266,9 +259,8 @@ impl<Pk: MiniscriptKey + ToPublicKey> Pkh<Pk> {
         addr.script_pubkey()
     }
 
-    /// Obtain the corresponding script pubkey for this descriptor
-    /// Non failing verion of [`DescriptorTrait::address`] for this descriptor
-    pub fn addr(&self, network: Network) -> Address {
+    /// Obtains the corresponding script pubkey for this descriptor.
+    pub fn address(&self, network: Network) -> Address {
         Address::p2pkh(&self.pk.to_public_key(), network)
     }
 
@@ -348,13 +340,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Pkh<Pk> {
         Ok(())
     }
 
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        Ok(self.addr(network))
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,

src/descriptor/mod.rs

@@ -89,14 +89,6 @@ pub trait DescriptorTrait<Pk: MiniscriptKey> {
     /// The signer may not be able to find satisfactions even if one exists
     fn sanity_check(&self) -> Result<(), Error>;
 
-    /// Computes the Bitcoin address of the descriptor, if one exists
-    /// Some descriptors like pk() don't have any address.
-    /// Errors:
-    /// - On raw/bare descriptors that don't have any address
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey;
-
     /// Computes the scriptpubkey of the descriptor
     fn script_pubkey(&self) -> Script
     where
@@ -463,14 +455,19 @@ impl<Pk: MiniscriptKey> Descriptor<Pk> {
 
 impl<Pk: MiniscriptKey + ToPublicKey> Descriptor<Pk> {
     /// Computes the Bitcoin address of the descriptor, if one exists
+    ///
+    /// Some descriptors like pk() don't have any address.
+    ///
+    /// # Errors
+    /// For raw/bare descriptors that don't have any address.
     pub fn address(&self, network: Network) -> Result<Address, Error> {
         match *self {
-            Descriptor::Bare(ref bare) => bare.address(network),
-            Descriptor::Pkh(ref pkh) => pkh.address(network),
-            Descriptor::Wpkh(ref wpkh) => wpkh.address(network),
-            Descriptor::Wsh(ref wsh) => wsh.address(network),
-            Descriptor::Sh(ref sh) => sh.address(network),
-            Descriptor::Tr(ref tr) => tr.address(network),
+            Descriptor::Bare(_) => Err(Error::BareDescriptorAddr),
+            Descriptor::Pkh(ref pkh) => Ok(pkh.address(network)),
+            Descriptor::Wpkh(ref wpkh) => Ok(wpkh.address(network)),
+            Descriptor::Wsh(ref wsh) => Ok(wsh.address(network)),
+            Descriptor::Sh(ref sh) => Ok(sh.address(network)),
+            Descriptor::Tr(ref tr) => Ok(tr.address(network)),
         }
     }
 

src/descriptor/segwitv0.rs

@@ -85,9 +85,8 @@ impl<Pk: MiniscriptKey + ToPublicKey> Wsh<Pk> {
         self.inner_script().to_v0_p2wsh()
     }
 
-    /// Obtain the corresponding script pubkey for this descriptor
-    /// Non failing verion of [`DescriptorTrait::address`] for this descriptor
-    pub fn addr(&self, network: Network) -> Address {
+    /// Obtains the corresponding script pubkey for this descriptor.
+    pub fn address(&self, network: Network) -> Address {
         match self.inner {
             WshInner::SortedMulti(ref smv) => Address::p2wsh(&smv.encode(), network),
             WshInner::Ms(ref ms) => Address::p2wsh(&ms.encode(), network),
@@ -199,13 +198,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Wsh<Pk> {
         Ok(())
     }
 
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        Ok(self.addr(network))
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,
@@ -367,9 +359,8 @@ impl<Pk: MiniscriptKey + ToPublicKey> Wpkh<Pk> {
         addr.script_pubkey()
     }
 
-    /// Obtain the corresponding script pubkey for this descriptor
-    /// Non failing verion of [`DescriptorTrait::address`] for this descriptor
-    pub fn addr(&self, network: Network) -> Address {
+    /// Obtains the corresponding script pubkey for this descriptor.
+    pub fn address(&self, network: Network) -> Address {
         Address::p2wpkh(&self.pk.to_public_key(), network)
             .expect("Rust Miniscript types don't allow uncompressed pks in segwit descriptors")
     }
@@ -461,13 +452,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Wpkh<Pk> {
         }
     }
 
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        Ok(self.addr(network))
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,

src/descriptor/sh.rs

@@ -219,22 +219,21 @@ impl<Pk: MiniscriptKey + ToPublicKey> Sh<Pk> {
         }
     }
 
-    /// Obtain the corresponding script pubkey for this descriptor
-    /// Non failing verion of [`DescriptorTrait::address`] for this descriptor
-    pub fn addr(&self, network: Network) -> Address {
+    /// Obtains the corresponding address for this descriptor.
+    pub fn address(&self, network: Network) -> Address {
+        let addr = self.address_fallible(network);
+
+        // Size is checked in `check_global_consensus_validity`.
+        assert!(addr.is_ok());
+        addr.expect("only fails if size > MAX_SCRIPT_ELEMENT_SIZE")
+    }
+
+    fn address_fallible(&self, network: Network) -> Result<Address, Error> {
         match self.inner {
-            ShInner::Wsh(ref wsh) => {
-                Address::p2sh(&wsh.spk(), network).expect("Size checked in Miniscript")
-            }
-            ShInner::Wpkh(ref wpkh) => {
-                Address::p2sh(&wpkh.spk(), network).expect("Size checked in Miniscript")
-            }
-            ShInner::SortedMulti(ref smv) => {
-                Address::p2sh(&smv.encode(), network).expect("Size checked in Miniscript")
-            }
-            ShInner::Ms(ref ms) => {
-                Address::p2sh(&ms.encode(), network).expect("Size checked in Miniscript")
-            }
+            ShInner::Wsh(ref wsh) => Ok(Address::p2sh(&wsh.script_pubkey(), network)?),
+            ShInner::Wpkh(ref wpkh) => Ok(Address::p2sh(&wpkh.script_pubkey(), network)?),
+            ShInner::SortedMulti(ref smv) => Ok(Address::p2sh(&smv.encode(), network)?),
+            ShInner::Ms(ref ms) => Ok(Address::p2sh(&ms.encode(), network)?),
         }
     }
 
@@ -275,18 +274,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Sh<Pk> {
         Ok(())
     }
 
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        match self.inner {
-            ShInner::Wsh(ref wsh) => Ok(Address::p2sh(&wsh.spk(), network)?),
-            ShInner::Wpkh(ref wpkh) => Ok(Address::p2sh(&wpkh.spk(), network)?),
-            ShInner::SortedMulti(ref smv) => Ok(Address::p2sh(&smv.encode(), network)?),
-            ShInner::Ms(ref ms) => Ok(Address::p2sh(&ms.encode(), network)?),
-        }
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,

src/descriptor/tr.rs

@@ -285,11 +285,10 @@ impl<Pk: MiniscriptKey + ToPublicKey> Tr<Pk> {
             .into_script()
     }
 
-    /// Obtain the corresponding script pubkey for this descriptor
-    /// Same as[`DescriptorTrait::address`] for this descriptor
-    pub fn addr(&self, network: Network) -> Result<Address, Error> {
+    /// Obtains the corresponding address for this descriptor.
+    pub fn address(&self, network: Network) -> Address {
         let spend_info = self.spend_info();
-        Ok(Address::p2tr_tweaked(spend_info.output_key(), network))
+        Address::p2tr_tweaked(spend_info.output_key(), network)
     }
 }
 
@@ -560,13 +559,6 @@ impl<Pk: MiniscriptKey> DescriptorTrait<Pk> for Tr<Pk> {
         Ok(())
     }
 
-    fn address(&self, network: Network) -> Result<Address, Error>
-    where
-        Pk: ToPublicKey,
-    {
-        self.addr(network)
-    }
-
     fn script_pubkey(&self) -> Script
     where
         Pk: ToPublicKey,