Merge rust-bitcoin/corepc#243: Add missing return fields in v17

blaze-smith470pm · blaze-smith470pm · commit a3615d12e89a · 2025-06-14T07:55:32.000+10:00
e9575cd06e9bfce9e579eb3df4eb3d99f5882680 Run the formatter (Jamil Lambert, PhD)
f6a8124be502f663bb517abac90fe3383e7850d9 Add missing gettransaction fields to v17 (Jamil Lambert, PhD)
5da62e7528b4b41960c78830b6f64d82dc4cc7e1 Add missing decodescript field to v17 (Jamil Lambert, PhD)
60f8e759cbc8f9a848ed3b8fe60bee045614542a Add missing getblocktemplate fields to v17 (Jamil Lambert, PhD)

Pull request description:

  When looking into the fix for #241 some missing fields in the v17 types were found.

  Add the missing fields.

  Remove the now unnecessary change in v29 to `getblocktemplate` since the fields have been there since v17, just undocumented.

ACKs for top commit:
  tcharding:
    ACK e9575cd06e9bfce9e579eb3df4eb3d99f5882680

Tree-SHA512: e6826e317ebc5d8bb568e765a44e9f4da4b2822280edb446e644f32c24b17d71e8c2bf69fbdf5d42a76e0cedf204083114e6913ca3eb1f8d313a3ef3207e5582
diff --git a/types/src/model/mining.rs b/types/src/model/mining.rs
@@ -24,6 +24,8 @@ pub struct GetBlockTemplate {
     /// Map of rules name to bit number - identifies the bit number as indicating acceptance and
     /// readiness for the named softfork rule.
     pub version_bits_available: BTreeMap<String, u32>,
+    /// Client side supported features.
+    pub capabilities: Vec<String>,
     /// Bit mask of versionbits the server requires set in submissions.
     pub version_bits_required: u32,
     /// The hash of current highest block.
@@ -37,6 +39,8 @@ pub struct GetBlockTemplate {
     /// Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis).
     #[serde(with = "bitcoin::amount::serde::as_sat")]
     pub coinbase_value: SignedAmount,
+    /// An id to include with a request to longpoll on an update to this template.
+    pub long_poll_id: Option<String>,
     /// The hash target.
     pub target: Vec<u8>,
     /// The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT).
@@ -59,6 +63,10 @@ pub struct GetBlockTemplate {
     pub bits: CompactTarget,
     /// The height of the next block,
     pub height: u32,
+    /// Optional signet challenge
+    pub signet_challenge: Option<String>,
+    /// A valid witness commitment for the unmodified block template.
+    pub default_witness_commitment: Option<String>,
 }
 
 /// Contents of non-coinbase transactions that should be included in the next block.
diff --git a/types/src/model/raw_transactions.rs b/types/src/model/raw_transactions.rs
@@ -101,6 +101,8 @@ 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>>,
+    /// Address of the P2SH script wrapping this witness redeem script
+    pub p2sh_segwit: Option<String>,
 }
 
 /// Models the result of JSON-RPC method `descriptorprocesspsbt`.
diff --git a/types/src/model/wallet.rs b/types/src/model/wallet.rs
@@ -286,6 +286,8 @@ pub struct GetTransaction {
     pub fee: Option<SignedAmount>,
     /// The number of confirmations.
     pub confirmations: i64, // Docs do not indicate what negative value means?
+    /// Whether we consider the outputs of this unconfirmed transaction safe to spend.
+    pub trusted: Option<bool>,
     /// The block hash.
     pub block_hash: Option<BlockHash>,
     /// The index of the transaction in the block that includes it.
@@ -294,6 +296,8 @@ pub struct GetTransaction {
     pub block_time: Option<u32>,
     /// The transaction id.
     pub txid: Txid,
+    /// Confirmed transactions that have been detected by the wallet to conflict with this transaction.
+    pub wallet_conflicts: Vec<Txid>,
     /// The transaction time in seconds since epoch (1 Jan 1970 GMT).
     pub time: u32,
     /// The time received in seconds since epoch (1 Jan 1970 GMT).
diff --git a/types/src/v17/mining/into.rs b/types/src/v17/mining/into.rs
@@ -39,11 +39,13 @@ impl GetBlockTemplate {
             version,
             rules: self.rules,
             version_bits_available: self.version_bits_available,
+            capabilities: self.capabilities,
             version_bits_required,
             previous_block_hash,
             transactions,
             coinbase_aux: self.coinbase_aux,
             coinbase_value,
+            long_poll_id: self.long_poll_id,
             target,
             min_time: self.min_time,
             mutable: self.mutable,
@@ -54,6 +56,8 @@ impl GetBlockTemplate {
             current_time: self.current_time,
             bits,
             height,
+            signet_challenge: self.signet_challenge,
+            default_witness_commitment: self.default_witness_commitment,
         })
     }
 }
diff --git a/types/src/v17/mining/mod.rs b/types/src/v17/mining/mod.rs
@@ -53,6 +53,8 @@ pub struct GetBlockTemplate {
     /// readiness for the named softfork rule.
     #[serde(rename = "vbavailable")]
     pub version_bits_available: BTreeMap<String, u32>,
+    /// Client side supported features.
+    pub capabilities: Vec<String>,
     /// Bit mask of versionbits the server requires set in submissions.
     #[serde(rename = "vbrequired")]
     pub version_bits_required: i64,
@@ -69,6 +71,9 @@ pub struct GetBlockTemplate {
     /// Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis).
     #[serde(rename = "coinbasevalue")]
     pub coinbase_value: i64,
+    /// An id to include with a request to longpoll on an update to this template.
+    #[serde(rename = "longpollid")]
+    pub long_poll_id: Option<String>,
     // This is in the docs but not actually returned (for v0.17 and v0.18 at least).
     // coinbase_txn: ???, // Also I don't know what the JSON object represents: `{ ... }`
     /// The hash target.
@@ -78,7 +83,7 @@ pub struct GetBlockTemplate {
     pub min_time: u32,
     /// List of ways the block template may be changed.
     ///
-    /// A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'
+    /// A way the block template may be changed, e.g. 'time', 'transactions', 'prevblock'.
     pub mutable: Vec<String>,
     /// A range of valid nonces.
     #[serde(rename = "noncerange")]
@@ -97,8 +102,12 @@ pub struct GetBlockTemplate {
     pub current_time: u64,
     /// Compressed target of next block.
     pub bits: String,
-    /// The height of the next block,
+    /// The height of the next block.
     pub height: i64,
+    /// Optional signet challenge.
+    pub signet_challenge: Option<String>,
+    /// A valid witness commitment for the unmodified block template.
+    pub default_witness_commitment: Option<String>,
 }
 
 /// Contents of non-coinbase transactions that should be included in the next block.
diff --git a/types/src/v17/raw_transactions/into.rs b/types/src/v17/raw_transactions/into.rs
@@ -307,6 +307,7 @@ impl DecodeScript {
             required_signatures: self.required_signatures,
             addresses,
             p2sh,
+            p2sh_segwit: self.p2sh_segwit,
         })
     }
 }
diff --git a/types/src/v17/raw_transactions/mod.rs b/types/src/v17/raw_transactions/mod.rs
@@ -219,6 +219,9 @@ pub struct DecodeScript {
     pub p2sh: Option<String>,
     /// Segwit data (see `DecodeScriptSegwit` for explanation).
     pub segwit: Option<DecodeScriptSegwit>,
+    /// Address of the P2SH script wrapping this witness redeem script
+    #[serde(rename = "p2sh-segwit")]
+    pub p2sh_segwit: Option<String>,
 }
 
 /// Seemingly undocumented data returned in the `segwit` field of `DecodeScript`.
@@ -238,6 +241,7 @@ pub struct DecodeScriptSegwit {
     /// 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).
+    #[serde(rename = "p2sh-segwit")]
     pub p2sh_segtwit: Option<String>,
 }
 
diff --git a/types/src/v17/wallet/error.rs b/types/src/v17/wallet/error.rs
@@ -249,6 +249,8 @@ pub enum GetTransactionError {
     BlockHash(hex::HexToArrayError),
     /// Conversion of the `txid` field failed.
     Txid(hex::HexToArrayError),
+    /// Conversion of the `wallet_conflicts` field failed.
+    WalletConflicts(hex::HexToArrayError),
     /// Conversion of the transaction `hex` field failed.
     Tx(encode::FromHexError),
     /// Conversion of the `details` field failed.
@@ -265,6 +267,8 @@ impl fmt::Display for GetTransactionError {
             E::Fee(ref e) => write_err!(f, "conversion of the `fee` field failed"; e),
             E::BlockHash(ref e) => write_err!(f, "conversion of the `block_hash` field failed"; e),
             E::Txid(ref e) => write_err!(f, "conversion of the `txid` field failed"; e),
+            E::WalletConflicts(ref e) =>
+                write_err!(f, "conversion of the `wallet_conflicts` field failed"; e),
             E::Tx(ref e) => write_err!(f, "conversion of the `hex` field failed"; e),
             E::Details(ref e) => write_err!(f, "conversion of the `details` field failed"; e),
         }
@@ -282,6 +286,7 @@ impl std::error::Error for GetTransactionError {
             E::Fee(ref e) => Some(e),
             E::BlockHash(ref e) => Some(e),
             E::Txid(ref e) => Some(e),
+            E::WalletConflicts(ref e) => Some(e),
             E::Tx(ref e) => Some(e),
             E::Details(ref e) => Some(e),
         }
diff --git a/types/src/v17/wallet/into.rs b/types/src/v17/wallet/into.rs
@@ -338,6 +338,11 @@ impl GetTransaction {
             self.block_index.map(|idx| crate::to_u32(idx, "block_index")).transpose()?;
 
         let txid = self.txid.parse::<Txid>().map_err(E::Txid)?;
+        let wallet_conflicts = self
+            .wallet_conflicts
+            .into_iter()
+            .map(|s| s.parse::<Txid>().map_err(E::WalletConflicts))
+            .collect::<Result<Vec<_>, _>>()?;
         let tx = encode::deserialize_hex::<Transaction>(&self.hex).map_err(E::Tx)?;
         let details = self
             .details
@@ -349,10 +354,12 @@ impl GetTransaction {
             amount,
             fee,
             confirmations: self.confirmations,
+            trusted: self.trusted,
             block_hash,
             block_index,
             block_time: self.block_time,
             txid,
+            wallet_conflicts,
             time: self.time,
             time_received: self.time_received,
             bip125_replaceable: self.bip125_replaceable.into_model(),
diff --git a/types/src/v17/wallet/mod.rs b/types/src/v17/wallet/mod.rs
@@ -413,6 +413,8 @@ pub struct GetTransaction {
     pub fee: Option<f64>,
     /// The number of confirmations.
     pub confirmations: i64,
+    /// Whether we consider the outputs of this unconfirmed transaction safe to spend.
+    pub trusted: Option<bool>,
     /// The block hash.
     #[serde(rename = "blockhash")]
     // The docs say this field should exist but integration test fail without `Option`.
@@ -426,6 +428,9 @@ pub struct GetTransaction {
     pub block_time: Option<u32>, // Docs are wrong, this is not documented as optional.
     /// The transaction id.
     pub txid: String,
+    /// Confirmed transactions that have been detected by the wallet to conflict with this transaction.
+    #[serde(rename = "walletconflicts")]
+    pub wallet_conflicts: Vec<String>,
     /// The transaction time in seconds since epoch (1 Jan 1970 GMT).
     pub time: u32,
     /// The time received in seconds since epoch (1 Jan 1970 GMT).
diff --git a/types/src/v29/mining/error.rs b/types/src/v29/mining/error.rs
@@ -4,62 +4,11 @@ use core::fmt;
 
 use bitcoin::amount::ParseAmountError;
 use bitcoin::error::UnprefixedHexError;
-use bitcoin::hex::HexToBytesError;
 use bitcoin::{consensus, hex};
 
 use crate::error::write_err;
 use crate::NumericError;
 
-/// Error when converting a `GetBlockTemplate` type into the model type.
-#[derive(Debug)]
-pub enum GetBlockTemplateError {
-    /// Conversion of numeric type to expected type failed.
-    Numeric(NumericError),
-    /// Conversion of the `previous_block_hash` field failed.
-    PreviousBlockHash(hex::HexToArrayError),
-    /// Conversion of the `transactions` field failed.
-    Transactions(BlockTemplateTransactionError),
-    /// Conversion of the `target` field failed.
-    Target(HexToBytesError),
-    /// Conversion of the `bits` field failed.
-    Bits(UnprefixedHexError),
-}
-
-impl fmt::Display for GetBlockTemplateError {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        use GetBlockTemplateError as E;
-
-        match *self {
-            E::Numeric(ref e) => write_err!(f, "numeric"; e),
-            E::PreviousBlockHash(ref e) =>
-                write_err!(f, "conversion of the `previous_block_hash` field failed"; e),
-            E::Transactions(ref e) =>
-                write_err!(f, "conversion of the `transactions` field failed"; e),
-            E::Target(ref e) => write_err!(f, "conversion of the `target` field failed"; e),
-            E::Bits(ref e) => write_err!(f, "conversion of the `bits` field failed"; e),
-        }
-    }
-}
-
-#[cfg(feature = "std")]
-impl std::error::Error for GetBlockTemplateError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        use GetBlockTemplateError as E;
-
-        match *self {
-            E::Numeric(ref e) => Some(e),
-            E::PreviousBlockHash(ref e) => Some(e),
-            E::Transactions(ref e) => Some(e),
-            E::Target(ref e) => Some(e),
-            E::Bits(ref e) => Some(e),
-        }
-    }
-}
-
-impl From<NumericError> for GetBlockTemplateError {
-    fn from(e: NumericError) -> Self { Self::Numeric(e) }
-}
-
 /// Error when converting a `BlockTemplateTransaction` type into the model type.
 #[derive(Debug)]
 pub enum BlockTemplateTransactionError {
diff --git a/types/src/v29/mining/into.rs b/types/src/v29/mining/into.rs
@@ -1,64 +1,13 @@
 // SPDX-License-Identifier: CC0-1.0
 
-use bitcoin::hex::FromHex as _;
-use bitcoin::{
-    block, consensus, BlockHash, CompactTarget, SignedAmount, Target, Transaction, Txid, Weight,
-    Wtxid,
-};
+use bitcoin::{consensus, CompactTarget, SignedAmount, Target, Transaction, Txid, Weight, Wtxid};
 
 use super::{
-    BlockTemplateTransaction, BlockTemplateTransactionError, GetBlockTemplate,
-    GetBlockTemplateError, GetMiningInfo, GetMiningInfoError, NextBlockInfo, NextBlockInfoError,
+    BlockTemplateTransaction, BlockTemplateTransactionError, GetMiningInfo, GetMiningInfoError,
+    NextBlockInfo, NextBlockInfoError,
 };
 use crate::model;
 
-impl GetBlockTemplate {
-    /// Converts version specific type to a version nonspecific, more strongly typed type.
-    pub fn into_model(self) -> Result<model::GetBlockTemplate, GetBlockTemplateError> {
-        use GetBlockTemplateError as E;
-
-        let version = block::Version::from_consensus(self.version);
-        let version_bits_required =
-            crate::to_u32(self.version_bits_required, "version_bits_required")?;
-        let previous_block_hash =
-            self.previous_block_hash.parse::<BlockHash>().map_err(E::PreviousBlockHash)?;
-        let transactions = self
-            .transactions
-            .into_iter()
-            .map(|t| t.into_model())
-            .collect::<Result<Vec<_>, _>>()
-            .map_err(E::Transactions)?;
-        let coinbase_value = SignedAmount::from_sat(self.coinbase_value);
-        let target = Vec::from_hex(&self.target).map_err(E::Target)?;
-        let sigop_limit = crate::to_u32(self.sigop_limit, "sigop_limit")?;
-        let weight_limit = crate::to_u32(self.weight_limit, "weight_limit")?;
-        let size_limit = crate::to_u32(self.size_limit, "size_limit")?;
-        let bits = CompactTarget::from_unprefixed_hex(&self.bits).map_err(E::Bits)?;
-        let height = crate::to_u32(self.height, "height")?;
-
-        Ok(model::GetBlockTemplate {
-            version,
-            rules: self.rules,
-            version_bits_available: self.version_bits_available,
-            version_bits_required,
-            previous_block_hash,
-            transactions,
-            coinbase_aux: self.coinbase_aux,
-            coinbase_value,
-            target,
-            min_time: self.min_time,
-            mutable: self.mutable,
-            nonce_range: self.nonce_range,
-            sigop_limit,
-            weight_limit,
-            size_limit,
-            current_time: self.current_time,
-            bits,
-            height,
-        })
-    }
-}
-
 impl BlockTemplateTransaction {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(
diff --git a/types/src/v29/mining/mod.rs b/types/src/v29/mining/mod.rs
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs

Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,8 @@ pub struct DecodeScript {`
`101`	`101`	`pub addresses: Vec<Address<NetworkUnchecked>>,`
`102`	`102`	`/// Address of P2SH script wrapping this redeem script (not returned if the script is already a P2SH).`
`103`	`103`	`pub p2sh: Option<Address<NetworkUnchecked>>,`
	`104`	`+ /// Address of the P2SH script wrapping this witness redeem script`
	`105`	`+ pub p2sh_segwit: Option<String>,`
`104`	`106`	`}`
`105`	`107`
`106`	`108`	/// Models the result of JSON-RPC method `descriptorprocesspsbt`.
Original file line number	Diff line number	Diff line change
`@@ -307,6 +307,7 @@ impl DecodeScript {`
`307`	`307`	`required_signatures: self.required_signatures,`
`308`	`308`	`addresses,`
`309`	`309`	`p2sh,`
	`310`	`+ p2sh_segwit: self.p2sh_segwit,`
`310`	`311`	`})`
`311`	`312`	`}`
`312`	`313`	`}`