Add restorewallet struct, macro and test

Add to the existing `backup_wallet` test, since the backup is needed
before restoring.

Split out the test into backup_and_restore_wallet()
to make it clear this is for multiple RPCs.

Add an empty test for restorewallet with a comment saying it is tested
as part of backupwallet.

Author: jamillambert

client/src/client_sync/v23/mod.rs

@@ -172,6 +172,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v23/wallet.rs

@@ -56,3 +56,22 @@ macro_rules! impl_client_v23__create_wallet {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `restorewallet`.
+#[macro_export]
+macro_rules! impl_client_v23__restore_wallet {
+    () => {
+        impl Client {
+            /// Calls `restorewallet` with required and optional arguments.
+            ///
+            /// > restorewallet "wallet_name" "backup_file" ( load_on_startup )
+            pub fn restore_wallet(
+                &self,
+                wallet_name: &str,
+                backup_file: &Path,
+            ) -> Result<RestoreWallet> {
+                self.call("restorewallet", &[wallet_name.into(), into_json(backup_file)?])
+            }
+        }
+    };
+}

client/src/client_sync/v24/mod.rs

@@ -169,6 +169,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v25/mod.rs

@@ -171,6 +171,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v26/mod.rs

@@ -175,6 +175,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v27/mod.rs

@@ -171,6 +171,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v28/mod.rs

@@ -173,6 +173,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v29/mod.rs

@@ -173,6 +173,7 @@ 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_v23__restore_wallet!();
 crate::impl_client_v21__send!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

integration_test/tests/wallet.rs

@@ -66,13 +66,26 @@ fn wallet__add_multisig_address__modelled() {
 
 #[test]
 fn wallet__backup_wallet() {
+    backup_and_restore_wallet()
+}
+
+fn backup_and_restore_wallet() {
     let node = Node::with_wallet(Wallet::Default, &[]);
     let file_path = integration_test::random_tmp_file();
 
     let _: () = node.client.backup_wallet(&file_path).expect("backupwallet");
     assert!(file_path.exists(), "Backup file should exist at destination");
     assert!(file_path.is_file(), "Backup destination should be a file");
 
+    // Restore wallet only available for v23 and above.
+    #[cfg(not(feature = "v22_and_below"))]
+    {
+        let wallet_name = "test_wallet";
+        let node2 = Node::with_wallet(Wallet::None, &[]);
+        let restored_wallet: RestoreWallet = node2.client.restore_wallet(wallet_name, &file_path).expect("restorewallet");
+        assert_eq!(restored_wallet.name, wallet_name);
+    }
+
     fs::remove_file(&file_path).expect("removefile");
 }
 
@@ -595,6 +608,11 @@ fn wallet__remove_pruned_funds() {
     let _: () = node.client.remove_pruned_funds(txid).expect("removeprunedfunds");
 }
 
+// This is tested in `backup_and_restore_wallet()`, called by wallet__backup_wallet()
+#[cfg(not(feature = "v22_and_below"))]
+#[test]
+fn wallet__restore_wallet() {}
+
 // This is tested in raw_transactions.rs `create_sign_send()`.
 #[test]
 fn wallet__sign_raw_transaction_with_wallet__modelled() {}

types/src/v23/mod.rs

@@ -205,7 +205,7 @@
 //! | lockunspent                        | version         |                                        |
 //! | removeprunedfunds                  | returns nothing |                                        |
 //! | rescanblockchain                   | version + model | UNTESTED                               |
-//! | restorewallet                      | version + model | TODO                                   |
+//! | restorewallet                      | version         |                                        |
 //! | send                               | version + model |                                        |
 //! | sendmany                           | version + model | UNTESTED                               |
 //! | sendtoaddress                      | version + model |                                        |
@@ -253,7 +253,7 @@ pub use self::{
         PsbtInput, PsbtOutput,
     },
     util::CreateMultisig,
-    wallet::{GetTransaction, GetTransactionError},
+    wallet::{GetTransaction, GetTransactionError, RestoreWallet},
 };
 #[doc(inline)]
 pub use crate::{