Merge #314: Address all TODO in v26

cb12454 Run the formatter (Jamil Lambert, PhD)
37b0821 Add getaddrmaninfo struct and test (Jamil Lambert, PhD)
9ee00e0 Redefine getprioritisedtransactions (Jamil Lambert, PhD)
e163f93 Implement importmempool method and test (Jamil Lambert, PhD)
90df558 Add getchainstates method, model and test (Jamil Lambert, PhD)
0d7f6ce Add loadtxoutset method and model (Jamil Lambert, PhD)
6f5145d Add dumptxoutset method, model and test (Jamil Lambert, PhD)
c891dc9 Move v26 blockchain to subdirectory (Jamil Lambert, PhD)

Pull request description:

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

  - Move the blockchain module to a subdirectory with separate `into.rs` and `error.rs` files in preparation for adding the new RPCs. Code move only.
  - Add `dumptxoutset` method, model and test. An extra required (help says optional) argument was added in v29, update the client macro and test.
  - Add `loadtxoutset` method and model. It was not possible to test this, opened Issue #313.
  - Add `getchainstates` method, model and test.  Extra return fields added in v29, redefine the struct and into_model fn.
  - Implement `importmempool` method and test. Returns an empty json object, add the client macro and test.
  - Redefine getprioritisedtransactions. Add the extra return field in v27. Also change the model so that the `fee_delta` is an `Amount`.
  - Add getaddrmaninfo struct and test. Was marked as having a model, but nothing to model. Update the types table.
  - Run the formatter.

ACKs for top commit:
  tcharding:
    ACK cb12454

Tree-SHA512: 2d8b98329cb629552c7747c503a9ec494a4011867782c96ab01bd1e6dd2c53b55da0d37b978ebf7a07e184e8c0dd455c02119545be83270ae1cbc56b514f6eb7

Author: tcharding

client/src/client_sync/v26/blockchain.rs

@@ -9,6 +9,30 @@
 //!
 //! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `dumptxoutset`.
+#[macro_export]
+macro_rules! impl_client_v26__dump_tx_out_set {
+    () => {
+        impl Client {
+            pub fn dump_tx_out_set(&self, path: &str) -> Result<DumpTxOutSet> {
+                self.call("dumptxoutset", &[path.into()])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getchainstates`.
+#[macro_export]
+macro_rules! impl_client_v26__get_chain_states {
+    () => {
+        impl Client {
+            pub fn get_chain_states(&self) -> Result<GetChainStates> {
+                self.call("getchainstates", &[])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `gettxoutsetinfo`.
 #[macro_export]
 macro_rules! impl_client_v26__get_tx_out_set_info {
@@ -20,3 +44,31 @@ macro_rules! impl_client_v26__get_tx_out_set_info {
         }
     };
 }
+
+/// Implements Bitcoin Core JSON-RPC API method `importmempool`.
+#[macro_export]
+macro_rules! impl_client_v26__import_mempool {
+    () => {
+        impl Client {
+            pub fn import_mempool(&self, filepath: &str) -> Result<()> {
+                match self.call("importmempool", &[filepath.into()]) {
+                    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 `loadtxoutset`.
+#[macro_export]
+macro_rules! impl_client_v26__load_tx_out_set {
+    () => {
+        impl Client {
+            pub fn load_tx_out_set(&self, path: &str) -> Result<LoadTxOutSet> {
+                self.call("loadtxoutset", &[path.into()])
+            }
+        }
+    };
+}

client/src/client_sync/v26/mod.rs

@@ -6,6 +6,7 @@
 
 pub mod blockchain;
 pub mod mining;
+pub mod network;
 pub mod raw_transactions;
 
 use std::collections::BTreeMap;
@@ -31,6 +32,7 @@ crate::define_jsonrpc_minreq_client!("v26");
 crate::impl_client_check_expected_server_version!({ [260000, 260100, 260200] });
 
 // == Blockchain ==
+crate::impl_client_v26__dump_tx_out_set!();
 crate::impl_client_v17__get_best_block_hash!();
 crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
@@ -40,6 +42,7 @@ 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_v26__get_chain_states!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
 crate::impl_client_v23__get_deployment_info!();
@@ -53,6 +56,8 @@ 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_v26__import_mempool!();
+crate::impl_client_v26__load_tx_out_set!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -88,6 +93,7 @@ crate::impl_client_v17__add_node!();
 crate::impl_client_v17__clear_banned!();
 crate::impl_client_v17__disconnect_node!();
 crate::impl_client_v17__get_added_node_info!();
+crate::impl_client_v26__get_addr_man_info!();
 crate::impl_client_v17__get_connection_count!();
 crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();

client/src/client_sync/v26/network.rs

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Requires `Client` to be in scope.
+//!
+//! Specifically this is methods found under the `== Network ==` section of the
+//! API docs of Bitcoin Core `v26`.
+//!
+//! See, or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
+
+/// Implements Bitcoin Core JSON-RPC API method `getaddrmaninfo`.
+#[macro_export]
+macro_rules! impl_client_v26__get_addr_man_info {
+    () => {
+        impl Client {
+            pub fn get_addr_man_info(&self) -> Result<GetAddrManInfo> {
+                self.call("getaddrmaninfo", &[])
+            }
+        }
+    };
+}

client/src/client_sync/v27/mod.rs

@@ -27,6 +27,7 @@ crate::define_jsonrpc_minreq_client!("v27");
 crate::impl_client_check_expected_server_version!({ [270000, 270100, 270200] });
 
 // == Blockchain ==
+crate::impl_client_v26__dump_tx_out_set!();
 crate::impl_client_v17__get_best_block_hash!();
 crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
@@ -36,6 +37,7 @@ 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_v26__get_chain_states!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
 crate::impl_client_v23__get_deployment_info!();
@@ -49,6 +51,7 @@ 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_v26__import_mempool!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -84,6 +87,7 @@ crate::impl_client_v17__add_node!();
 crate::impl_client_v17__clear_banned!();
 crate::impl_client_v17__disconnect_node!();
 crate::impl_client_v17__get_added_node_info!();
+crate::impl_client_v26__get_addr_man_info!();
 crate::impl_client_v17__get_connection_count!();
 crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();

client/src/client_sync/v28/mod.rs

@@ -29,6 +29,7 @@ crate::define_jsonrpc_minreq_client!("v28");
 crate::impl_client_check_expected_server_version!({ [280000, 280100, 280200] });
 
 // == Blockchain ==
+crate::impl_client_v26__dump_tx_out_set!();
 crate::impl_client_v17__get_best_block_hash!();
 crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
@@ -38,6 +39,7 @@ 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_v26__get_chain_states!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
 crate::impl_client_v23__get_deployment_info!();
@@ -51,6 +53,7 @@ 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_v26__import_mempool!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -86,6 +89,7 @@ crate::impl_client_v17__add_node!();
 crate::impl_client_v17__clear_banned!();
 crate::impl_client_v17__disconnect_node!();
 crate::impl_client_v17__get_added_node_info!();
+crate::impl_client_v26__get_addr_man_info!();
 crate::impl_client_v17__get_connection_count!();
 crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();

client/src/client_sync/v29/blockchain.rs

@@ -9,6 +9,18 @@
 //!
 //! See or use the `define_jsonrpc_minreq_client!` macro to define a `Client`.
 
+/// Implements Bitcoin Core JSON-RPC API method `dumptxoutset`.
+#[macro_export]
+macro_rules! impl_client_v29__dump_tx_out_set {
+    () => {
+        impl Client {
+            pub fn dump_tx_out_set(&self, path: &str, snapshot_type: &str) -> Result<DumpTxOutSet> {
+                self.call("dumptxoutset", &[path.into(), snapshot_type.into()])
+            }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `getdescriptoractivity`.
 #[macro_export]
 macro_rules! impl_client_v29__get_descriptor_activity {

client/src/client_sync/v29/mod.rs

@@ -28,6 +28,7 @@ crate::define_jsonrpc_minreq_client!("v29");
 crate::impl_client_check_expected_server_version!({ [290000] });
 
 // == Blockchain ==
+crate::impl_client_v29__dump_tx_out_set!();
 crate::impl_client_v17__get_best_block_hash!();
 crate::impl_client_v17__get_block!();
 crate::impl_client_v17__get_blockchain_info!();
@@ -37,6 +38,7 @@ 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_v26__get_chain_states!();
 crate::impl_client_v17__get_chain_tips!();
 crate::impl_client_v17__get_chain_tx_stats!();
 crate::impl_client_v23__get_deployment_info!();
@@ -51,6 +53,7 @@ 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_v26__import_mempool!();
 crate::impl_client_v17__precious_block!();
 crate::impl_client_v17__prune_blockchain!();
 crate::impl_client_v23__save_mempool!();
@@ -86,6 +89,7 @@ crate::impl_client_v17__add_node!();
 crate::impl_client_v17__clear_banned!();
 crate::impl_client_v17__disconnect_node!();
 crate::impl_client_v17__get_added_node_info!();
+crate::impl_client_v26__get_addr_man_info!();
 crate::impl_client_v17__get_connection_count!();
 crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();

integration_test/tests/blockchain.rs

@@ -9,6 +9,30 @@ use node::client::client_sync;
 use node::vtype::*;             // All the version specific types.
 use node::mtype;
 
+#[test]
+#[cfg(not(feature = "v25_and_below"))]
+fn blockchain__dump_tx_out_set__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+    let (_address, _tx) = node.create_mined_transaction();
+
+    let temp_path = integration_test::random_tmp_file();
+    let path = temp_path.to_str().expect("temp path should be valid UTF-8");
+    let json: DumpTxOutSet;
+    #[cfg(feature = "v28_and_below")]
+    {
+        json = node.client.dump_tx_out_set(path).expect("dumptxoutset");
+    }
+    #[cfg(not(feature = "v28_and_below"))]
+    {
+        json = node.client.dump_tx_out_set(path, "latest").expect("dumptxoutset");
+    }
+    let model: Result<mtype::DumpTxOutSet, DumpTxOutSetError> = json.into_model();
+    let dump = model.unwrap();
+
+    assert!(dump.coins_written.to_sat() > 0);
+}
+
 #[test]
 fn blockchain__get_best_block_hash__modelled() {
     let node = Node::with_wallet(Wallet::None, &[]);
@@ -160,6 +184,20 @@ fn getblockstats_txindex() {
     json.into_model().unwrap();
 }
 
+#[test]
+#[cfg(not(feature = "v25_and_below"))]
+fn blockchain__get_chain_states__modelled() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+    let (_address, _tx) = node.create_mined_transaction();
+
+    let json: GetChainStates = node.client.get_chain_states().expect("getchainstates");
+    let model: Result<mtype::GetChainStates, _> = json.into_model();
+    let chain_states = model.unwrap();
+
+    assert!(chain_states.chain_states[0].blocks > 0);
+}
+
 #[test]
 fn blockchain__get_chain_tips__modelled() {
     let node = Node::with_wallet(Wallet::None, &[]);
@@ -331,6 +369,18 @@ fn blockchain__get_tx_spending_prevout__modelled() {
     assert_eq!(spending_prevout.0[0].outpoint.vout, 0);
 }
 
+#[test]
+#[cfg(not(feature = "v25_and_below"))]
+fn blockchain__import_mempool() {
+    let node = Node::with_wallet(Wallet::Default, &[]);
+    node.fund_wallet();
+    let (_address, _tx) = node.create_mined_transaction();
+
+    let mempool_path = node.client.save_mempool().expect("savemempool");
+
+    let _: () = node.client.import_mempool(&mempool_path.filename).expect("importmempool");
+}
+
 #[test]
 fn blockchain__precious_block() {
     let node = Node::with_wallet(Wallet::Default, &[]);

integration_test/tests/network.rs

@@ -49,6 +49,19 @@ fn network__get_added_node_info() {
     let _: GetAddedNodeInfo = node.client.get_added_node_info().expect("getaddednodeinfo");
 }
 
+#[test]
+#[cfg(not(feature = "v25_and_below"))]
+fn network__get_addr_man_info() {
+    let node = Node::with_wallet(Wallet::None, &[]);
+    let json: GetAddrManInfo = node.client.get_addr_man_info().expect("getaddrmaninfo");
+    assert!(!json.0.is_empty());
+
+    for (network_name, network_info) in &json.0 {
+        assert!(!network_name.is_empty());
+        assert_eq!(network_info.total, network_info.new + network_info.tried);
+    };
+}
+
 #[test]
 fn network__get_connection_count() {
     let node = Node::with_wallet(Wallet::None, &[]);