Add gethdkeys method model and test

Add the struct, model, error, into_model fn and test.

Add the reexports and update the types table.

Author: jamillambert

client/src/client_sync/v28/mod.rs

@@ -5,6 +5,7 @@
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
 pub mod raw_transactions;
+pub mod wallet;
 
 use std::collections::BTreeMap;
 use std::path::Path;
@@ -148,6 +149,7 @@ crate::impl_client_v17__get_addresses_by_label!();
 crate::impl_client_v17__get_address_info!();
 crate::impl_client_v17__get_balance!();
 crate::impl_client_v19__get_balances!();
+crate::impl_client_v28__get_hd_keys!();
 crate::impl_client_v18__get_received_by_label!();
 crate::impl_client_v17__get_new_address!();
 crate::impl_client_v17__get_raw_change_address!();

client/src/client_sync/v28/wallet.rs

@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Wallet ==` section of the
+//! API docs of Bitcoin Core `v28`.
+//!
+//! 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 `gethdkeys`.
+#[macro_export]
+macro_rules! impl_client_v28__get_hd_keys {
+    () => {
+        impl Client {
+            pub fn get_hd_keys(&self) -> Result<GetHdKeys> { self.call("gethdkeys", &[]) }
+        }
+    };
+}

client/src/client_sync/v29/mod.rs

@@ -149,6 +149,7 @@ crate::impl_client_v17__get_addresses_by_label!();
 crate::impl_client_v17__get_address_info!();
 crate::impl_client_v17__get_balance!();
 crate::impl_client_v19__get_balances!();
+crate::impl_client_v28__get_hd_keys!();
 crate::impl_client_v18__get_received_by_label!();
 crate::impl_client_v17__get_new_address!();
 crate::impl_client_v17__get_raw_change_address!();

integration_test/tests/wallet.rs

@@ -247,6 +247,19 @@ fn wallet__get_balances() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v27_and_below"))]
+fn wallet__get_hd_keys__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+
+    let json: GetHdKeys = node.client.get_hd_keys().expect("gethdkeys");
+    let model: Result<mtype::GetHdKeys, _> = json.into_model();
+    let hdkey = model.unwrap().0;
+
+    let descriptor_type = hdkey[0].descriptors[0].descriptor[..3].to_string();
+    assert_eq!(descriptor_type, "pkh");
+}
+
 #[test]
 fn wallet__get_new_address__modelled() {
     let node = Node::with_wallet(Wallet::Default, &[]);

types/src/model/mod.rs

@@ -62,6 +62,7 @@ pub use self::{
         ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets, LoadWallet, PsbtBumpFee,
         RescanBlockchain, ScriptType, Send, SendAll, SendMany, SendToAddress, SignMessage,
         SimulateRawTransaction, TransactionCategory, UnloadWallet, WalletCreateFundedPsbt,
-        WalletDisplayAddress, WalletProcessPsbt,
+        WalletDisplayAddress, WalletProcessPsbt, GetHdKeys, HdKey,
+        HdKeyDescriptor,
     },
 };

types/src/model/wallet.rs

@@ -8,6 +8,7 @@
 use alloc::collections::BTreeMap;
 
 use bitcoin::address::NetworkUnchecked;
+use bitcoin::bip32::{Xpriv, Xpub};
 use bitcoin::hashes::hash160;
 use bitcoin::{
     bip32, sign_message, Address, Amount, BlockHash, FeeRate, PrivateKey, Psbt, PublicKey,
@@ -284,6 +285,35 @@ pub struct GetBalancesWatchOnly {
     pub immature: Amount,
 }
 
+/// Models the result of JSON-RPC method `gethdkeys`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetHdKeys(pub Vec<HdKey>);
+
+/// An HD key entry returned by `gethdkeys`.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct HdKey {
+    /// The extended public key.
+    pub xpub: Xpub,
+    /// Whether the wallet has the private key for this xpub.
+    pub has_private: bool,
+    /// The extended private key if "private" is true.
+    pub xpriv: Option<Xpriv>,
+    /// Array of descriptor objects that use this HD key.
+    pub descriptors: Vec<HdKeyDescriptor>,
+}
+
+/// Descriptor object used in `gethdkeys` result.
+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct HdKeyDescriptor {
+    /// Descriptor string representation.
+    pub descriptor: String,
+    /// Whether this descriptor is currently used to generate new addresses.
+    pub active: bool,
+}
+
 /// Models the result of JSON-RPC method `getnewaddress`.
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
 #[serde(deny_unknown_fields)]

types/src/v28/mod.rs

@@ -184,7 +184,7 @@
 //! | getaddressinfo                     | version + model |                                        |
 //! | getbalance                         | version + model |                                        |
 //! | getbalances                        | version + model |                                        |
-//! | gethdkeys                          | version + model | TODO                                   |
+//! | gethdkeys                          | version + model |                                        |
 //! | getnewaddress                      | version + model |                                        |
 //! | getrawchangeaddress                | version + model |                                        |
 //! | getreceivedbyaddress               | version + model |                                        |
@@ -267,7 +267,7 @@ pub use self::{
         SubmitPackage, SubmitPackageError, SubmitPackageTxResult, SubmitPackageTxResultError,
         SubmitPackageTxResultFees, SubmitPackageTxResultFeesError,
     },
-    wallet::{GetAddressInfo, GetAddressInfoEmbedded, GetTransaction},
+    wallet::{GetAddressInfo, GetAddressInfoEmbedded, GetHdKeys, HdKey, HdKeyDescriptor, GetHdKeysError, GetTransaction},
 };
 #[doc(inline)]
 pub use crate::{

types/src/v28/wallet/error.rs

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: CC0-1.0
+
+use core::fmt;
+
+use bitcoin::bip32;
+
+use crate::error::write_err;
+use crate::NumericError;
+
+/// Error when converting a `GetHdKeys` type into the model type.
+#[derive(Debug)]
+pub enum GetHdKeysError {
+    /// Conversion of the `xpub` field failed.
+    Xpub(bip32::Error),
+    /// Conversion of the `xpriv` field failed.
+    Xpriv(bip32::Error),
+    /// Conversion of numeric type to expected type failed.
+    Numeric(NumericError),
+}
+
+impl fmt::Display for GetHdKeysError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use GetHdKeysError::*;
+        match *self {
+            Xpub(ref e) => write_err!(f, "conversion of the `xpub` field failed"; e),
+            Xpriv(ref e) => write_err!(f, "conversion of the `xpriv` field failed"; e),
+            Numeric(ref e) => write_err!(f, "numeric"; e),
+        }
+    }
+}
+
+#[cfg(feature = "std")]
+impl std::error::Error for GetHdKeysError {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        use GetHdKeysError::*;
+        match *self {
+            Xpub(ref e) => Some(e),
+            Xpriv(ref e) => Some(e),
+            Numeric(ref e) => Some(e),
+        }
+    }
+}
+
+impl From<NumericError> for GetHdKeysError {
+    fn from(e: NumericError) -> Self { Self::Numeric(e) }
+}

types/src/v28/wallet/into.rs

@@ -11,7 +11,7 @@ use bitcoin::{
 
 use super::{
     GetAddressInfo, GetAddressInfoEmbedded, GetAddressInfoEmbeddedError, GetAddressInfoError,
-    GetTransaction, GetTransactionError,
+    GetHdKeys, GetHdKeysError, GetTransaction, GetTransactionError,
 };
 use crate::model;
 
@@ -155,6 +155,33 @@ impl GetAddressInfoEmbedded {
     }
 }
 
+impl GetHdKeys {
+    /// Converts version specific type to a version nonspecific, more strongly typed type.
+    pub fn into_model(self) -> Result<model::GetHdKeys, GetHdKeysError> {
+        let keys = self
+            .0
+            .into_iter()
+            .map(|item| {
+                let xpub = item.xpub.parse().map_err(GetHdKeysError::Xpub)?;
+                let xpriv = match item.xpriv {
+                    Some(xpriv) => Some(xpriv.parse().map_err(GetHdKeysError::Xpriv)?),
+                    None => None,
+                };
+                let descriptors = item
+                    .descriptors
+                    .into_iter()
+                    .map(|desc| model::HdKeyDescriptor {
+                        descriptor: desc.descriptor,
+                        active: desc.active,
+                    })
+                    .collect();
+                Ok(model::HdKey { xpub, has_private: item.has_private, xpriv, descriptors })
+            })
+            .collect::<Result<Vec<_>, GetHdKeysError>>()?;
+        Ok(model::GetHdKeys(keys))
+    }
+}
+
 impl GetTransaction {
     /// Converts version specific type to a version nonspecific, more strongly typed type.
     pub fn into_model(self) -> Result<model::GetTransaction, GetTransactionError> {

types/src/v28/wallet/mod.rs

@@ -4,9 +4,11 @@
 //!
 //! Types for methods found under the `== Wallet ==` section of the API docs.
 
+mod error;
 mod into;
 
 use bitcoin::Transaction;
+pub use error::GetHdKeysError;
 use serde::{Deserialize, Serialize};
 
 pub use super::{
@@ -144,6 +146,41 @@ pub struct GetAddressInfoEmbedded {
     pub labels: Option<Vec<String>>,
 }
 
+/// Result of the JSON-RPC method `gethdkeys`.
+///
+/// > gethdkeys ( {"active_only":bool,"private":bool,...} )
+/// >
+/// > List all BIP 32 HD keys in the wallet and which descriptors use them.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct GetHdKeys(pub Vec<HdKey>);
+
+/// HD key entry returned as part of `gethdkeys`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct HdKey {
+    /// The extended public key.
+    pub xpub: String,
+    /// Whether the wallet has the private key for this xpub.
+    pub has_private: bool,
+    /// The extended private key if "private" is true.
+    #[serde(rename = "xprv")]
+    pub xpriv: Option<String>,
+    /// Array of descriptor objects that use this HD key.
+    pub descriptors: Vec<HdKeyDescriptor>,
+}
+
+/// Descriptor object returned as part of `gethdkeys`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct HdKeyDescriptor {
+    /// Descriptor string representation.
+    #[serde(rename = "desc")]
+    pub descriptor: String,
+    /// Whether this descriptor is currently used to generate new addresses.
+    pub active: bool,
+}
+
 /// Result of the JSON-RPC method `gettransaction`.
 ///
 /// > gettransaction "txid" ( include_watchonly )