Merge rust-bitcoin#2810: Add an AddressData type

ea61e9f Add an AddressData type (Tobin C. Harding)

Pull request description:

  This is a backport of the first patch (excluding api file changes) of rust-bitcoin#2808.

  ----

  In the 0.32.0 release we removed the `address::Payload` struct because it was deemed an implementation detail. As a byproduct of doing so we made it impossible for users to match on an enum and get the address payload (or data).

  - Add a public `AddressData` enum that holds an address' encoded data.
  - Add a conversion function to `Address` that returns the data enum.

ACKs for top commit:
  apoelstra:
    ACK ea61e9f

Tree-SHA512: 13ffd4dac6a6f58cd99f280301fed9188d70a411ada6eb3e3dff25570d66a047568a6035a5e02c2b8e9d59cf4f4deae531b521e99a6bdf3fcad325febc280e2f

Author: apoelstra

bitcoin/src/address/mod.rs

@@ -235,6 +235,30 @@ impl From<Network> for KnownHrp {
     fn from(n: Network) -> Self { Self::from_network(n) }
 }
 
+/// The data encoded by an `Address`.
+///
+/// This is the data used to encumber an output that pays to this address i.e., it is the address
+/// excluding the network information.
+#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[non_exhaustive]
+pub enum AddressData {
+    /// Data encoded by a P2PKH address.
+    P2pkh {
+        /// The pubkey hash used to encumber outputs to this address.
+        pubkey_hash: PubkeyHash
+    },
+    /// Data encoded by a P2SH address.
+    P2sh {
+        /// The script hash used to encumber outputs to this address.
+        script_hash: ScriptHash
+    },
+    /// Data encoded by a Segwit address.
+    Segwit {
+        /// The witness program used to encumber outputs to this address.
+        witness_program: WitnessProgram
+    },
+}
+
 /// A Bitcoin address.
 ///
 /// ### Parsing addresses
@@ -475,6 +499,17 @@ impl Address {
         }
     }
 
+    /// Gets the address data from this address.
+    pub fn to_address_data(&self) -> AddressData {
+        use AddressData::*;
+
+        match self.0 {
+            AddressInner::P2pkh { hash, network: _ } => P2pkh { pubkey_hash: hash },
+            AddressInner::P2sh { hash, network: _ } => P2sh { script_hash: hash },
+            AddressInner::Segwit { program, hrp: _ } => Segwit { witness_program: program },
+        }
+    }
+
     /// Gets the pubkey hash for this address if this is a P2PKH address.
     pub fn pubkey_hash(&self) -> Option<PubkeyHash> {
         use AddressInner::*;