Merge #322: Address all TODO in v28

82b70b8 Run the formatter (Jamil Lambert, PhD)
f8a832c Add createwalletdescriptor method and test (Jamil Lambert, PhD)
7f9c840 Add gethdkeys method model and test (Jamil Lambert, PhD)

Pull request description:

  Go through all the TODO in the v28 types table. Add all the missing RPCs.

  - Add `gethdkeys` method, model and test..
  - Add `createwalletdescriptor` method and test. This was labelled as model, but there is nothing to model. Update the types table to reflect this, `verify` was already correct and says no_model.
  - Run the formatter.

ACKs for top commit:
  tcharding:
    ACK 82b70b8

Tree-SHA512: 7b40588df326c026c785f45ec76d39834724bdd9599ce21261b5b64e6c262495325134e7602edac5d530433fb0a0df3f07a55581b0bbfc678f2d4490507b60e6

Author: tcharding

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;
@@ -141,13 +142,15 @@ crate::impl_client_v17__add_multisig_address!();
 crate::impl_client_v17__backup_wallet!();
 crate::impl_client_v17__bump_fee!();
 crate::impl_client_v23__create_wallet!();
+crate::impl_client_v28__create_wallet_descriptor!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
 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,33 @@
+// 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", &[]) }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `createwalletdescriptor`.
+#[macro_export]
+macro_rules! impl_client_v28__create_wallet_descriptor {
+    () => {
+        impl Client {
+            pub fn create_wallet_descriptor(&self, address_type: &str, hdkey: &str) -> Result<CreateWalletDescriptor> {
+                let hdkey = serde_json::json!({ "hdkey": hdkey });
+                self.call("createwalletdescriptor", &[address_type.into(), hdkey.into()])
+            }
+        }
+    };
+}

client/src/client_sync/v29/mod.rs

@@ -142,13 +142,15 @@ crate::impl_client_v17__add_multisig_address!();
 crate::impl_client_v17__backup_wallet!();
 crate::impl_client_v17__bump_fee!();
 crate::impl_client_v23__create_wallet!();
+crate::impl_client_v28__create_wallet_descriptor!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
 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

@@ -6,6 +6,7 @@
 #![allow(unused_imports)] // Some imports are only used in specific versions.
 
 use bitcoin::address::{Address, KnownHrp, NetworkChecked};
+use bitcoin::bip32::{Xpriv, Xpub};
 use bitcoin::{secp256k1, Amount, CompressedPublicKey, FeeRate, Network, PrivateKey, PublicKey};
 use integration_test::{Node, NodeExt as _, Wallet};
 use node::{mtype, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp};
@@ -118,6 +119,40 @@ fn wallet__create_wallet__modelled() {
     let _ = Node::with_wallet(Wallet::Default, &[]);
 }
 
+#[test]
+#[cfg(not(feature = "v27_and_below"))]
+fn wallet__create_wallet_descriptor() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+
+    // BIP32 HD xprv/xpub for the creation of a descriptor with a private key that is in the wallet.
+    let secp = secp256k1::Secp256k1::new();
+    let seed = [0u8; 32];
+    let xprv = Xpriv::new_master(Network::Regtest, &seed).unwrap();
+    let xpub = Xpub::from_priv(&secp, &xprv);
+    let hdkey = xpub.to_string();
+
+    // Import the private key into the wallet.
+    let privkey = bitcoin::PrivateKey {
+        compressed: true,
+        network: Network::Regtest.into(),
+        inner: xprv.private_key,
+    };
+    let wif = privkey.to_wif();
+    let raw_descriptor = format!("wpkh({})", wif);
+    let info = node.client.get_descriptor_info(&raw_descriptor).expect("get_descriptor_info");
+    let descriptor = format!("{}#{}", raw_descriptor, info.checksum);
+
+    let import_req = ImportDescriptorsRequest::new(descriptor, 0);
+    node.client.import_descriptors(&[import_req]).expect("importdescriptors");
+
+    let json = node.client.create_wallet_descriptor("bech32", &hdkey)
+        .expect("createwalletdescriptor");
+
+    // Check that a SigWit descriptor was created.
+    let prefix = &json.descriptors[0][0..4];
+    assert_eq!(prefix, "wpkh");
+}
+
 #[test]
 fn wallet__dump_priv_key__modelled() {
     // As of Core v23 the default wallet is an native descriptor wallet which does not
@@ -247,6 +282,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

@@ -53,15 +53,15 @@ pub use self::{
     wallet::{
         AddMultisigAddress, AddressInformation, AddressPurpose, Bip125Replaceable, BumpFee,
         CreateWallet, DumpPrivKey, GetAddressInfo, GetAddressInfoEmbedded, GetAddressesByLabel,
-        GetBalance, GetBalances, GetBalancesMine, GetBalancesWatchOnly, GetNewAddress,
+        GetBalance, GetBalances, GetBalancesMine, GetBalancesWatchOnly, GetHdKeys, GetNewAddress,
         GetRawChangeAddress, GetReceivedByAddress, GetReceivedByLabel, GetTransaction,
-        GetTransactionDetail, GetUnconfirmedBalance, GetWalletInfo, LastProcessedBlock,
-        ListAddressGroupings, ListAddressGroupingsItem, ListLabels, ListLockUnspent,
-        ListLockUnspentItem, ListReceivedByAddress, ListReceivedByAddressItem, ListReceivedByLabel,
-        ListReceivedByLabelItem, ListSinceBlock, ListSinceBlockTransaction, ListTransactions,
-        ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets, LoadWallet, PsbtBumpFee,
-        RescanBlockchain, ScriptType, Send, SendAll, SendMany, SendToAddress, SignMessage,
-        SimulateRawTransaction, TransactionCategory, UnloadWallet, WalletCreateFundedPsbt,
-        WalletDisplayAddress, WalletProcessPsbt,
+        GetTransactionDetail, GetUnconfirmedBalance, GetWalletInfo, HdKey, HdKeyDescriptor,
+        LastProcessedBlock, ListAddressGroupings, ListAddressGroupingsItem, ListLabels,
+        ListLockUnspent, ListLockUnspentItem, ListReceivedByAddress, ListReceivedByAddressItem,
+        ListReceivedByLabel, ListReceivedByLabelItem, ListSinceBlock, ListSinceBlockTransaction,
+        ListTransactions, ListTransactionsItem, ListUnspent, ListUnspentItem, ListWallets,
+        LoadWallet, PsbtBumpFee, RescanBlockchain, ScriptType, Send, SendAll, SendMany,
+        SendToAddress, SignMessage, SimulateRawTransaction, TransactionCategory, UnloadWallet,
+        WalletCreateFundedPsbt, WalletDisplayAddress, WalletProcessPsbt,
     },
 };

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

@@ -176,15 +176,15 @@
 //! | backupwallet                       | returns nothing |                                        |
 //! | bumpfee                            | version + model |                                        |
 //! | createwallet                       | version + model |                                        |
-//! | createwalletdescriptor             | version + model | TODO                                   |
+//! | createwalletdescriptor             | version         |                                        |
 //! | dumpprivkey                        | version + model |                                        |
 //! | dumpwallet                         | version + model |                                        |
 //! | encryptwallet                      | version         |                                        |
 //! | getaddressesbylabel                | version + model |                                        |
 //! | 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,10 @@ pub use self::{
         SubmitPackage, SubmitPackageError, SubmitPackageTxResult, SubmitPackageTxResultError,
         SubmitPackageTxResultFees, SubmitPackageTxResultFeesError,
     },
-    wallet::{GetAddressInfo, GetAddressInfoEmbedded, GetTransaction},
+    wallet::{
+        CreateWalletDescriptor, GetAddressInfo, GetAddressInfoEmbedded, GetHdKeys, GetHdKeysError,
+        GetTransaction, HdKey, HdKeyDescriptor,
+    },
 };
 #[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> {