Skip to content

Address all TODO in v20 #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 8, 2025
Merged

Address all TODO in v20 #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da6fc87
Add generatetodescriptor type, model and test
jamillambert Jul 4, 2025
5804290
Check createmultisig and remove TODO
jamillambert Jul 4, 2025
3f8efb9
Check signmessagewithprivkey and remove TODO
jamillambert Jul 4, 2025
aa91a26
Check validateaddress and remove TODO
jamillambert Jul 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions client/src/client_sync/v20/generating.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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()])
}
}
};
}
3 changes: 3 additions & 0 deletions client/src/client_sync/v20/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v21/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v22/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v23/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v24/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v25/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v26/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v27/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v28/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
1 change: 1 addition & 0 deletions client/src/client_sync/v29/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ==
Expand Down
14 changes: 14 additions & 0 deletions integration_test/tests/generating.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() {
Expand Down
13 changes: 13 additions & 0 deletions types/src/model/generating.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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() }
}
2 changes: 1 addition & 1 deletion types/src/model/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
35 changes: 35 additions & 0 deletions types/src/v20/generating.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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))
}
}
10 changes: 6 additions & 4 deletions types/src/v20/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | generatetoaddress | version + model | |
//! | generatetodescriptor | version + model | TODO |
//! | generatetodescriptor | version + model | |
//!
//! </details>
//!
Expand Down Expand Up @@ -143,12 +143,12 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -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},
Expand Down
13 changes: 8 additions & 5 deletions types/src/v21/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | generateblock | version + model | TODO |
//! | generatetoaddress | version + model | |
//! | generatetodescriptor | version + model | TODO |
//! | generatetodescriptor | version + model | |
//!
//! </details>
//!
Expand Down Expand Up @@ -144,13 +144,13 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | getindexinfo | version | TODO |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -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,
},
};
10 changes: 5 additions & 5 deletions types/src/v22/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | generateblock | version + model | TODO |
//! | generatetoaddress | version + model | |
//! | generatetodescriptor | version + model | TODO |
//! | generatetodescriptor | version + model | |
//!
//! </details>
//!
Expand Down Expand Up @@ -153,13 +153,13 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | getindexinfo | version | TODO |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -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,
Expand Down
8 changes: 4 additions & 4 deletions types/src/v23/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,13 +144,13 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | getindexinfo | version | TODO |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -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},
};
7 changes: 4 additions & 3 deletions types/src/v24/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,13 +145,13 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | getindexinfo | version | TODO |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -305,6 +305,7 @@ pub use crate::{
MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, PeerInfo, SetWalletFlag,
Softfork, SoftforkType,
},
v20::GenerateToDescriptor,
v21::{GetNetworkInfo, UnloadWallet},
v22::{Banned, ListBanned, ScriptPubkey},
v23::{
Expand Down
7 changes: 4 additions & 3 deletions types/src/v25/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,13 @@
//!
//! | JSON-RPC Method Name | Returns | Notes |
//! |:-----------------------------------|:---------------:|:--------------------------------------:|
//! | createmultisig | version + model | TODO |
//! | createmultisig | version + model | |
//! | deriveaddresses | version + model | |
//! | estimatesmartfee | version + model | |
//! | getdescriptorinfo | version | |
//! | getindexinfo | version | TODO |
//! | signmessagewithprivkey | version + model | TODO |
//! | validateaddress | version + model | TODO |
//! | signmessagewithprivkey | version + model | |
//! | validateaddress | version + model | |
//! | verifymessage | version | |
//!
//! </details>
Expand Down Expand Up @@ -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},
Expand Down
Loading