Add ScriptPubKey model, error and into_model

ScriptPubKey has fields that can be modeled with rust-bitcoin types.

Add a model, an into_model function and error.

Author: jamillambert

types/src/lib.rs

@@ -42,6 +42,8 @@ use bitcoin::hex::{self, FromHex as _};
 use bitcoin::{Amount, FeeRate, ScriptBuf, Witness};
 use serde::{Deserialize, Serialize};
 
+use crate::error::write_err;
+
 /// Converts an `i64` numeric type to a `u32`.
 ///
 /// The Bitcoin Core JSONRPC API has fields marked as 'numeric'. It is not obvious what Rust
@@ -191,7 +193,7 @@ pub struct ScriptPubkey {
     pub hex: String,
     /// Number of required signatures - deprecated in Core v22.
     ///
-    /// Only returned before in versions prior to 22 or for version 22 onwards if
+    /// Only returned in versions prior to 22 or for version 22 onwards if
     /// config option `-deprecatedrpc=addresses` is passed.
     #[serde(rename = "reqSigs")]
     pub required_signatures: Option<i64>,
@@ -202,11 +204,45 @@ pub struct ScriptPubkey {
     pub address: Option<String>,
     /// Array of bitcoin addresses - deprecated in Core v22.
     ///
-    /// Only returned before in versions prior to 22 or for version 22 onwards if
+    /// Only returned in versions prior to 22 or for version 22 onwards if
     /// config option `-deprecatedrpc=addresses` is passed.
     pub addresses: Option<Vec<String>>,
 }
 
+/// Error when converting a `ScriptPubkey` type into the model type.
+#[derive(Debug)]
+pub enum ScriptPubkeyError {
+    /// Conversion of the `hex` field failed.
+    Hex(hex::HexToBytesError),
+    /// Conversion of the `address` field failed.
+    Address(address::ParseError),
+    /// Conversion of the `addresses` field failed.
+    Addresses(address::ParseError),
+}
+
+impl fmt::Display for ScriptPubkeyError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use ScriptPubkeyError::*;
+        match *self {
+            Hex(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
+            Address(ref e) => write_err!(f, "conversion of the `address` field failed"; e),
+            Addresses(ref e) => write_err!(f, "conversion of the `addresses` field failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for ScriptPubkeyError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use ScriptPubkeyError::*;
+        match *self {
+            Hex(ref e) => Some(e),
+            Address(ref e) => Some(e),
+            Addresses(ref e) => Some(e),
+        }
+    }
+}
+
 impl ScriptPubkey {
     fn script_buf(&self) -> Result<ScriptBuf, hex::HexToBytesError> {
         ScriptBuf::from_hex(&self.hex)
@@ -215,6 +251,32 @@ impl ScriptPubkey {
     fn address(&self) -> Option<Result<Address<NetworkUnchecked>, address::ParseError>> {
         self.address.as_ref().map(|addr| addr.parse::<Address<_>>())
     }
+
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::ScriptPubkey, ScriptPubkeyError> {
+        use ScriptPubkeyError as E;
+
+        let script_pubkey = ScriptBuf::from_hex(&self.hex).map_err(E::Hex)?;
+
+        let address =
+            self.address.map(|s| s.parse::<Address<_>>().map_err(E::Address)).transpose()?;
+
+        let addresses = self
+            .addresses
+            .map(|v| {
+                v.into_iter()
+                    .map(|s| s.parse::<Address<_>>().map_err(E::Addresses))
+                    .collect::<Result<Vec<_>, _>>()
+            })
+            .transpose()?;
+
+        Ok(model::ScriptPubkey {
+            script_pubkey,
+            required_signatures: self.required_signatures,
+            address,
+            addresses,
+        })
+    }
 }
 
 /// Data returned by Core for a script signature.

types/src/model/mod.rs

@@ -18,6 +18,10 @@ mod util;
 mod wallet;
 mod zmq;
 
+use bitcoin::address::NetworkUnchecked;
+use bitcoin::{Address, ScriptBuf};
+use serde::{Deserialize, Serialize};
+
 #[doc(inline)]
 pub use self::{
     blockchain::{
@@ -65,3 +69,26 @@ pub use self::{
         UnloadWallet, WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt,
     },
 };
+
+/// Models the data returned by Core for a scriptPubKey.
+///
+/// This is used by methods in the blockchain section and in the raw transaction section (i.e raw
+/// transaction and psbt methods).
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
+pub struct ScriptPubkey {
+    /// The script_pubkey parsed from hex.
+    pub script_pubkey: ScriptBuf,
+    /// Number of required signatures - deprecated in Core v22.
+    ///
+    /// Only returned in versions prior to 22 or for version 22 onwards if
+    /// config option `-deprecatedrpc=addresses` is passed.
+    pub required_signatures: Option<i64>,
+    /// Bitcoin address (only if a well-defined address exists).
+    pub address: Option<Address<NetworkUnchecked>>,
+    /// Array of bitcoin addresses - deprecated in Core v22.
+    ///
+    /// Only returned in versions prior to 22 or for version 22 onwards if
+    /// config option `-deprecatedrpc=addresses` is passed.
+    pub addresses: Option<Vec<Address<NetworkUnchecked>>>,
+}