Merge #301: Address all TODO in v23

828454a Run the formatter (Jamil Lambert, PhD)
9e6f836 Add getdeploymentinfo struct, model and test (Jamil Lambert, PhD)
869f0c4 Add newkeypool macro and test (Jamil Lambert, PhD)
5429040 Add restorewallet struct, macro and test (Jamil Lambert, PhD)
6ffbf1d Add getblockfrompeer macro and test (Jamil Lambert, PhD)

Pull request description:

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

  - Add getblockfrompeer macro and test
  - Add restorewallet struct, macro and test
  - Add newkeypool macro and test
  - Add getdeploymentinfo struct, model and test
  - Run the formatter

ACKs for top commit:
  tcharding:
    ACK 828454a

Tree-SHA512: 6298568c5646287f7d5eb1ba6ed745cc978cabe76e7202770cf42f07ae07007bbb97d31a244c5635b1b2a06802b2078c290796ac7bf3a03947c6ed950a5252a1

Author: tcharding

client/src/client_sync/v23/blockchain.rs

@@ -9,6 +9,34 @@
 //!
 //! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `getblockfrompeer`
+#[macro_export]
+macro_rules! impl_client_v23__get_block_from_peer {
+    () => {
+        impl Client {
+            pub fn get_block_from_peer(&self, blockhash: BlockHash, peer_id: u32) -> Result<()> {
+                match self.call("getblockfrompeer", &[into_json(blockhash)?, into_json(peer_id)?]) {
+                    Ok(serde_json::Value::Object(ref map)) if map.is_empty() => Ok(()),
+                    Ok(res) => Err(Error::Returned(res.to_string())),
+                    Err(err) => Err(err.into()),
+                }
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getdeploymentinfo`.
+#[macro_export]
+macro_rules! impl_client_v23__get_deployment_info {
+    () => {
+        impl Client {
+            pub fn get_deployment_info(&self, blockhash: &BlockHash) -> Result<GetDeploymentInfo> {
+                self.call("getdeploymentinfo", &[into_json(blockhash)?])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `savemempool`
 #[macro_export]
 macro_rules! impl_client_v23__save_mempool {

client/src/client_sync/v23/mod.rs

@@ -35,11 +35,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -168,9 +170,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v23/wallet.rs

@@ -56,3 +56,44 @@ macro_rules! impl_client_v23__create_wallet {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `newkeypool`.
+#[macro_export]
+macro_rules! impl_client_v23__new_keypool {
+    () => {
+        impl Client {
+            /// Calls `newkeypool` for the loaded wallet.
+            ///
+            /// > newkeypool
+            /// >
+            /// > Entirely clears and refills the keypool.
+            /// > Requires wallet passphrase to be set if wallet is encrypted.
+            pub fn new_keypool(&self) -> Result<()> {
+                match self.call("newkeypool", &[]) {
+                    Ok(serde_json::Value::Null) => Ok(()),
+                    Ok(res) => Err(Error::Returned(res.to_string())),
+                    Err(err) => Err(err.into()),
+                }
+            }
+        }
+    };
+}
+
+/// 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

@@ -32,11 +32,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -165,9 +167,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v25/mod.rs

@@ -34,11 +34,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -167,9 +169,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v26/mod.rs

@@ -36,11 +36,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -171,9 +173,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v27/mod.rs

@@ -32,11 +32,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -167,9 +169,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v28/mod.rs

@@ -34,11 +34,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
 crate::impl_client_v17__get_mempool_descendants!();
@@ -169,9 +171,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

client/src/client_sync/v29/mod.rs

@@ -33,11 +33,13 @@ crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
 crate::impl_client_v17__get_block_count!();
 crate::impl_client_v19__get_block_filter!();
+crate::impl_client_v23__get_block_from_peer!();
 crate::impl_client_v17__get_block_hash!();
 crate::impl_client_v17__get_block_header!();
 crate::impl_client_v17__get_block_stats!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
+crate::impl_client_v23__get_deployment_info!();
 crate::impl_client_v29__get_descriptor_activity!();
 crate::impl_client_v17__get_difficulty!();
 crate::impl_client_v17__get_mempool_ancestors!();
@@ -169,9 +171,11 @@ 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_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_v17__send_many!();
 crate::impl_client_v17__send_to_address!();

integration_test/tests/blockchain.rs

@@ -65,6 +65,37 @@ fn blockchain__get_block_filter__modelled() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v22_and_below"))]
+fn blockchain__get_block_from_peer() {
+    use bitcoin::hashes::Hash;
+    let (node1, _node2, _node3) = integration_test::three_node_network();
+
+    let now = std::time::SystemTime::now()
+        .duration_since(std::time::UNIX_EPOCH)
+        .expect("Time went backwards")
+        .as_secs() as u32;
+
+    // Create a dummy header and submit it
+    let mut header = bitcoin::block::Header {
+        version: bitcoin::block::Version::from_consensus(0x20000000),
+        prev_blockhash: node1.client.best_block_hash().expect("best_block_hash failed"),
+        merkle_root: bitcoin::TxMerkleNode::all_zeros(),
+        time: now,
+        bits: bitcoin::CompactTarget::from_consensus(0x207fffff),
+        nonce: 0,
+    };
+    let target = header.target();
+    while header.validate_pow(target).is_err() {
+        header.nonce += 1;
+    }
+    node1.client.submit_header(&header).expect("submit_header failed");
+
+    let hash = header.block_hash();
+    let peer_id = node1.client.get_peer_info().expect("getpeerinfo").0[0].id;
+    let _: () = node1.client.get_block_from_peer(hash, peer_id).expect("getblockfrompeer");
+}
+
 #[test]
 fn blockchain__get_block_hash__modelled() {
     let node = Node::with_wallet(Wallet::None, &[]);
@@ -147,6 +178,17 @@ fn blockchain__get_chain_tx_stats__modelled() {
     model.unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v22_and_below"))]
+fn blockchain__get_deployment_info__modelled() {
+    let node = Node::with_wallet(Wallet::None, &[]);
+    let block_hash = node.client.best_block_hash().expect("best_block_hash failed");
+
+    let json: GetDeploymentInfo = node.client.get_deployment_info(&block_hash).expect("getdeploymentinfo");
+    let model: Result<mtype::GetDeploymentInfo, GetDeploymentInfoError> = json.into_model();
+    model.unwrap();
+}
+
 #[test]
 #[cfg(not(feature = "v28_and_below"))]
 fn blockchain__get_descriptor_activity__modelled() {