Add support for bitcoin core 29.0

Author: GideonBature

.github/workflows/rust.yaml

@@ -210,6 +210,7 @@ jobs:
       matrix:
         feature:
           [
+            "29_0",
             "28_0",
             "27_1",
             "27_0",

client/src/client_sync/mod.rs

@@ -15,6 +15,7 @@ pub mod v25;
 pub mod v26;
 pub mod v27;
 pub mod v28;
+pub mod v29;
 
 use std::fs::File;
 use std::io::{BufRead, BufReader};
@@ -262,3 +263,18 @@ pub enum TemplateRules {
     /// Taproot supported.
     Taproot,
 }
+
+/// Arg for the `getblocktemplate` method. (v29+).
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)]
+pub struct TemplateRequestV29 {
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub mode: Option<String>,
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
+    pub capabilities: Vec<String>,
+    #[serde(default, skip_serializing_if = "Vec::is_empty")]
+    pub rules: Vec<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub longpollid: Option<String>,
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub data: Option<String>,
+}

client/src/client_sync/v29/blockchain.rs

@@ -0,0 +1,89 @@
+// 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 `v29`.
+//!
+//! 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 `getblock`
+#[macro_export]
+macro_rules! impl_client_v29__getblock {
+    () => {
+        impl Client {
+            /// Gets a block by blockhash.
+            pub fn get_block(&self, hash: BlockHash) -> Result<Block> {
+                let json = self.get_block_verbose_zero(hash)?;
+                Ok(json.block()?)
+            }
+
+            /// Gets a block by blockhash with verbose set to 0.
+            pub fn get_block_verbose_zero(&self, hash: BlockHash) -> Result<GetBlockVerboseZero> {
+                self.call("getblock", &[into_json(hash)?, 0.into()])
+            }
+
+            /// Gets a block by blockhash with verbose set to 1.
+            pub fn get_block_verbose_one(&self, hash: BlockHash) -> Result<GetBlockVerboseOne> {
+                self.call("getblock", &[into_json(hash)?, 1.into()])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getblockheader`
+#[macro_export]
+macro_rules! impl_client_v29__getblockheader {
+    () => {
+        impl Client {
+            pub fn get_block_header(&self, hash: &BlockHash) -> Result<GetBlockHeader> {
+                self.call("getblockheader", &[into_json(hash)?, into_json(false)?])
+            }
+
+            // This is the same as calling getblockheader with verbose==true.
+            pub fn get_block_header_verbose(
+                &self,
+                hash: &BlockHash,
+            ) -> Result<GetBlockHeaderVerbose> {
+                self.call("getblockheader", &[into_json(hash)?])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getblockchaininfo`
+#[macro_export]
+macro_rules! impl_client_v29__getblockchaininfo {
+    () => {
+        impl Client {
+            pub fn get_blockchain_info(&self) -> Result<GetBlockchainInfo> {
+                self.call("getblockchaininfo", &[])
+            }
+        }
+    };
+}
+
+/// Implements Bitcoin Core JSON-RPC API method `getdescriptoractivity`
+#[macro_export]
+macro_rules! impl_client_v29__getdescriptoractivity {
+    () => {
+        impl Client {
+            pub fn get_descriptor_activity(
+                &self,
+                blockhashes: Option<&[BlockHash]>,
+                scan_objects: Option<&[&str]>,
+                include_mempool: Option<bool>,
+            ) -> Result<GetDescriptorActivity> {
+                let blockhashes_val = json!(blockhashes.unwrap_or(&[]));
+                let scan_objects_val = json!(scan_objects.unwrap_or(&[]));
+                let include_mempool_val = json!(include_mempool.unwrap_or(false));
+
+                let params = vec![blockhashes_val, scan_objects_val, include_mempool_val];
+
+                self.call("getdescriptoractivity", &params)
+            }
+        }
+    };
+}

client/src/client_sync/v29/mining.rs

@@ -0,0 +1,36 @@
+// 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 `v29`.
+//!
+//! 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 `getmininginfo`
+#[macro_export]
+macro_rules! impl_client_v29__getmininginfo {
+    () => {
+        impl Client {
+            pub fn get_mining_info(&self) -> Result<GetMiningInfo> {
+                self.call("getmininginfo", &[])
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! impl_client_v29__getblocktemplate {
+    () => {
+        impl Client {
+            pub fn get_block_template(
+                &self,
+                request: &$crate::client_sync::TemplateRequestV29,
+            ) -> Result<GetBlockTemplate> {
+                self.call("getblocktemplate", &[into_json(request)?])
+            }
+        }
+    };
+}

client/src/client_sync/v29/mod.rs

@@ -0,0 +1,117 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! A JSON-RPC client for testing against Bitcoin Core `v29`.
+//!
+//! 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;
+
+use bitcoin::address::{Address, NetworkChecked};
+use bitcoin::{Amount, Block, BlockHash, PublicKey, Txid};
+use serde_json::json;
+
+use crate::client_sync::into_json;
+use crate::types::v28::*;
+use crate::types::v29::{
+    GetBlockHeader, GetBlockHeaderVerbose, GetBlockVerboseOne, GetBlockVerboseZero,
+    GetDescriptorActivity, GetMiningInfo,
+};
+
+#[rustfmt::skip]                // Keep public re-exports separate.
+pub use crate::client_sync::{v23::AddressType, WalletCreateFundedPsbtInput};
+
+crate::define_jsonrpc_minreq_client!("v29");
+crate::impl_client_check_expected_server_version!({ [290000] });
+
+// == Blockchain ==
+crate::impl_client_v17__getbestblockhash!();
+crate::impl_client_v29__getblock!();
+crate::impl_client_v29__getblockchaininfo!();
+crate::impl_client_v17__getblockcount!();
+crate::impl_client_v19__getblockfilter!();
+crate::impl_client_v17__getblockhash!();
+crate::impl_client_v17__getblockheader!();
+crate::impl_client_v17__getblockstats!();
+crate::impl_client_v17__getchaintips!();
+crate::impl_client_v17__getchaintxstats!();
+crate::impl_client_v17__getdifficulty!();
+crate::impl_client_v19__getmempoolancestors!();
+crate::impl_client_v19__getmempooldescendants!();
+crate::impl_client_v19__getmempoolentry!();
+crate::impl_client_v17__getmempoolinfo!();
+crate::impl_client_v17__getrawmempool!();
+crate::impl_client_v22__gettxout!();
+crate::impl_client_v17__gettxoutproof!();
+crate::impl_client_v26__gettxoutsetinfo!();
+crate::impl_client_v17__preciousblock!();
+crate::impl_client_v17__verifytxoutproof!();
+crate::impl_client_v29__getdescriptoractivity!();
+
+// == Control ==
+crate::impl_client_v17__getmemoryinfo!();
+crate::impl_client_v18__getrpcinfo!();
+crate::impl_client_v17__help!();
+crate::impl_client_v17__logging!();
+crate::impl_client_v17__stop!();
+crate::impl_client_v17__uptime!();
+
+// == Generating ==
+crate::impl_client_v17__generatetoaddress!();
+crate::impl_client_v17__invalidateblock!();
+
+// == Mining ==
+crate::impl_client_v29__getblocktemplate!();
+crate::impl_client_v29__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__getaddednodeinfo!();
+crate::impl_client_v17__getnettotals!();
+crate::impl_client_v17__getnetworkinfo!();
+crate::impl_client_v17__getpeerinfo!();
+
+// == Rawtransactions ==
+crate::impl_client_v17__createrawtransaction!();
+crate::impl_client_v17__fundrawtransaction!();
+crate::impl_client_v17__sendrawtransaction!();
+crate::impl_client_v28__submitpackage!();
+
+// == Wallet ==
+crate::impl_client_v17__addmultisigaddress!();
+crate::impl_client_v17__bumpfee!();
+crate::impl_client_v23__createwallet!();
+crate::impl_client_v17__dumpprivkey!();
+crate::impl_client_v17__dumpwallet!();
+crate::impl_client_v17__getaddressesbylabel!();
+crate::impl_client_v17__getaddressinfo!();
+crate::impl_client_v17__getbalance!();
+crate::impl_client_v19__getbalances!();
+crate::impl_client_v17__getnewaddress!();
+crate::impl_client_v17__getrawchangeaddress!();
+crate::impl_client_v17__getreceivedbyaddress!();
+crate::impl_client_v17__gettransaction!();
+crate::impl_client_v17__getunconfirmedbalance!();
+crate::impl_client_v17__getwalletinfo!();
+crate::impl_client_v17__listaddressgroupings!();
+crate::impl_client_v17__listlabels!();
+crate::impl_client_v17__listlockunspent!();
+crate::impl_client_v17__listreceivedbyaddress!();
+crate::impl_client_v17__listsinceblock!();
+crate::impl_client_v17__listtransactions!();
+crate::impl_client_v17__listunspent!();
+crate::impl_client_v17__listwallets!();
+crate::impl_client_v22__loadwallet!();
+crate::impl_client_v17__rescanblockchain!();
+crate::impl_client_v17__sendmany!();
+crate::impl_client_v17__sendtoaddress!();
+crate::impl_client_v17__signmessage!();
+crate::impl_client_v17__signrawtransactionwithwallet!();
+crate::impl_client_v21__unloadwallet!();
+crate::impl_client_v17__walletcreatefundedpsbt!();
+crate::impl_client_v17__walletprocesspsbt!();

integration_test/Cargo.toml

@@ -13,6 +13,7 @@ edition = "2021"
 [features]
 # Enable the same feature in `node` and the version feature here.
 # All minor releases of the latest three versions.
+29_0 = ["v29", "node/29_0"]
 28_0 = ["v28", "node/28_0"]
 27_2 = ["v27", "node/27_2"]
 27_1 = ["v27", "node/27_1"]
@@ -33,6 +34,7 @@ edition = "2021"
 
 # These features are just for internal use (feature gating).
 # Each major version is tested with the same client.
+v29 = []
 v28 = []
 v27 = []
 v26 = []

integration_test/tests/blockchain.rs

@@ -28,14 +28,15 @@ fn blockchain__get_block__modelled() {
     model.expect("GetBlock into model");
 
     let json: GetBlockVerboseOne = node.client.get_block_verbose_one(block_hash).expect("getblock verbose=1");
-    let model: Result<mtype::GetBlockVerboseOne, GetBlockVerboseOneError> = json.into_model();
+    let model = json.into_model();
     model.expect("GetBlockVerbose into model");
 
     // TODO: Test getblock 2
     // let json = node.client.get_block_with_verbosity(block_hash, 2).expect("getblock verbosity 2");
     // assert!(json.into_model().is_ok());
 }
 
+#[cfg(not(feature = "v29"))]
 #[test]
 fn blockchain__get_blockchain_info__modelled() {
     let node = Node::with_wallet(Wallet::None, &[]);
@@ -86,8 +87,8 @@ fn blockchain__get_block_header__modelled() {
     model.unwrap();
 
     // verbose = true
-    let json:GetBlockHeaderVerbose = node.client.get_block_header_verbose(&block_hash).expect("getblockheader");
-    let model: Result<mtype::GetBlockHeaderVerbose, GetBlockHeaderVerboseError> = json.into_model();
+    let json: GetBlockHeaderVerbose = node.client.get_block_header_verbose(&block_hash).expect("getblockheader");
+    let model = json.into_model();
     model.unwrap();
 }
 
@@ -290,3 +291,12 @@ fn verify_tx_out_proof(node: &Node) -> Result<(), client_sync::Error> {
 
     Ok(())
 }
+
+#[test]
+#[cfg(feature = "v29")]
+fn blockchain__get_descriptor_activity__modelled() {
+    let node = Node::with_wallet(Wallet::None, &["-coinstatsindex=1", "-txindex=1"]);
+
+    let res: GetDescriptorActivity = node.client.get_descriptor_activity(None, None, None).expect("get_descriptor_activity(None, None, None) failed");
+    let _: Result<mtype::GetDescriptorActivity, GetDescriptorActivityError> = res.into_model();
+}

integration_test/tests/mining.rs

@@ -6,25 +6,44 @@
 
 use bitcoin::SignedAmount;
 use integration_test::{Node, NodeExt as _, Wallet};
-use node::client::client_sync::{TemplateRequest, TemplateRules};
-use node::vtype::*;             // All the version specific types.
+use node::vtype::*;
 use node::mtype;
 
 #[test]
 fn mining__get_block_template__modelled() {
     // Requires connected nodes otherwise the RPC call errors.
     let (node1, node2, node3) = integration_test::three_node_network();
 
-    // Use the nodes otherwise they get dropped.
     node1.mine_a_block();
     node2.mine_a_block();
     node3.mine_a_block();
+    std::thread::sleep(std::time::Duration::from_millis(500));
 
-    let options = TemplateRequest { rules: vec![TemplateRules::Segwit] };
+    #[cfg(not(feature = "v29"))]
+    {
+        use node::client::client_sync::{TemplateRequest, TemplateRules};
+
+        let options = TemplateRequest { rules: vec![TemplateRules::Segwit] };
+        let result: GetBlockTemplate = node1.client.get_block_template(&options)
+            .expect("get_block_template RPC failed (pre-v29)");
+        let _ = result.into_model();
+    }
 
-    let json: GetBlockTemplate = node1.client.get_block_template(&options).expect("rpc");
-    let model: Result<mtype::GetBlockTemplate, GetBlockTemplateError> = json.into_model();
-    model.unwrap();
+    #[cfg(feature = "v29")]
+    {
+        use node::client::client_sync::TemplateRequestV29;
+
+        let request_v29 = TemplateRequestV29 {
+            rules: vec!["segwit".to_string()],
+            mode: Some("template".to_string()),
+            ..Default::default()
+        };
+
+        let result_v29 = node1.client.get_block_template(&request_v29)
+            .expect("get_block_template RPC failed (v29)");
+
+        let _ = result_v29.into_model();
+    }
 }
 
 #[test]

integration_test/tests/network.rs

@@ -20,6 +20,7 @@ fn network__get_net_totals() {
     let _: GetNetTotals = node.client.get_net_totals().expect("getnettotals");
 }
 
+#[cfg(not(feature = "v29"))]
 #[test]
 fn network__get_network_info() {
     let node = Node::with_wallet(Wallet::None, &[]);