Add initial support for Bitcoin Core v31 by tcharding · Pull Request #598 · rust-bitcoin/corepc

tcharding · 2026-05-21T02:34:06Z

First do a bunch of cleanups. Then add initial support.

We include types for the three new methods but they are untested. All failing tests, typically caused by changed fields, are feature gated out and marked as TODO. These can be tackled at a later date because downstream is waiting for this and don't need full support immediately.

ref: #599

tcharding · 2026-05-21T02:35:02Z

Props to @xyzconstant and @0xB10C for pushing me to do this.

I believe we can release this and then chip away at fixing the methods that were changed. Would that fix your use case lads?

tcharding · 2026-05-21T02:36:12Z

Supersedes #586 and #596

tcharding · 2026-05-21T02:41:34Z

I reset the author of final patch to remove you @xyzconstant, I did use the shasums from you PR but that is all. Is that ok or do you want Co-authored-by?

tcharding · 2026-05-21T02:46:17Z

If this is good can you push up a release tracking PR @jamillambert for corepc-types, corepc-client, and bitcoind. In the changelog of types we should explicitly point out that the support is limited.

The version features are weird in this crate, later Core versions enable earlier ones. So we can simplify the 'all-features' feature gating to just check for the earlies `0_17_2` with no change of functionality.

The features on this crate are non-typical. Improve the docs and put the `latest` feature right below `default`.

This is buggy, I couldn't come up with a way to catch this in case we do it again another time when we add a later Core version.

A few problems being fixed here: - We once committed to supporting all point releases for the latest 3 versions of Core. During 88ddaf1 it looks like this was changed to 4 and I missed this in review (or I don't remember it). - We want to add support for the latest version of Core (v31) Cut back early point releases to only be for the latest 2 versions, then when we add support for v31 it will be back to 3. Leave docs/comments saying 'three'.

The wallet migration bug was present in both v30.0 and v30.1 but we continue to have a `30_0` feature - this is wrong, remove it.

`v30_and_below` is currently all versions, this feature gate is incorrect - remove it.

tcharding · 2026-05-21T03:31:08Z

Rebaesed on master after merge of #591

satsfy

Reviewed 1fdcf93

Let's do v31!

In contrib/templates/bitcoind_aliases there is an alias mentioned 30_0 and Cargo.toml mentioned 30_0 still.

satsfy · 2026-05-21T19:12:10Z

+macro_rules! impl_client_v31__get_private_broadcast_info {
+    () => {
+        impl Client {
+            pub fn get_private_broadcast_info(&self) -> Result<GetPrivateBroadcastInfor> {


Suggested change

pub fn get_private_broadcast_info(&self) -> Result<GetPrivateBroadcastInfor> {

pub fn get_private_broadcast_info(&self) -> Result<GetPrivateBroadcastInfo> {

Solid reviewing, thanks mate! verify should have caught these mistakes, let me investigate that.

Gee wiz, the v31 module was not being built in. Missing pub mod v31 ...

satsfy · 2026-05-21T19:14:29Z

+    ),
+    Method::new_modelled("getdifficulty", "GetDifficulty", "get_difficulty"),
+    Method::new_modelled("getmempoolancestors", "GetMempoolAncestors", "get_mempool_ancestors"),
+    Method::new_modelled("getmempoolcluster", "GetMempoolClusted", "get_mempool_cluster"),


Suggested change

Method::new_modelled("getmempoolcluster", "GetMempoolClusted", "get_mempool_cluster"),

Method::new_modelled("getmempoolcluster", "GetMempoolCluster", "get_mempool_cluster"),

This is definitely a bug in verify. Added #602. Thanks man.

The RPC is marked at TODO so isn't checked by verify

satsfy · 2026-05-21T19:16:19Z

@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v31` - blockchain.b


Suggested change

//! The JSON-RPC API for Bitcoin Core `v31` - blockchain.b

//! The JSON-RPC API for Bitcoin Core `v31` - blockchain.

satsfy · 2026-05-21T19:16:36Z

+#[cfg_attr(feature = "serde-deny-unknown-fields", serde(deny_unknown_fields))]
+pub struct GetMempoolCluster {
+    /// Total sigops-adjusted weight (as defined in BIP 141 and modified by `-bytespersigop`).
+    pub cluster_weight: u64,


Suggested change

pub cluster_weight: u64,

#[serde(rename = "clusterweight")]

pub cluster_weight: u64,

Good eye bro!

satsfy · 2026-05-21T19:16:58Z

+    /// Total sigops-adjusted weight (as defined in BIP 141 and modified by `-bytespersigop`).
+    pub cluster_weight: u64,
+    /// Number of transactions.
+    pub tx_count: u64,


Suggested change

pub tx_count: u64,

#[serde(rename = "txcount")]

pub tx_count: u64,

satsfy · 2026-05-21T19:17:15Z

+#[derive(Clone, Debug, PartialEq, Eq, Deserialize, Serialize)]
+pub struct Chunk {
+    /// Fees of the transactions in this chunk.
+    pub chunk_fee: u64,


Its a float.

Suggested change

pub chunk_fee: u64,

#[serde(rename = "chunkfee")]

pub chunk_fee: f64,

satsfy · 2026-05-21T19:18:38Z

+    /// Fees of the transactions in this chunk.
+    pub chunk_fee: u64,
+    /// Sigops-adjusted weight of all transactions in this chunk.
+    pub chunk_weight: u64,


Suggested change

pub chunk_weight: u64,

#[serde(rename = "chunkweight")]

pub chunk_weight: u64,

satsfy · 2026-05-21T19:25:35Z

+//! We ignore option arguments unless they effect the shape of the returned JSON data.
+
+pub mod blockchain;
+


Suggested change

pub mod raw_transactions;

Ha, nice one.

satsfy · 2026-05-21T19:27:41Z

+            let txs =
+                chunk.txs.iter().map(|txid| txid.parse::<Txid>()).collect::<Result<Vec<_>, _>>()?;
+            chunks.push(model::Chunk {
+                chunk_fee: Amount::from_sat(chunk.chunk_fee),


Suggested change

chunk_fee: Amount::from_sat(chunk.chunk_fee),

chunk_fee: Amount::from_btc(chunk.chunk_fee),

I"ll take your word for it. Thanks.

I'm going to leave it as is for now because from_btc is infallible and that means adding an error type. I'm too lazy to do all that for code that is not tested in this PR. The dev who does that can add the error type as part of testing.

I did add a TODO and linked to this discussion. Thanks man, good reviewing.

Props to xyzconstant and 0xB10C for pushing me to do this. Add initial support for Bitcoin Core v31 We include types for the three new methods but they are untested. All failing tests, typically caused by changed fields, are feature gated out and marked as `TODO`. These can be tackled at a later date because downstream is waiting for this and don't need full support immediately.

jamillambert · 2026-05-22T14:50:13Z

 #![allow(unused_imports)] // Not all users need the json types.

-#[cfg(feature = "30_0")]
+#[cfg(feature = "30_2")]


Suggested change

#[cfg(feature = "30_2")]

#[cfg(feature = "31_0")]

pub use corepc_client::{client_sync::v31::*, types::v31 as vtype};

#[cfg(all(feature = "30_2", not(feature = "31_0")))]

jamillambert · 2026-05-22T17:32:00Z

+    /// Fees of the transactions in this chunk.
+    #[serde(rename = "chunkfee")]
+    // FIXME: This is probably a float. https://github.com/rust-bitcoin/corepc/pull/598#discussion_r3283795812
+    pub chunk_fee: u64,         


Suggested change

pub chunk_fee: u64,

pub chunk_fee: u64,

Cause of the fmt CI job failure.

jamillambert · 2026-05-22T17:36:21Z

+    Method::new_numeric("getnetworkhashps", "get_network_hashes_per_second"),
+    Method::new_modelled(
+        "getprioritisedtransactions",
+        "GetPrioritisedTransactionsREMOVEME",


Suggested change

"GetPrioritisedTransactionsREMOVEME",

"GetPrioritisedTransactions",

Not sure what REMOVEME was for, but doing what it says fixes verify.

tcharding requested review from RCasatta and jamillambert as code owners May 21, 2026 02:34

github-actions Bot added C-bitcoind C-client C-integration-test C-types C-verify labels May 21, 2026

tcharding force-pushed the push-xxtnqtoqxumu branch 2 times, most recently from 1eaa872 to d10ec71 Compare May 21, 2026 02:38

tcharding force-pushed the push-xxtnqtoqxumu branch from d10ec71 to bc93a1e Compare May 21, 2026 02:45

tcharding mentioned this pull request May 21, 2026

Finish off support for Core v31 #599

Open

tcharding added 6 commits May 21, 2026 13:30

bitcoind: Simplify no-default-features feature gate

4fa6ae3

The version features are weird in this crate, later Core versions enable earlier ones. So we can simplify the 'all-features' feature gating to just check for the earlies `0_17_2` with no change of functionality.

bitcoind: Move and document features

3b377c5

The features on this crate are non-typical. Improve the docs and put the `latest` feature right below `default`.

bitcoind: Fix client versions re-exports

474a858

This is buggy, I couldn't come up with a way to catch this in case we do it again another time when we add a later Core version.

bitcoind: Remove support for v30.0

26f35d2

The wallet migration bug was present in both v30.0 and v30.1 but we continue to have a `30_0` feature - this is wrong, remove it.

integration_test: Remove incorrect feature gate

cfd7b7f

`v30_and_below` is currently all versions, this feature gate is incorrect - remove it.

tcharding force-pushed the push-xxtnqtoqxumu branch from bc93a1e to 1fdcf93 Compare May 21, 2026 03:30

satsfy suggested changes May 21, 2026

View reviewed changes

This was referenced May 22, 2026

verify: Bug checking for type re-exports #602

Open

Should all fee fields be floats? #603

Open

tcharding force-pushed the push-xxtnqtoqxumu branch from 1fdcf93 to da3e0f3 Compare May 22, 2026 03:38

jamillambert reviewed May 22, 2026

View reviewed changes

	pub fn get_private_broadcast_info(&self) -> Result<GetPrivateBroadcastInfor> {
	pub fn get_private_broadcast_info(&self) -> Result<GetPrivateBroadcastInfo> {

	Method::new_modelled("getmempoolcluster", "GetMempoolClusted", "get_mempool_cluster"),
	Method::new_modelled("getmempoolcluster", "GetMempoolCluster", "get_mempool_cluster"),

		@@ -0,0 +1,35 @@
		// SPDX-License-Identifier: CC0-1.0

		//! The JSON-RPC API for Bitcoin Core `v31` - blockchain.b

	pub cluster_weight: u64,
	#[serde(rename = "clusterweight")]
	pub cluster_weight: u64,

	pub tx_count: u64,
	#[serde(rename = "txcount")]
	pub tx_count: u64,

	pub chunk_fee: u64,
	#[serde(rename = "chunkfee")]
	pub chunk_fee: f64,

	pub chunk_weight: u64,
	#[serde(rename = "chunkweight")]
	pub chunk_weight: u64,

		//! We ignore option arguments unless they effect the shape of the returned JSON data.

		pub mod blockchain;

	chunk_fee: Amount::from_sat(chunk.chunk_fee),
	chunk_fee: Amount::from_btc(chunk.chunk_fee),

-#[cfg(feature = "30_2")]
+#[cfg(feature = "31_0")]
+pub use corepc_client::{client_sync::v31::*, types::v31 as vtype};
+#[cfg(all(feature = "30_2", not(feature = "31_0")))]

	"GetPrioritisedTransactionsREMOVEME",
	"GetPrioritisedTransactions",

Conversation

tcharding commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tcharding commented May 21, 2026

Uh oh!

tcharding commented May 21, 2026

Uh oh!

tcharding commented May 21, 2026

Uh oh!

tcharding commented May 21, 2026

Uh oh!

tcharding commented May 21, 2026

Uh oh!

satsfy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tcharding commented May 21, 2026 •

edited

Loading

satsfy left a comment •

edited

Loading