Add DecodeScriptSegwit struct, conversions, and model support

- Add `DecodeScriptSegwit` struct to both versioned and model representations.
- Implement `into_model()` for `DecodeScriptSegwit` and update `DecodeScript` accordingly.
- Use `ScriptBuf` instead of `String` for `hex` to strongly type the field.
- Replace `String` with `Address<NetworkUnchecked>` for `p2sh_segwit` and other fields.
- Normalize and correct field comments to match Core `decodescript` RPC output.
-  Clean up formatting errors

Author: +Sharon

types/src/model/mod.rs

@@ -41,10 +41,10 @@ pub use self::{
     raw_transactions::{
         AnalyzePsbt, AnalyzePsbtInput, AnalyzePsbtInputMissing, CombinePsbt, CombineRawTransaction,
         ConvertToPsbt, CreatePsbt, CreateRawTransaction, DecodePsbt, DecodeRawTransaction,
-        DecodeScript,DecodeScriptSegwit, DescriptorProcessPsbt, FinalizePsbt, FundRawTransaction, GetRawTransaction,
-        GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance, SendRawTransaction, SignFail,
-        SignRawTransaction, SubmitPackage, SubmitPackageTxResult, SubmitPackageTxResultFees,
-        TestMempoolAccept, UtxoUpdatePsbt,
+        DecodeScript, DecodeScriptSegwit, DescriptorProcessPsbt, FinalizePsbt, FundRawTransaction,
+        GetRawTransaction, GetRawTransactionVerbose, JoinPsbts, MempoolAcceptance,
+        SendRawTransaction, SignFail, SignRawTransaction, SubmitPackage, SubmitPackageTxResult,
+        SubmitPackageTxResultFees, TestMempoolAccept, UtxoUpdatePsbt,
     },
     util::{
         CreateMultisig, DeriveAddresses, EstimateSmartFee, SignMessageWithPrivKey, ValidateAddress,

types/src/model/raw_transactions.rs

@@ -116,30 +116,31 @@ pub struct DecodeScript {
     pub addresses: Vec<Address<NetworkUnchecked>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     pub p2sh: Option<Address<NetworkUnchecked>>,
-    /// Segwit data (see `DecodeScriptSegwit` for explanation).
+    /// Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped).
     pub segwit: Option<DecodeScriptSegwit>,
-    /// Address of the P2SH script wrapping this witness redeem script
-    pub p2sh_segwit: Option<String>,
-    
+    /// Address of the P2SH script wrapping this witness redeem script.
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }
 /// Models the `segwit` field returned by the `decodescript` RPC.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScriptSegwit {
-    /// The witness program.
+    /// Disassembly of the script.
     pub asm: String,
-    /// Hex-encoded script.
-    pub hex: String,
-    /// The output type.
+    /// 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).
+    /// Bitcoin address (only if a well-defined address exists)v22 and later only.
     pub address: Option<Address<NetworkUnchecked>>,
     /// The required signatures.
     pub required_signatures: Option<u64>,
     /// List of bitcoin addresses.
     pub addresses: Vec<Address<NetworkUnchecked>>,
     /// Address of the P2SH script wrapping this witness redeem script.
-    pub p2sh_segwit: Option<String>,
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }
 
 /// Models the result of JSON-RPC method `descriptorprocesspsbt`.

types/src/v17/raw_transactions/mod.rs

@@ -9,6 +9,8 @@ mod into;
 
 use std::collections::HashMap;
 
+use bitcoin::address::{Address, NetworkUnchecked};
+use bitcoin::ScriptBuf;
 use serde::{Deserialize, Serialize};
 
 use crate::ScriptSig;
@@ -213,11 +215,11 @@ pub struct DecodeRawTransaction(pub RawTransaction);
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScript {
-    /// Script public key.
+    /// Disassembly of the script.
     pub asm: String,
-    /// Hex encoded public key.
+    /// The raw output script bytes, hex-encoded.
     pub hex: Option<String>,
-    /// The output type.
+    /// The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash).
     #[serde(rename = "type")]
     pub type_: String,
     /// The required signatures.
@@ -227,33 +229,33 @@ pub struct DecodeScript {
     pub addresses: Option<Vec<String>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     pub p2sh: Option<String>,
-    /// Segwit data (see `DecodeScriptSegwit` for explanation).
+    /// Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped).
     pub segwit: Option<DecodeScriptSegwit>,
     /// Address of the P2SH script wrapping this witness redeem script
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segwit: Option<String>,
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }
 
 /// Seemingly undocumented data returned in the `segwit` field of `DecodeScript`.
 // This seems to be the same as `DecodeScript` except the `p2sh` field is called `p2sh-segwit`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScriptSegwit {
-    /// Script public key.
+    /// Disassembly of the script.
     pub asm: String,
-    /// Hex encoded public key.
-    pub hex: String,
-    /// The output type.
+    /// The raw output script bytes, hex-encoded.
+    pub hex: ScriptBuf,
+    /// The type of the output script (e.g. witness_v0_keyhash or witness_v0_scripthash).
     #[serde(rename = "type")]
     pub type_: String,
     /// The required signatures.
     #[serde(rename = "reqSigs")]
     pub required_signatures: Option<u64>,
     /// List of bitcoin addresses.
     pub addresses: Option<Vec<String>>,
-    /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
+    /// Address of the P2SH script wrapping this witness redeem script.
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segtwit: Option<String>,
+    pub p2sh_segtwit: Option<Address<NetworkUnchecked>>,
 }
 
 /// Result of JSON-RPC method `finalizepsbt`.

types/src/v22/mod.rs

@@ -253,7 +253,9 @@ pub use self::{
     blockchain::GetMempoolInfo,
     control::Logging,
     network::{Banned, GetPeerInfo, ListBanned},
-    raw_transactions::{DecodeScript, DecodeScriptError,DecodeScriptSegwit,DecodeScriptSegwitError},
+    raw_transactions::{
+        DecodeScript, DecodeScriptError, DecodeScriptSegwit, DecodeScriptSegwitError,
+    },
 };
 #[doc(inline)]
 pub use crate::{

types/src/v22/raw_transactions/error.rs

@@ -19,7 +19,6 @@ pub enum DecodeScriptError {
     Segwit(DecodeScriptSegwitError),
     /// Conversion of the transaction `p2sh` field failed.
     P2sh(address::ParseError),
-    
 }
 
 impl fmt::Display for DecodeScriptError {
@@ -54,8 +53,6 @@ impl std::error::Error for DecodeScriptError {
 /// Error when converting a `DecodeScriptSegwit` type into the model type.
 #[derive(Debug)]
 pub enum DecodeScriptSegwitError {
-    /// An invalid or missing field in the `DecodeScriptSegwit` data.
-    InvalidField(&'static str),
     /// Conversion of the transaction `address` field failed.
     Address(address::ParseError),
     /// Conversion of the transaction `addresses` field failed.
@@ -65,10 +62,7 @@ pub enum DecodeScriptSegwitError {
 impl fmt::Display for DecodeScriptSegwitError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         use DecodeScriptSegwitError as E;
-
         match *self {
-            E::InvalidField(name) =>
-                write!(f, "conversion of the `segwit` field failed: invalid or missing field `{}`", name),
             E::Address(ref e) =>
                 write_err!(f, "conversion of the `address` field in `segwit` failed"; e),
             E::Addresses(ref e) =>
@@ -81,13 +75,9 @@ impl fmt::Display for DecodeScriptSegwitError {
 impl std::error::Error for DecodeScriptSegwitError {
     fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
         use DecodeScriptSegwitError as E;
-
         match *self {
-            E::InvalidField(_) => None,
             E::Address(ref e) => Some(e),
             E::Addresses(ref e) => Some(e),
         }
     }
 }
-
-

types/src/v22/raw_transactions/into.rs

@@ -2,8 +2,7 @@
 
 use bitcoin::Address;
 
-use super::{DecodeScript, DecodeScriptError, DecodeScriptSegwit, DecodeScriptSegwitError}; 
-
+use super::{DecodeScript, DecodeScriptError, DecodeScriptSegwit, DecodeScriptSegwitError};
 use crate::model;
 
 impl DecodeScript {
@@ -24,7 +23,7 @@ impl DecodeScript {
             None => vec![],
         };
         let p2sh = self.p2sh.map(|s| s.parse::<Address<_>>()).transpose().map_err(E::P2sh)?;
-        
+
         Ok(model::DecodeScript {
             script_pubkey: None,
             type_: self.type_,
@@ -35,7 +34,6 @@ impl DecodeScript {
             p2sh,
             segwit: self.segwit.map(|s| s.into_model()).transpose().map_err(E::Segwit)?,
             p2sh_segwit: self.p2sh_segwit,
-            
         })
     }
 }
@@ -65,12 +63,12 @@ impl DecodeScriptSegwit {
         Ok(model::DecodeScriptSegwit {
             asm: self.asm,
             hex: self.hex,
+            descriptor: None,
             type_: self.type_,
             address,
             required_signatures,
             addresses,
             p2sh_segwit,
         })
-           
     }
 }

types/src/v22/raw_transactions/mod.rs

@@ -7,9 +7,11 @@
 mod error;
 mod into;
 
+use bitcoin::address::{Address, NetworkUnchecked};
+use bitcoin::ScriptBuf;
 use serde::{Deserialize, Serialize};
 
-pub use self::error::{DecodeScriptError,DecodeScriptSegwitError};
+pub use self::error::{DecodeScriptError, DecodeScriptSegwitError};
 
 /// Result of JSON-RPC method `decodescript`.
 ///
@@ -23,9 +25,9 @@ pub use self::error::{DecodeScriptError,DecodeScriptSegwitError};
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScript {
-    /// Script public key.
+    /// Disassembly of the script.
     pub asm: String,
-    /// The output type.
+    /// The output type (e.g. nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown).
     #[serde(rename = "type")]
     pub type_: String,
     /// Bitcoin address (only if a well-defined address exists). v22 and later only.
@@ -37,22 +39,22 @@ pub struct DecodeScript {
     pub addresses: Option<Vec<String>>,
     /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
     pub p2sh: Option<String>,
-    /// Segwit data (see `DecodeScriptSegwit` for explanation).
+    /// Result of a witness output script wrapping this redeem script (not returned for types that should not be wrapped).
     pub segwit: Option<DecodeScriptSegwit>,
     /// Address of the P2SH script wrapping this witness redeem script
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segwit: Option<String>,
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }
 
 /// `segwit` item returned as part of `decodescript`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]
 pub struct DecodeScriptSegwit {
-    /// Script public key.
+    /// Disassembly of the script.
     pub asm: String,
-    /// Hex encoded public key.
-    pub hex: String,
-    /// The output type.
+    /// The raw output script bytes, hex-encoded.
+    pub hex: ScriptBuf,
+    /// The output type (e.g. nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_unknown).
     #[serde(rename = "type")]
     pub type_: String,
     /// Bitcoin address (only if a well-defined address exists). v22 and later only.
@@ -62,7 +64,7 @@ pub struct DecodeScriptSegwit {
     pub required_signatures: Option<u64>,
     /// List of bitcoin addresses.
     pub addresses: Option<Vec<String>>,
-    /// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).
+    /// Address of the P2SH script wrapping this witness redeem script.
     #[serde(rename = "p2sh-segwit")]
-    pub p2sh_segwit: Option<String>,
+    pub p2sh_segwit: Option<Address<NetworkUnchecked>>,
 }

types/src/v23/mod.rs

@@ -249,8 +249,8 @@ pub use self::{
     control::Logging,
     network::GetPeerInfo,
     raw_transactions::{
-        DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, GlobalXpub, Proprietary,
-        PsbtInput, PsbtOutput,DecodeScriptSegwit,DecodeScriptSegwitError
+        DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, DecodeScriptSegwit,
+        DecodeScriptSegwitError, GlobalXpub, Proprietary, PsbtInput, PsbtOutput,
     },
     util::CreateMultisig,
     wallet::{GetTransaction, GetTransactionError},

types/src/v23/raw_transactions/error.rs

@@ -312,7 +312,6 @@ pub enum DecodeScriptSegwitError {
 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),
@@ -326,7 +325,6 @@ impl fmt::Display for DecodeScriptSegwitError {
 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/into.rs

@@ -9,11 +9,10 @@ use bitcoin::psbt::{self, raw, PsbtSighashType};
 use bitcoin::{Address, Amount};
 
 use super::{
-    DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, GlobalXpub, GlobalXpubError,
-    Proprietary, PsbtInput, PsbtInputError, PsbtOutput, PsbtOutputError,DecodeScriptSegwit,
-    DecodeScriptSegwitError,
+    DecodePsbt, DecodePsbtError, DecodeScript, DecodeScriptError, DecodeScriptSegwit,
+    DecodeScriptSegwitError, GlobalXpub, GlobalXpubError, Proprietary, PsbtInput, PsbtInputError,
+    PsbtOutput, PsbtOutputError,
 };
-
 use crate::model;
 
 impl DecodePsbt {
@@ -326,10 +325,8 @@ impl DecodeScript {
                 .map_err(E::Addresses)?,
             None => vec![],
         };
-
-        
         let p2sh = self.p2sh.map(|s| s.parse::<Address<_>>()).transpose().map_err(E::P2sh)?;
-        
+
         Ok(model::DecodeScript {
             script_pubkey: None,
             type_: self.type_,
@@ -340,7 +337,6 @@ impl DecodeScript {
             p2sh,
             segwit: self.segwit.map(|s| s.into_model()).transpose().map_err(E::Segwit)?,
             p2sh_segwit: self.p2sh_segwit,
-            
         })
     }
 }
@@ -353,7 +349,6 @@ impl DecodeScriptSegwit {
             Some(addr) => Some(addr.parse::<Address<_>>().map_err(E::Address)?),
             None => None,
         };
-
         let addresses = match self.addresses {
             Some(addrs) => addrs
                 .into_iter()
@@ -362,16 +357,18 @@ impl DecodeScriptSegwit {
                 .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: self.descriptor,
             type_: self.type_,
             address,
-            required_signatures: self.required_signatures,
+            required_signatures,
             addresses,
-            p2sh_segwit: self.p2sh_segwit,
+            p2sh_segwit,
         })
     }
 }
-