Add missing getblocktemplate fields to v17

jamillambert · jamillambert · commit 60f8e759cbc8 · 2025-06-13T08:42:19.000+01:00
There are return fields in v17 onwards that are undocumented until v29

Add the fields to v17.

Remove the redefinition in v29 since it is now the same as v17, only the
help output changed.
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/v17/mining/into.rs b/types/src/v17/mining/into.rs
@@ -17,6 +17,11 @@ impl GetBlockTemplate {
         use GetBlockTemplateError as E;
 
         let version = block::Version::from_consensus(self.version);
+        let capabilities = self
+            .capabilities
+            .into_iter()
+            .map(|s| s.to_string())
+            .collect::<Vec<_>>();
         let version_bits_required =
             crate::to_u32(self.version_bits_required, "version_bits_required")?;
         let previous_block_hash =
@@ -39,11 +44,13 @@ impl GetBlockTemplate {
             version,
             rules: self.rules,
             version_bits_available: self.version_bits_available,
+            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 +61,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/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,15 @@
 // SPDX-License-Identifier: CC0-1.0
 
-use bitcoin::hex::FromHex as _;
 use bitcoin::{
-    block, consensus, BlockHash, CompactTarget, SignedAmount, Target, Transaction, Txid, Weight,
+    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
@@ -7,112 +7,12 @@
 mod error;
 mod into;
 
-use std::collections::BTreeMap;
-
 use serde::{Deserialize, Serialize};
 
 pub use self::error::{
-    BlockTemplateTransactionError, GetBlockTemplateError, GetMiningInfoError, NextBlockInfoError,
+    BlockTemplateTransactionError, GetMiningInfoError, NextBlockInfoError,
 };
 
-/// Result of the JSON-RPC method `getblocktemplate`.
-///
-/// > getblocktemplate {"mode":"str","capabilities":["str",...],"rules":["segwit","str",...],"longpollid":"str","data":"hex"}
-/// >
-/// > If the request parameters include a 'mode' key, that is used to explicitly select between the default 'template' request or a 'proposal'.
-/// > It returns data needed to construct a block to work on.
-/// > For full specification, see BIPs 22, 23, 9, and 145:
-/// >     <https://github.com/bitcoin/bips/blob/master/bip-0022.mediawiki>
-/// >     <https://github.com/bitcoin/bips/blob/master/bip-0023.mediawiki>
-/// >     <https://github.com/bitcoin/bips/blob/master/bip-0009.mediawiki#getblocktemplate_changes>
-/// >     <https://github.com/bitcoin/bips/blob/master/bip-0145.mediawiki>
-/// >
-/// > Arguments:
-/// > 1. template_request            (json object, required) Format of the template
-/// >      {
-/// >        "mode": "str",          (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted
-/// >        "capabilities": [       (json array, optional) A list of strings
-/// >          "str",                (string) client side supported feature, 'longpoll', 'coinbasevalue', 'proposal', 'serverlist', 'workid'
-/// >          ...
-/// >        ],
-/// >        "rules": [              (json array, required) A list of strings
-/// >          "segwit",             (string, required) (literal) indicates client side segwit support
-/// >          "str",                (string) other client side supported softfork deployment
-/// >          ...
-/// >        ],
-/// >        "longpollid": "str",    (string, optional) delay processing request until the result would vary significantly from the "longpollid" of a prior template
-/// >        "data": "hex",          (string, optional) proposed block data to check, encoded in hexadecimal; valid only for mode="proposal"
-/// >      }
-#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-pub struct GetBlockTemplate {
-    /// The preferred block version.
-    pub version: i32,
-    /// Specific block rules that are to be enforced.
-    pub rules: Vec<String>,
-    /// Set of pending, supported versionbit (BIP 9) softfork deployments.
-    ///
-    /// Map of rules name to bit number - identifies the bit number as indicating acceptance and
-    /// readiness for the named softfork rule.
-    #[serde(rename = "vbavailable")]
-    pub version_bits_available: BTreeMap<String, u32>,
-    /// Bit mask of versionbits the server requires set in submissions.
-    #[serde(rename = "vbrequired")]
-    pub version_bits_required: i64,
-    /// The hash of current highest block.
-    #[serde(rename = "previousblockhash")]
-    pub previous_block_hash: String,
-    /// Contents of non-coinbase transactions that should be included in the next block.
-    pub transactions: Vec<BlockTemplateTransaction>,
-    /// Data that should be included in the coinbase's scriptSig content.
-    ///
-    /// Key name is to be ignored, and value included in scriptSig.
-    #[serde(rename = "coinbaseaux")]
-    pub coinbase_aux: BTreeMap<String, String>,
-    /// Maximum allowable input to coinbase transaction, including the generation award and transaction fees (in satoshis).
-    #[serde(rename = "coinbasevalue")]
-    pub coinbase_value: i64,
-    /// A list of supported features,for example `proposal`
-    pub capabilities: Vec<String>,
-    /// ID to include with a request to longpoll on an update to this template.
-    #[serde(rename = "longpollid")]
-    pub long_poll_id: 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.
-    pub target: String,
-    /// The minimum timestamp appropriate for next block time in seconds since epoch (Jan 1 1970 GMT).
-    #[serde(rename = "mintime")]
-    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'
-    pub mutable: Vec<String>,
-    /// A range of valid nonces.
-    #[serde(rename = "noncerange")]
-    pub nonce_range: String,
-    /// Limit of sigops in blocks.
-    #[serde(rename = "sigoplimit")]
-    pub sigop_limit: i64,
-    /// Limit of block size.
-    #[serde(rename = "sizelimit")]
-    pub size_limit: i64,
-    /// Limit of block weight.
-    #[serde(rename = "weightlimit")]
-    pub weight_limit: i64,
-    /// Current timestamp in seconds since epoch (Jan 1 1970 GMT).
-    #[serde(rename = "curtime")]
-    pub current_time: u64,
-    /// Compressed target of next block.
-    pub bits: String,
-    /// The height of the next block,
-    pub height: i64,
-    /// Optional signet challenge
-    #[serde(rename = "signet_challenge")]
-    pub signet_challenge: Option<String>,
-    #[serde(rename = "defaultwitnesscommitment")]
-    pub default_witness_commitment: Option<String>,
-}
-
 /// Contents of non-coinbase transactions that should be included in the next block.
 ///
 /// Returned as part of `getblocktemplate`.
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
@@ -265,7 +265,7 @@ pub use self::{
         SpendActivity,
     },
     mining::{
-        BlockTemplateTransaction, GetBlockTemplate, GetBlockTemplateError, GetMiningInfo,
+        BlockTemplateTransaction, GetMiningInfo,
         GetMiningInfoError, NextBlockInfo, NextBlockInfoError,
     },
     network::GetNetworkInfo,
@@ -302,7 +302,7 @@ pub use crate::{
         SignMessage, SignMessageWithPrivKey, SignRawTransaction, SignRawTransactionError,
         TestMempoolAccept, TransactionCategory, UploadTarget, ValidateAddress,
         ValidateAddressError, VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
-        WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+        WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo, GetBlockTemplate, GetBlockTemplateError,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
