Implement methods from the mining section

Add types, implement in client, and verify all methods from the
mining section except `submitheader` and `submitblock`. `submitblock`
is done but I can't get the test to pass all the time.

- `submitblock` has flaky (excluded) tests.
- `submitheader` is untested.

One the way I fixed a few things in the network section
(`getpeerinfo`) because I ran into issues there at some stage.

Author: tcharding

client/src/client_sync/mod.rs

@@ -241,3 +241,24 @@ pub struct WalletCreateFundedPsbtInput {
     txid: Txid,
     vout: u32,
 }
+
+/// Arg for the `getblocktemplate` method.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct TemplateRequest {
+    /// A list of strings.
+    pub rules: Vec<TemplateRules>,
+}
+
+/// Client side supported softfork deployment.
+#[derive(Copy, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum TemplateRules {
+    /// SegWit v0 supported.
+    Segwit,
+    /// Signet supported.
+    Signet,
+    /// CSV supported.
+    Csv,
+    /// Taproot supported.
+    Taproot,
+}

client/src/client_sync/v17/mining.rs

@@ -0,0 +1,81 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Mining ==` section of the
+//! API docs of Bitcoin Core `v0.17`.
+//!
+//! 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 `getblocktemplate`
+#[macro_export]
+macro_rules! impl_client_v17__getblocktemplate {
+    () => {
+        impl Client {
+            pub fn get_block_template(
+                &self,
+                request: &$crate::client_sync::TemplateRequest,
+            ) -> Result<GetBlockTemplate> {
+                self.call("getblocktemplate", &[into_json(request)?])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getmininginfo`
+#[macro_export]
+macro_rules! impl_client_v17__getmininginfo {
+    () => {
+        impl Client {
+            pub fn get_mining_info(&self) -> Result<GetMiningInfo> {
+                self.call("getmininginfo", &[])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getnetworkhashps`
+#[macro_export]
+macro_rules! impl_client_v17__getnetworkhashps {
+    () => {
+        impl Client {
+            pub fn get_network_hash_ps(&self) -> Result<f64> { self.call("getnetworkhashps", &[]) }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `prioritisetransaction`
+#[macro_export]
+macro_rules! impl_client_v17__prioritisetransaction {
+    () => {
+        impl Client {
+            pub fn prioritise_transaction(
+                &self,
+                txid: &Txid,
+                fee_delta: bitcoin::SignedAmount,
+            ) -> Result<bool> {
+                let sats = fee_delta.to_sat();
+                self.call("prioritisetransaction", &[into_json(txid)?, 0.into(), sats.into()])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `submitblock`
+#[macro_export]
+macro_rules! impl_client_v17__submitblock {
+    () => {
+        impl Client {
+            pub fn submit_block(&self, block: &Block) -> Result<()> {
+                let hex: String = bitcoin::consensus::encode::serialize_hex(block);
+                match self.call("submitblock", &[into_json(hex)?]) {
+                    Ok(serde_json::Value::Null) => Ok(()),
+                    Ok(res) => Err(Error::Returned(res.to_string())),
+                    Err(err) => Err(err.into()),
+                }
+            }
+        }
+    };
+}

client/src/client_sync/v17/mod.rs

@@ -7,6 +7,7 @@
 pub mod blockchain;
 pub mod control;
 pub mod generating;
+pub mod mining;
 pub mod network;
 pub mod raw_transactions;
 pub mod wallet;
@@ -61,6 +62,13 @@ crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__generate!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();

client/src/client_sync/v18/mod.rs

@@ -56,6 +56,13 @@ crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__generate!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getaddednodeinfo!();
 crate::impl_client_v17__getnettotals!();

client/src/client_sync/v19/mod.rs

@@ -56,9 +56,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [190100] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v20.rs

@@ -53,9 +53,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [200200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v21/mod.rs

@@ -55,9 +55,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [210200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v22/mod.rs

@@ -56,9 +56,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [220000, 220100] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v23.rs

@@ -54,9 +54,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [230000, 230100, 230200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v24.rs

@@ -53,9 +53,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [240001, 240100, 240200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v25.rs

@@ -53,9 +53,17 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [250000, 250100, 250200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v26/mining.rs

@@ -0,0 +1,22 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! Macros for implementing JSON-RPC methods on a client.
+//!
+//! Specifically this is methods found under the `== Mining ==` section of the
+//! API docs of Bitcoin Core `v0.26`.
+//!
+//! 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 `getprioritisedtransactions`
+#[macro_export]
+macro_rules! impl_client_v26__get_prioritised_transactions {
+    () => {
+        impl Client {
+            pub fn get_prioritised_transactions(&self) -> Result<GetPrioritisedTransactions> {
+                self.call("getprioritisedtransactions", &[])
+            }
+        }
+    };
+}

client/src/client_sync/v26/mod.rs

@@ -5,6 +5,7 @@
 //! We ignore option arguments unless they effect the shape of the returned JSON data.
 
 pub mod blockchain;
+pub mod mining;
 
 use std::collections::BTreeMap;
 use std::path::Path;
@@ -55,9 +56,18 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v26__get_prioritised_transactions!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [260000, 260100, 260200] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v27.rs

@@ -53,9 +53,18 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v26__get_prioritised_transactions!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [270000, 270100] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();

client/src/client_sync/v28/mod.rs

@@ -55,9 +55,18 @@ crate::impl_client_v17__uptime!();
 crate::impl_client_v17__generatetoaddress!();
 crate::impl_client_v17__invalidateblock!();
 
+// == Mining ==
+crate::impl_client_v17__getblocktemplate!();
+crate::impl_client_v17__getmininginfo!();
+crate::impl_client_v17__getnetworkhashps!();
+crate::impl_client_v26__get_prioritised_transactions!();
+crate::impl_client_v17__prioritisetransaction!();
+crate::impl_client_v17__submitblock!();
+
 // == Network ==
 crate::impl_client_v17__getnetworkinfo!();
 crate::impl_client_check_expected_server_version!({ [280000] });
+crate::impl_client_v17__getpeerinfo!();
 
 // == Rawtransactions ==
 crate::impl_client_v17__createrawtransaction!();