Merge #308: Address all TODO in v24

78cbbdc Run the formatter (Jamil Lambert, PhD)
2125b02 Add simulaterawtransaction method, model and test (Jamil Lambert, PhD)
3a9e9be Add migratewallet method and test (Jamil Lambert, PhD)
976bb9e Increase client timeout (Jamil Lambert, PhD)
5adeeae Add sendall method, model and test (Jamil Lambert, PhD)
8610326 Add gettxspendingprevout method, model and test (Jamil Lambert, PhD)

Pull request description:

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

  - Add `gettxspendingprevout` method, model and test
  - Add `sendall` method, model and test
  - Increase `client` timeout - The `migratewallet` RPC call takes about 30sec on v24, it's a lot faster on v29. The default timeout was 15sec, increase it to 60 to prevent the timeout during testing. To quote Core "This RPC may take a long time to complete. Increasing the RPC client timeout is recommended."
  - Add `migratewallet` method, and test - The help says that `passphrase` is required in v24, but it isn't. The optional argument `wallet_name` was required for testing.  There is nothing to model so the types table was updated accordingly.
  - Add `simulaterawtransaction` method, model and test - The help says that the `rawtxs` are optional, but they
   are required for testing or nothing is simulated.
  - Run the formatter

ACKs for top commit:
  tcharding:
    ACK 78cbbdc

Tree-SHA512: 5ceaa4056111d355e87336109f0872f23618dd8bc21be54a66350d26bf1b223041dd2becce99198981cf3fe3e585f88a3615e607f8f53644ede86fc85535e8f2

Author: tcharding

client/src/client_sync/mod.rs

@@ -83,6 +83,7 @@ macro_rules! define_jsonrpc_minreq_client {
                 let transport = jsonrpc::http::minreq_http::Builder::new()
                     .url(url)
                     .expect("jsonrpc v0.18, this function does not error")
+                    .timeout(std::time::Duration::from_secs(60))
                     .build();
                 let inner = jsonrpc::client::Client::with_transport(transport);
 
@@ -99,6 +100,7 @@ macro_rules! define_jsonrpc_minreq_client {
                 let transport = jsonrpc::http::minreq_http::Builder::new()
                     .url(url)
                     .expect("jsonrpc v0.18, this function does not error")
+                    .timeout(std::time::Duration::from_secs(60))
                     .basic_auth(user.unwrap(), pass)
                     .build();
                 let inner = jsonrpc::client::Client::with_transport(transport);

client/src/client_sync/v24/blockchain.rs

@@ -0,0 +1,31 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Blockchain ==` section of the
+//! API docs of Bitcoin Core `v24`.
+//!
+//! 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 `gettxspendingprevout`
+#[macro_export]
+macro_rules! impl_client_v24__get_tx_spending_prevout {
+    () => {
+        impl Client {
+            pub fn get_tx_spending_prevout(
+                &self,
+                outputs: &[bitcoin::OutPoint],
+            ) -> Result<GetTxSpendingPrevout> {
+                let json_outputs: Vec<_> = outputs.iter().map(|out| {
+                    serde_json::json!({
+                        "txid": out.txid.to_string(),
+                        "vout": out.vout,
+                    })
+                }).collect();
+                self.call("gettxspendingprevout", &[json_outputs.into()])
+            }
+        }
+    };
+}

client/src/client_sync/v24/mod.rs

@@ -4,6 +4,9 @@
 //!
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
+pub mod blockchain;
+pub mod wallet;
+
 use std::collections::BTreeMap;
 use std::path::Path;
 
@@ -48,6 +51,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v17__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -166,19 +170,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v24/wallet.rs

@@ -0,0 +1,49 @@
+// 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 `v24`.
+//!
+//! 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 `migratewallet`.
+#[macro_export]
+macro_rules! impl_client_v24__migrate_wallet {
+    () => {
+        impl Client {
+            pub fn migrate_wallet(&self, wallet_name: &str) -> Result<MigrateWallet> {
+                self.call("migratewallet", &[wallet_name.into()])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `sendall`.
+#[macro_export]
+macro_rules! impl_client_v24__send_all {
+    () => {
+        impl Client {
+            pub fn send_all(&self, recipients: &[Address]) -> Result<SendAll> {
+                self.call("sendall", &[into_json(recipients)?])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `simulaterawtransaction`.
+#[macro_export]
+macro_rules! impl_client_v24__simulate_raw_transaction {
+    () => {
+        impl Client {
+            pub fn simulate_raw_transaction(
+                &self,
+                rawtxs: &[String],
+            ) -> Result<SimulateRawTransaction> {
+                self.call("simulaterawtransaction", &[into_json(rawtxs)?])
+            }
+        }
+    };
+}

client/src/client_sync/v25/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v17__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -168,19 +169,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v26/mod.rs

@@ -52,6 +52,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -172,19 +173,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v27/mod.rs

@@ -48,6 +48,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -168,19 +169,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v28/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -170,19 +171,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

client/src/client_sync/v29/mod.rs

@@ -50,6 +50,7 @@ crate::impl_client_v17__get_raw_mempool!();
 crate::impl_client_v17__get_tx_out!();
 crate::impl_client_v17__get_tx_out_proof!();
 crate::impl_client_v26__get_tx_out_set_info!();
+crate::impl_client_v24__get_tx_spending_prevout!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -170,19 +171,22 @@ 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_v24__migrate_wallet!();
 crate::impl_client_v23__new_keypool!();
 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_v24__send_all!();
 crate::impl_client_v17__send_many!();
 crate::impl_client_v17__send_to_address!();
 crate::impl_client_v17__set_hd_seed!();
 crate::impl_client_v17__set_tx_fee!();
 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_v24__simulate_raw_transaction!();
 crate::impl_client_v21__unload_wallet!();
 crate::impl_client_v21__upgrade_wallet!();
 crate::impl_client_v17__wallet_create_funded_psbt!();

integration_test/tests/blockchain.rs

@@ -302,6 +302,35 @@ fn blockchain__get_tx_out_set_info__modelled() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v23_and_below"))]
+fn blockchain__get_tx_spending_prevout__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+
+    let (_address1, txid_1) = node.create_mempool_transaction();
+    let (_address2, txid_2) = node.create_mempool_transaction();
+
+    let inputs = vec![
+        bitcoin::OutPoint {
+            txid: txid_1,
+            vout: 0,
+        },
+        bitcoin::OutPoint {
+            txid: txid_2,
+            vout: 0,
+        },
+    ];
+
+    let json: GetTxSpendingPrevout = node.client.get_tx_spending_prevout(&inputs).expect("gettxspendingprevout");
+    let model: Result<mtype::GetTxSpendingPrevout, GetTxSpendingPrevoutError> = json.into_model();
+    let spending_prevout = model.unwrap();
+
+    assert_eq!(spending_prevout.0.len(), 2);
+    assert_eq!(spending_prevout.0[0].outpoint.txid, txid_1);
+    assert_eq!(spending_prevout.0[0].outpoint.vout, 0);
+}
+
 #[test]
 fn blockchain__precious_block() {
     let node = Node::with_wallet(Wallet::Default, &[]);