Merge #289: Address all TODO in v21

a150076 Add upgradewallet method and test (Jamil Lambert, PhD)
f855ead Add psbtbumpfee method, model and test (Jamil Lambert, PhD)
2eecd0f Add send method, model and test (Jamil Lambert, PhD)
0ed10d4 Add importdescriptors method, and test (Jamil Lambert, PhD)
5ee20ed Add create descriptor wallet fn to client (Jamil Lambert, PhD)
8e80267 Move v21 wallet module into subdirectory (Jamil Lambert, PhD)
ec52fad Add getindexinfo method, and test (Jamil Lambert, PhD)
73368d4 Add generateblock method, model and test (Jamil Lambert, PhD)

Pull request description:

  Go through all the `TODO` in the v21 types table. Add all the missing RPCs including models when required and tests.

  Add a new macro `create_wallet_with_descriptors` that creates a descriptor wallet for use with v21 and v22 where the default is a legacy wallet. This is required for the `importdescriptors` test.

  Move the `wallet` module to a subdirectory since there are multiple new RPCs in v21.

ACKs for top commit:
  tcharding:
    ACK a150076

Tree-SHA512: 945bde0bf1d0be6b867baa12a79d6f8b823a5e38f6930325d7b3794eb25f7a2f324ac725b99ff24a428dc36aa12f013b74ecd30bd66c1cf3d1b04be4d42388b0

Author: tcharding

client/src/client_sync/v21/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.21`.
+//!
+//! 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 `generateblock`
+#[macro_export]
+macro_rules! impl_client_v21__generate_block {
+    () => {
+        impl Client {
+            pub fn generate_block(
+                &self,
+                output: &str,
+                transactions: &[String],
+            ) -> Result<GenerateBlock> {
+                self.call("generateblock", &[into_json(output)?, into_json(transactions)?])
+            }
+        }
+    };
+}

client/src/client_sync/v21/mod.rs

@@ -4,13 +4,16 @@
 //!
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
+mod generating;
+mod util;
 mod wallet;
 
 use std::collections::BTreeMap;
 use std::path::Path;
 
 use bitcoin::address::{Address, NetworkChecked};
 use bitcoin::{sign_message, Amount, Block, BlockHash, PublicKey, Txid};
+use serde::{Deserialize, Serialize};
 
 use crate::client_sync::into_json;
 use crate::types::v21::*;
@@ -61,6 +64,7 @@ crate::impl_client_v17__stop!();
 crate::impl_client_v17__uptime!();
 
 // == Generating ==
+crate::impl_client_v21__generate_block!();
 crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
@@ -113,6 +117,7 @@ crate::impl_client_v17__create_multisig!();
 crate::impl_client_v18__derive_addresses!();
 crate::impl_client_v17__estimate_smart_fee!();
 crate::impl_client_v18__get_descriptor_info!();
+crate::impl_client_v21__get_index_info!();
 crate::impl_client_v17__sign_message_with_priv_key!();
 crate::impl_client_v17__validate_address!();
 crate::impl_client_v17__verify_message!();
@@ -124,6 +129,7 @@ crate::impl_client_v17__add_multisig_address!();
 crate::impl_client_v17__backup_wallet!();
 crate::impl_client_v17__bump_fee!();
 crate::impl_client_v17__create_wallet!();
+crate::impl_client_v21__create_wallet_with_descriptors!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
@@ -139,6 +145,7 @@ crate::impl_client_v17__get_transaction!();
 crate::impl_client_v17__get_unconfirmed_balance!();
 crate::impl_client_v17__get_wallet_info!();
 crate::impl_client_v17__import_address!();
+crate::impl_client_v21__import_descriptors!();
 crate::impl_client_v17__import_multi!();
 crate::impl_client_v17__import_privkey!();
 crate::impl_client_v17__import_pruned_funds!();
@@ -157,8 +164,10 @@ crate::impl_client_v18__list_wallet_dir!();
 crate::impl_client_v17__list_wallets!();
 crate::impl_client_v17__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
+crate::impl_client_v21__psbt_bump_fee!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
@@ -167,6 +176,17 @@ crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
+crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_process_psbt!();
+
+/// Request object for the `importdescriptors` method.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+#[serde(deny_unknown_fields)]
+pub struct ImportDescriptorsRequest {
+    /// Descriptor to import.
+    pub desc: String,
+    /// Time from which to start rescanning the blockchain for this descriptor, in UNIX epoch time or "now".
+    pub timestamp: serde_json::Value,
+}

client/src/client_sync/v21/util.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 `== Util ==` section of the
+//! API docs of Bitcoin Core `v0.21`.
+//!
+//! 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 `getindexinfo`.
+#[macro_export]
+macro_rules! impl_client_v21__get_index_info {
+    () => {
+        impl Client {
+            pub fn get_index_info(&self) -> Result<GetIndexInfo> { self.call("getindexinfo", &[]) }
+        }
+    };
+}

client/src/client_sync/v21/wallet.rs

@@ -9,6 +9,66 @@
 //!
 //! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `createwallet` with descriptors=true (descriptor wallet)
+#[macro_export]
+macro_rules! impl_client_v21__create_wallet_with_descriptors {
+    () => {
+        impl Client {
+            pub fn create_wallet_with_descriptors(&self, wallet: &str) -> Result<CreateWallet> {
+                let args = [
+                    wallet.into(),
+                    false.into(),            // disable_private_keys
+                    false.into(),            // blank
+                    serde_json::Value::Null, // passphrase
+                    false.into(),            // avoid_reuse
+                    true.into(),             // descriptors=true
+                    serde_json::Value::Null, // load_on_startup
+                ];
+                self.call("createwallet", &args)
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `importdescriptors`
+#[macro_export]
+macro_rules! impl_client_v21__import_descriptors {
+    () => {
+        impl Client {
+            pub fn import_descriptors(
+                &self,
+                requests: &[ImportDescriptorsRequest],
+            ) -> Result<ImportDescriptors> {
+                self.call("importdescriptors", &[into_json(requests)?])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `psbtbumpfee`.
+#[macro_export]
+macro_rules! impl_client_v21__psbt_bump_fee {
+    () => {
+        impl Client {
+            pub fn psbt_bump_fee(&self, txid: &bitcoin::Txid) -> Result<PsbtBumpFee> {
+                self.call("psbtbumpfee", &[into_json(txid)?])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `send`.
+#[macro_export]
+macro_rules! impl_client_v21__send {
+    () => {
+        impl Client {
+            pub fn send(&self, outputs: &BTreeMap<String, f64>) -> Result<Send> {
+                self.call("send", &[into_json(outputs)?])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `unloadwallet`
 #[macro_export]
 macro_rules! impl_client_v21__unload_wallet {
@@ -20,3 +80,15 @@ macro_rules! impl_client_v21__unload_wallet {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `upgradewallet`.
+#[macro_export]
+macro_rules! impl_client_v21__upgrade_wallet {
+    () => {
+        impl Client {
+            pub fn upgrade_wallet(&self) -> Result<UpgradeWallet> {
+                self.call("upgradewallet", &[])
+            }
+        }
+    };
+}

client/src/client_sync/v22/mod.rs

@@ -21,6 +21,7 @@ pub use crate::client_sync::{
         AddNodeCommand, AddressType, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest,
         TemplateRules, WalletCreateFundedPsbtInput,
     },
+    v21::ImportDescriptorsRequest,
 };
 
 crate::define_jsonrpc_minreq_client!("v22");
@@ -61,6 +62,7 @@ crate::impl_client_v17__stop!();
 crate::impl_client_v17__uptime!();
 
 // == Generating ==
+crate::impl_client_v21__generate_block!();
 crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
@@ -113,6 +115,7 @@ crate::impl_client_v17__create_multisig!();
 crate::impl_client_v18__derive_addresses!();
 crate::impl_client_v17__estimate_smart_fee!();
 crate::impl_client_v18__get_descriptor_info!();
+crate::impl_client_v21__get_index_info!();
 crate::impl_client_v17__sign_message_with_priv_key!();
 crate::impl_client_v17__validate_address!();
 crate::impl_client_v17__verify_message!();
@@ -124,6 +127,7 @@ crate::impl_client_v17__add_multisig_address!();
 crate::impl_client_v17__backup_wallet!();
 crate::impl_client_v17__bump_fee!();
 crate::impl_client_v17__create_wallet!();
+crate::impl_client_v21__create_wallet_with_descriptors!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
@@ -139,6 +143,7 @@ crate::impl_client_v17__get_transaction!();
 crate::impl_client_v17__get_unconfirmed_balance!();
 crate::impl_client_v17__get_wallet_info!();
 crate::impl_client_v17__import_address!();
+crate::impl_client_v21__import_descriptors!();
 crate::impl_client_v17__import_multi!();
 crate::impl_client_v17__import_privkey!();
 crate::impl_client_v17__import_pruned_funds!();
@@ -157,8 +162,10 @@ crate::impl_client_v18__list_wallet_dir!();
 crate::impl_client_v17__list_wallets!();
 crate::impl_client_v17__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
+crate::impl_client_v21__psbt_bump_fee!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
@@ -167,6 +174,7 @@ crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
+crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_process_psbt!();

client/src/client_sync/v23/mod.rs

@@ -23,6 +23,7 @@ pub use crate::client_sync::{
         AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
         WalletCreateFundedPsbtInput,
     },
+    v21::ImportDescriptorsRequest,
 };
 
 crate::define_jsonrpc_minreq_client!("v23");
@@ -63,6 +64,7 @@ crate::impl_client_v17__stop!();
 crate::impl_client_v17__uptime!();
 
 // == Generating ==
+crate::impl_client_v21__generate_block!();
 crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
@@ -115,6 +117,7 @@ crate::impl_client_v17__create_multisig!();
 crate::impl_client_v18__derive_addresses!();
 crate::impl_client_v17__estimate_smart_fee!();
 crate::impl_client_v18__get_descriptor_info!();
+crate::impl_client_v21__get_index_info!();
 crate::impl_client_v17__sign_message_with_priv_key!();
 crate::impl_client_v17__validate_address!();
 crate::impl_client_v17__verify_message!();
@@ -126,6 +129,7 @@ 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_v21__create_wallet_with_descriptors!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
@@ -141,6 +145,7 @@ crate::impl_client_v17__get_transaction!();
 crate::impl_client_v17__get_unconfirmed_balance!();
 crate::impl_client_v17__get_wallet_info!();
 crate::impl_client_v17__import_address!();
+crate::impl_client_v21__import_descriptors!();
 crate::impl_client_v17__import_multi!();
 crate::impl_client_v17__import_privkey!();
 crate::impl_client_v17__import_pruned_funds!();
@@ -159,8 +164,10 @@ crate::impl_client_v18__list_wallet_dir!();
 crate::impl_client_v17__list_wallets!();
 crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
+crate::impl_client_v21__psbt_bump_fee!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
@@ -169,6 +176,7 @@ crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
+crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_process_psbt!();

client/src/client_sync/v24/mod.rs

@@ -19,6 +19,7 @@ pub use crate::client_sync::{
         AddNodeCommand, ImportMultiRequest, ImportMultiScriptPubKey, ImportMultiTimestamp, Input, Output, SetBanCommand, TemplateRequest, TemplateRules,
         WalletCreateFundedPsbtInput,
     },
+    v21::ImportDescriptorsRequest,
     v23::AddressType,
 };
 
@@ -60,6 +61,7 @@ crate::impl_client_v17__stop!();
 crate::impl_client_v17__uptime!();
 
 // == Generating ==
+crate::impl_client_v21__generate_block!();
 crate::impl_client_v17__generate_to_address!();
 crate::impl_client_v20__generate_to_descriptor!();
 crate::impl_client_v17__invalidate_block!();
@@ -112,6 +114,7 @@ crate::impl_client_v17__create_multisig!();
 crate::impl_client_v18__derive_addresses!();
 crate::impl_client_v17__estimate_smart_fee!();
 crate::impl_client_v18__get_descriptor_info!();
+crate::impl_client_v21__get_index_info!();
 crate::impl_client_v17__sign_message_with_priv_key!();
 crate::impl_client_v17__validate_address!();
 crate::impl_client_v17__verify_message!();
@@ -123,6 +126,7 @@ 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_v21__create_wallet_with_descriptors!();
 crate::impl_client_v17__dump_priv_key!();
 crate::impl_client_v17__dump_wallet!();
 crate::impl_client_v17__encrypt_wallet!();
@@ -138,6 +142,7 @@ crate::impl_client_v17__get_transaction!();
 crate::impl_client_v17__get_unconfirmed_balance!();
 crate::impl_client_v17__get_wallet_info!();
 crate::impl_client_v17__import_address!();
+crate::impl_client_v21__import_descriptors!();
 crate::impl_client_v17__import_multi!();
 crate::impl_client_v17__import_privkey!();
 crate::impl_client_v17__import_pruned_funds!();
@@ -156,8 +161,10 @@ crate::impl_client_v18__list_wallet_dir!();
 crate::impl_client_v17__list_wallets!();
 crate::impl_client_v22__load_wallet!();
 crate::impl_client_v17__lock_unspent!();
+crate::impl_client_v21__psbt_bump_fee!();
 crate::impl_client_v17__remove_pruned_funds!();
 crate::impl_client_v17__rescan_blockchain!();
+crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
@@ -166,6 +173,7 @@ crate::impl_client_v19__set_wallet_flag!();
 crate::impl_client_v17__sign_message!();
 crate::impl_client_v17__sign_raw_transaction_with_wallet!();
 crate::impl_client_v21__unload_wallet!();
+crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();
 crate::impl_client_v17__wallet_lock!();
 crate::impl_client_v17__wallet_process_psbt!();