Add DecodeScriptSegwit into_model to v17 and refactor error handling

- Add `into_model` implementation for `DecodeScriptSegwit` in v17.
- Return `segwit` in v17, as it is present in RPC output despite not being documented until v19.
- Add `DecodeScriptSegwitError` enum in v17, as `address` is sometimes `None` and error handling is needed.
- Remove duplicate `DecodeScriptSegwitError` from v23 and reuse the one from v22 via import.
- Move `descriptor` field in `DecodeScriptSegwit` model struct to match the field order in Bitcoin Core's `decodescript` RPC response.

Author: +Sharon

types/src/model/raw_transactions.rs

@@ -129,8 +129,6 @@ pub struct DecodeScriptSegwit {
     pub asm: String,
     /// The raw output script bytes, hex-encoded.
     pub hex: ScriptBuf,
-    /// Inferred descriptor for the script. v23 and later only.
-    pub descriptor: Option<String>,
     /// The output type (e.g. nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown).
     pub type_: String,
     /// Bitcoin address (only if a well-defined address exists)v22 and later only.
@@ -139,6 +137,8 @@ pub struct DecodeScriptSegwit {
     pub required_signatures: Option<u64>,
     /// List of bitcoin addresses.
     pub addresses: Vec<Address<NetworkUnchecked>>,
+    /// Inferred descriptor for the script. v23 and later only.
+    pub descriptor: Option<String>,
     /// Address of the P2SH script wrapping this witness redeem script.
     pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }

types/src/v17/raw_transactions/error.rs

@@ -178,6 +178,8 @@ pub enum DecodeScriptError {
     Addresses(address::ParseError),
     /// Conversion of the transaction `p2sh` field failed.
     P2sh(address::ParseError),
+    /// Conversion of the transaction `segwit` field failed.
+    Segwit(DecodeScriptSegwitError),
 }
 
 impl fmt::Display for DecodeScriptError {
@@ -188,6 +190,7 @@ impl fmt::Display for DecodeScriptError {
             E::Hex(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
             E::Addresses(ref e) => write_err!(f, "conversion of the `addresses` field failed"; e),
             E::P2sh(ref e) => write_err!(f, "conversion of the `p2sh` field failed"; e),
+            E::Segwit(ref e) => write_err!(f, "conversion of the `segwit` field failed"; e),
         }
     }
 }
@@ -201,6 +204,34 @@ impl std::error::Error for DecodeScriptError {
             E::Hex(ref e) => Some(e),
             E::Addresses(ref e) => Some(e),
             E::P2sh(ref e) => Some(e),
+            E::Segwit(ref e) => Some(e),
+        }
+    }
+}
+
+/// Error when converting a `DecodeScriptSegwit` type into the model type.
+#[derive(Debug)]
+pub enum DecodeScriptSegwitError {
+    /// Conversion of the transaction `addresses` field failed.
+    Addresses(address::ParseError),
+}
+
+impl fmt::Display for DecodeScriptSegwitError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use DecodeScriptSegwitError as E;
+        match *self {
+            E::Addresses(ref e) =>
+                write_err!(f, "conversion of the `addresses` field in `segwit` failed"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for DecodeScriptSegwitError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use DecodeScriptSegwitError as E;
+        match *self {
+            E::Addresses(ref e) => Some(e),
         }
     }
 }

types/src/v17/raw_transactions/into.rs

@@ -14,7 +14,8 @@ use super::{
     FinalizePsbt, FinalizePsbtError, FundRawTransaction, FundRawTransactionError,
     GetRawTransaction, GetRawTransactionVerbose, GetRawTransactionVerboseError, MempoolAcceptance,
     PsbtInput, PsbtInputError, PsbtOutput, PsbtOutputError, SendRawTransaction, SignFail,
-    SignFailError, SignRawTransaction, SignRawTransactionError, TestMempoolAccept,
+    SignFailError, SignRawTransaction, SignRawTransactionError, TestMempoolAccept,DecodeScriptSegwit,
+    DecodeScriptSegwitError,
 };
 use crate::model;
 use crate::psbt::RawTransactionError;
@@ -310,7 +311,38 @@ impl DecodeScript {
             addresses,
             p2sh,
             p2sh_segwit: self.p2sh_segwit,
-            segwit: None,
+            segwit: self.segwit.map(|s| s.into_model()).transpose().map_err(E::Segwit)?,
+        })
+    }
+}
+
+impl DecodeScriptSegwit {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::DecodeScriptSegwit, DecodeScriptSegwitError> {
+        use DecodeScriptSegwitError as E;
+
+        // Convert `Option<Vec<String>>` to `Vec<Address<NetworkUnchecked>>`
+        let addresses = match self.addresses {
+            Some(addrs) => addrs
+                .into_iter()
+                .map(|s| s.parse::<Address<_>>())
+                .collect::<Result<_, _>>()
+                .map_err(E::Addresses)?,
+            None => vec![],
+        };
+
+        let required_signatures = self.required_signatures;
+        let p2sh_segwit = self.p2sh_segwit;
+
+        Ok(model::DecodeScriptSegwit {
+            asm: self.asm,
+            hex: self.hex,
+            descriptor: None,
+            address:None,
+            type_: self.type_,
+            required_signatures,
+            addresses,
+            p2sh_segwit,
         })
     }
 }

types/src/v17/raw_transactions/mod.rs

@@ -19,6 +19,7 @@ use crate::ScriptSig;
 pub use self::error::{
     DecodePsbtError, DecodeScriptError, FundRawTransactionError, GetRawTransactionVerboseError,
     PsbtInputError, PsbtOutputError, SignFailError, SignRawTransactionError, FinalizePsbtError,
+    DecodeScriptSegwitError,
 };
 // Re-export types that appear in the public API of this module.
 pub use crate::psbt::{
@@ -215,11 +216,11 @@ pub struct DecodeRawTransaction(pub RawTransaction);
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScript {
-    /// Disassembly of the script.
+    /// Script public key.
     pub asm: String,
-    /// The raw output script bytes, hex-encoded.
+    /// Hex encoded public key.
     pub hex: Option<String>,
-    /// The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash).
+    /// The output type.
     #[serde(rename = "type")]
     pub type_: String,
     /// The required signatures.
@@ -255,7 +256,7 @@ pub struct DecodeScriptSegwit {
     pub addresses: Option<Vec<String>>,
     /// Address of the P2SH script wrapping this witness redeem script.
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segtwit: Option<Address<NetworkUnchecked>>,
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }
 
 /// Result of JSON-RPC method `finalizepsbt`.

types/src/v22/raw_transactions/error.rs

@@ -15,10 +15,10 @@ pub enum DecodeScriptError {
     Address(address::ParseError),
     /// Conversion of the transaction `addresses` field failed.
     Addresses(address::ParseError),
-    /// Conversion of the transaction `segwit` field failed.
-    Segwit(DecodeScriptSegwitError),
     /// Conversion of the transaction `p2sh` field failed.
     P2sh(address::ParseError),
+    /// Conversion of the transaction `segwit` field failed.
+    Segwit(DecodeScriptSegwitError),
 }
 
 impl fmt::Display for DecodeScriptError {
@@ -29,8 +29,8 @@ impl fmt::Display for DecodeScriptError {
             E::Hex(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
             E::Address(ref e) => write_err!(f, "conversion of the `address` field failed"; e),
             E::Addresses(ref e) => write_err!(f, "conversion of the `addresses` field failed"; e),
-            E::Segwit(ref e) => write_err!(f, "conversion of the `segwit` field failed"; e),
             E::P2sh(ref e) => write_err!(f, "conversion of the `p2sh` field failed"; e),
+            E::Segwit(ref e) => write_err!(f, "conversion of the `segwit` field failed"; e),
         }
     }
 }
@@ -44,8 +44,8 @@ impl std::error::Error for DecodeScriptError {
             E::Hex(ref e) => Some(e),
             E::Address(ref e) => Some(e),
             E::Addresses(ref e) => Some(e),
-            E::Segwit(ref e) => Some(e),
             E::P2sh(ref e) => Some(e),
+            E::Segwit(ref e) => Some(e),
         }
     }
 }

types/src/v22/raw_transactions/mod.rs

@@ -25,9 +25,9 @@ pub use self::error::{DecodeScriptError, DecodeScriptSegwitError};
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScript {
-    /// Disassembly of the script.
+    /// Script public key.
     pub asm: String,
-    /// The output type (e.g. nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown).
+    /// The output type 
     #[serde(rename = "type")]
     pub type_: String,
     /// Bitcoin address (only if a well-defined address exists). v22 and later only.

types/src/v23/mod.rs

@@ -250,7 +250,7 @@ pub use self::{
     network::GetPeerInfo,
     raw_transactions::{
         DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, DecodeScriptSegwit,
-        DecodeScriptSegwitError, GlobalXpub, Proprietary, PsbtInput, PsbtOutput,
+         GlobalXpub, Proprietary, PsbtInput, PsbtOutput,
     },
     util::CreateMultisig,
     wallet::{GetTransaction, GetTransactionError},
@@ -310,5 +310,5 @@ pub use crate::{
         ImportDescriptors, ImportDescriptorsResult, PsbtBumpFee, PsbtBumpFeeError, Send, SendError,
         UnloadWallet, UpgradeWallet,
     },
-    v22::{Banned, GetMempoolInfo, ListBanned, ScriptPubkey},
+    v22::{Banned, GetMempoolInfo, ListBanned, ScriptPubkey,},
 };

types/src/v23/raw_transactions/error.rs

@@ -6,6 +6,7 @@ use bitcoin::{address, bip32, hex, sighash};
 
 use crate::error::write_err;
 use crate::v17::{Bip32DerivError, PartialSignatureError, RawTransactionError, WitnessUtxoError};
+use crate::v22::DecodeScriptSegwitError;
 
 /// Error when converting a `DecodePsbt` type into the model type.
 #[derive(Debug)]
@@ -298,36 +299,4 @@ impl std::error::Error for DecodeScriptError {
             E::P2sh(ref e) => Some(e),
         }
     }
-}
-
-/// Error when converting a `DecodeScriptSegwit` type into the model type.
-#[derive(Debug)]
-pub enum DecodeScriptSegwitError {
-    /// Conversion of the transaction `address` field failed.
-    Address(address::ParseError),
-    /// Conversion of the transaction `addresses` field failed.
-    Addresses(address::ParseError),
-}
-
-impl fmt::Display for DecodeScriptSegwitError {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        use DecodeScriptSegwitError as E;
-        match *self {
-            E::Address(ref e) =>
-                write_err!(f, "conversion of the `address` field in `segwit` failed"; e),
-            E::Addresses(ref e) =>
-                write_err!(f, "conversion of the `addresses` field in `segwit` failed"; e),
-        }
-    }
-}
-
-#[cfg(feature = "std")]
-impl std::error::Error for DecodeScriptSegwitError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        use DecodeScriptSegwitError as E;
-        match *self {
-            E::Address(ref e) => Some(e),
-            E::Addresses(ref e) => Some(e),
-        }
-    }
-}
+}

types/src/v23/raw_transactions/mod.rs

@@ -16,9 +16,10 @@ use serde::{Deserialize, Serialize};
 use crate::ScriptSig;
 
 #[rustfmt::skip]                // Keep public re-exports separate.
-pub use self::error::{DecodePsbtError, DecodeScriptError, GlobalXpubError, PsbtInputError, PsbtOutputError,DecodeScriptSegwitError};
+pub use self::error::{DecodePsbtError, DecodeScriptError, GlobalXpubError, PsbtInputError, PsbtOutputError};
 // Re-export types that appear in the public API of this module.
 pub use crate::psbt::{Bip32Deriv, PsbtScript, RawTransaction, WitnessUtxo};
+pub use crate::v22::DecodeScriptSegwitError;
 
 /// Result of JSON-RPC method `decodepsbt`.
 ///
@@ -141,12 +142,12 @@ pub struct PsbtOutput {
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScript {
-    /// Disassembly of the script.
+    /// Script public key.
     pub asm: String,
     /// Inferred descriptor for the script. v23 and later only.
     #[serde(rename = "desc")]
     pub descriptor: Option<String>,
-    /// The output type (e.g. nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown).
+    /// The output type 
     #[serde(rename = "type")]
     pub type_: String,
     /// Bitcoin address (only if a well-defined address exists). v22 and later only.