Add generatetodescriptor type, model and test

jamillambert · jamillambert · commit da6fc8731da0 · 2025-07-08T11:30:25.000+01:00
Add the RPC `generatetodescriptor` type to v20 and add reexports.
Add model, into function, client macro and test.

Update types table up to v29, v23 and later don't have docs for
`Generating` and therefore no table entry.
diff --git a/client/src/client_sync/v20/generating.rs b/client/src/client_sync/v20/generating.rs
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Generating ==` section of the
+//! API docs of Bitcoin Core `v0.20`.
+//!
+//! All macros require `Client` to be in scope.
+//!
+//! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+
+/// Implements Bitcoin Core JSON-RPC API method `generatetodescriptor`
+#[macro_export]
+macro_rules! impl_client_v20__generate_to_descriptor {
+    () => {
+        impl Client {
+            pub fn generate_to_descriptor(
+                &self,
+                nblocks: usize,
+                descriptor: &str,
+            ) -> Result<GenerateToDescriptor> {
+                self.call("generatetodescriptor", &[nblocks.into(), descriptor.into()])
+            }
+        }
+    };
+}
diff --git a/client/src/client_sync/v20/mod.rs b/client/src/client_sync/v20/mod.rs
@@ -4,6 +4,8 @@
 //!
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
+pub mod generating;
+
 use std::collections::BTreeMap;
 use std::path::Path;
 
@@ -60,6 +62,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v21/mod.rs b/client/src/client_sync/v21/mod.rs
@@ -62,6 +62,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -62,6 +62,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v23/mod.rs b/client/src/client_sync/v23/mod.rs
@@ -64,6 +64,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v24/mod.rs b/client/src/client_sync/v24/mod.rs
@@ -61,6 +61,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v25/mod.rs b/client/src/client_sync/v25/mod.rs
@@ -61,6 +61,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -65,6 +65,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v27/mod.rs b/client/src/client_sync/v27/mod.rs
@@ -61,6 +61,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -63,6 +63,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/client/src/client_sync/v29/mod.rs b/client/src/client_sync/v29/mod.rs
@@ -63,6 +63,7 @@ crate::impl_client_v17__uptime!();
 
 // == Generating ==
 crate::impl_client_v17__generate_to_address!();
+crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
 
 // == Mining ==
diff --git a/integration_test/tests/generating.rs b/integration_test/tests/generating.rs
@@ -34,6 +34,20 @@ fn generating__generate_to_address__modelled() {
     let _ = model.unwrap();
 }
 
+#[cfg(not(feature = "v19_and_below"))]
+#[test]
+fn generating__generate_to_descriptor__modelled() {
+    const NBLOCKS: usize = 1;
+
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    let address = node.client.new_address().expect("failed to get new address");
+    let descriptor = format!("addr({})", address);
+
+    let json: GenerateToDescriptor = node.client.generate_to_descriptor(NBLOCKS, &descriptor).expect("generatetodescriptor");
+    let model: Result<mtype::GenerateToDescriptor, _> = json.into_model();
+    let _ = model.unwrap();
+}
+
 // This method does not appear in the output of `bitcoin-cli help`.
 #[test]
 fn generating__invalidate_block() {
diff --git a/types/src/model/generating.rs b/types/src/model/generating.rs
@@ -33,3 +33,16 @@ impl GenerateToAddress {
     /// Returns true if 0 blocks were generated.
     pub fn is_empty(&self) -> bool { self.0.is_empty() }
 }
+
+/// Models the result of JSON-RPC method `generatetodescriptor`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GenerateToDescriptor(pub Vec<BlockHash>);
+
+impl GenerateToDescriptor {
+    /// Returns the number of blocks generated.
+    pub fn len(&self) -> usize { self.0.len() }
+
+    /// Returns true if 0 blocks were generated.
+    pub fn is_empty(&self) -> bool { self.0.is_empty() }
+}
diff --git a/types/src/model/mod.rs b/types/src/model/mod.rs
@@ -30,7 +30,7 @@ pub use self::{
         GetRawMempool, GetRawMempoolVerbose, GetTxOut, GetTxOutSetInfo, MempoolEntry,
         MempoolEntryFees, ReceiveActivity, Softfork, SoftforkType, SpendActivity, VerifyTxOutProof,
     },
-    generating::{Generate, GenerateToAddress},
+    generating::{Generate, GenerateToAddress, GenerateToDescriptor},
     mining::{
         BlockTemplateTransaction, GetBlockTemplate, GetMiningInfo, GetPrioritisedTransactions,
         NextBlockInfo, PrioritisedTransaction,
diff --git a/types/src/v20/generating.rs b/types/src/v20/generating.rs
@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.20` - generating.
+//!
+//! Types for methods found under the `== Generating ==` section of the API docs.
+
+use bitcoin::hex;
+use serde::{Deserialize, Serialize};
+
+use crate::model;
+
+/// Result of JSON-RPC method `generatetodescriptor`.
+///
+/// > generatetodescriptor num_blocks "descriptor" ( maxtries )
+/// >
+/// > Mine blocks immediately to a specified descriptor (before the RPC call returns)
+/// >
+/// > Arguments:
+/// > 1. num_blocks    (numeric, required) How many blocks are generated immediately.
+/// > 2. descriptor    (string, required) The descriptor to send the newly generated bitcoin to.
+/// > 3. maxtries      (numeric, optional, default=1000000) How many iterations to try.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GenerateToDescriptor(
+    /// Hashes of blocks generated.
+    pub Vec<String>,
+);
+
+impl GenerateToDescriptor {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GenerateToDescriptor, hex::HexToArrayError> {
+        let v = self.0.iter().map(|s| s.parse()).collect::<Result<Vec<_>, _>>()?;
+        Ok(model::GenerateToDescriptor(v))
+    }
+}
diff --git a/types/src/v20/mod.rs b/types/src/v20/mod.rs
@@ -74,7 +74,7 @@
 //! | JSON-RPC Method Name               | Returns         | Notes                                  |
 //! |:-----------------------------------|:---------------:|:--------------------------------------:|
 //! | generatetoaddress                  | version + model |                                        |
-//! | generatetodescriptor               | version + model | TODO                                   |
+//! | generatetodescriptor               | version + model |                                        |
 //!
 //! </details>
 //!
@@ -227,13 +227,15 @@
 
 // JSON-RPC types by API section.
 mod control;
+mod generating;
 mod network;
 mod util;
 mod wallet;
 
 #[doc(inline)]
 pub use self::{
     control::Logging,
+    generating::GenerateToDescriptor,
     network::{Banned, ListBanned},
     util::CreateMultisig,
     wallet::{GetTransaction, GetTransactionDetail},
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -75,7 +75,7 @@
 //! |:-----------------------------------|:---------------:|:--------------------------------------:|
 //! | generateblock                      | version + model | TODO                                   |
 //! | generatetoaddress                  | version + model |                                        |
-//! | generatetodescriptor               | version + model | TODO                                   |
+//! | generatetodescriptor               | version + model |                                        |
 //!
 //! </details>
 //!
@@ -294,5 +294,8 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
         SetWalletFlag,
     },
-    v20::{Banned, CreateMultisig, GetTransaction, GetTransactionDetail, ListBanned, Logging},
+    v20::{
+        Banned, CreateMultisig, GenerateToDescriptor, GetTransaction, GetTransactionDetail,
+        ListBanned, Logging,
+    },
 };
diff --git a/types/src/v22/mod.rs b/types/src/v22/mod.rs
@@ -75,7 +75,7 @@
 //! |:-----------------------------------|:---------------:|:--------------------------------------:|
 //! | generateblock                      | version + model | TODO                                   |
 //! | generatetoaddress                  | version + model |                                        |
-//! | generatetodescriptor               | version + model | TODO                                   |
+//! | generatetodescriptor               | version + model |                                        |
 //!
 //! </details>
 //!
@@ -304,7 +304,7 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
         SetWalletFlag,
     },
-    v20::{CreateMultisig, GetTransaction, GetTransactionDetail},
+    v20::{CreateMultisig, GenerateToDescriptor, GetTransaction, GetTransactionDetail},
     v21::{
         Bip9SoftforkInfo, GetBlockchainInfo, GetMempoolEntry, GetNetworkInfo, Softfork,
         SoftforkType, UnloadWallet,
diff --git a/types/src/v23/mod.rs b/types/src/v23/mod.rs
@@ -304,7 +304,7 @@ pub use crate::{
         MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
         Softfork, SoftforkType,
     },
-    v20::GetTransactionDetail,
+    v20::{GenerateToDescriptor, GetTransactionDetail},
     v21::{GetNetworkInfo, UnloadWallet},
     v22::{Banned, GetMempoolInfo, ListBanned, ScriptPubkey},
 };
diff --git a/types/src/v24/mod.rs b/types/src/v24/mod.rs
@@ -305,6 +305,7 @@ pub use crate::{
         MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
         Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v21::{GetNetworkInfo, UnloadWallet},
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{
diff --git a/types/src/v25/mod.rs b/types/src/v25/mod.rs
@@ -298,6 +298,7 @@ pub use crate::{
         MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
         Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v21::GetNetworkInfo,
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v26/mod.rs b/types/src/v26/mod.rs
@@ -318,6 +318,7 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
         SetWalletFlag, Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v21::GetNetworkInfo,
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v27/mod.rs b/types/src/v27/mod.rs
@@ -295,6 +295,7 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
         SetWalletFlag, Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v21::GetNetworkInfo,
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, GetBlockchainInfo, SaveMempool},
diff --git a/types/src/v28/mod.rs b/types/src/v28/mod.rs
@@ -316,6 +316,7 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo,
         SetWalletFlag, Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, SaveMempool},
     v24::{
diff --git a/types/src/v29/mod.rs b/types/src/v29/mod.rs
@@ -314,6 +314,7 @@ pub use crate::{
         MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
         Softfork, SoftforkType,
     },
+    v20::GenerateToDescriptor,
     v22::{Banned, ListBanned, ScriptPubkey},
     v23::{CreateMultisig, DecodeScript, DecodeScriptError, SaveMempool},
     v24::{
