Add Blockchain RPC methods #5

tvpeter · 2025-11-18T17:12:00Z

Description

This PR adds the following methods for versions 28, 29, and 30 of bitcoind:

getblock
getbestblockhash
getblock (verbosity = 1)
getblockcount
getblockhash
getblockfilter
getblockheader
getblockheader (verbose = true)
getrawmempool
getrawtransaction

Also in this PR

Update corepc-types to v0.11.0
Uses corepc-node for integration tests
Re-export corepc-types, jsonrpc crates
Update jsonrpc to v0.19.0 and switched from minreq_http to bitreq_http

Fixes #4
Fixes #19
Fixes #20

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

New Features:

I've added tests for the new feature
I've added docs for the new feature
[] I've updated CHANGELOG.md

ValuedMammal

So far I agree with the way you've defined the client methods. I mainly focused on reviewing the implementation of the client code, and haven't spent as much time looking at the test code yet.

By convention, the commits should appear as type(module): Summary, for example

3a16fa4 test: Add integration tests
6f95a7f feat(client): Add blockchain methods

Other notes:

Going forward try to have more descriptive API docs
We should look into testing the client using corepc_node to minimize the amount of manual testing needed and so we can run the integration tests in CI.

src/client.rs

ValuedMammal · 2025-12-12T19:23:19Z

I can work on testing Core v28.

Edit: tvpeter#1.

tvpeter · 2025-12-12T19:25:39Z

I can work on testing Core v28.

Alright, that's fine👍. Thank you

ValuedMammal · 2025-12-17T15:48:38Z

To consider this ready to merge I would want to check Client compatibility with the 3 latest versions of Bitcoin Core, I think we should tackle #19 as well, and it would be great to have a draft PR on bdk_bitcoind_rpc using the new Client struct.

oleonardolima

cACK 6a38a71

I did a first round of review in this one, I reviewed commit by commit, so some comments might not apply as they were addressed in other commits. However, I didn't tested it yet.

Overall, I'd like to mention my comment about the verbose options, I don't those are necessary w.r.t to bdk_bitcoind_rpc usage as we don't use those AFAICT.

I think most of the methods could just be a one-line fn call, it's just decoding/deserializing it either by accessing a specific field or calling .into_model(), but that's my personal taste.

About the method's documentation, you could update it to link it to the types (e.g [Header]).

About the tests, do you plan to integrate the usage of corepc_node for it in this PR, or in a follow-up one ?

oleonardolima · 2025-12-19T20:03:16Z

src/client.rs

+    /// Get block verboseone
+    pub fn get_block_verbose(&self, block_hash: &BlockHash) -> Result<GetBlockVerboseOne, Error> {
+        let res: GetBlockVerboseOne = self.call("getblock", &[json!(block_hash), json!(1)])?;
+        Ok(res)
+    }


Do we want to have support for getblock with the verbose flag? I don't see it being used by bdk_bitcoind_rpc.

I think this is the same as get_block_info that is used by the Emitter.

oleonardolima · 2025-12-19T20:04:19Z

src/client.rs

+    /// Get best block hash
    pub fn get_best_block_hash(&self) -> Result<BlockHash, Error> {
        let res: String = self.call("getbestblockhash", &[])?;
        Ok(res.parse()?)
    }


Same here, I don't think we need to support it.

src/client.rs

oleonardolima · 2025-12-19T20:22:06Z

src/client.rs

-        let res: String = self.call("getbestblockhash", &[])?;
-        Ok(res.parse()?)
+        let best_block_hash: String = self.call("getbestblockhash", &[])?;
+        Ok(best_block_hash.parse()?)


Does the .parse() uses the rust-bitcoin consensus encode/decode in the background ? 🤔

No, it doesn't. Rust-bitcoin implements the FromStr trait for BlockHash making .parse() method available (as it is available on any type that implements the trait). It is preferred for handling endianness representations

src/client.rs

tvpeter · 2025-12-19T21:13:29Z

About the tests, do you plan to integrate the usage of corepc_node for it in this PR, or in a follow-up one ?

yes, the corepc_node will be part of this PR.

Those comments that are not already addressed will be addressed in the next push.
Thank you.

src/client/v29.rs

src/client.rs

tests/test_rpc_client.rs

src/client/v28.rs

oleonardolima · 2026-01-20T22:40:53Z

@tvpeter Let me know when you need another round of review here.

tvpeter · 2026-01-21T01:55:29Z

@tvpeter Let me know when you need another round of review here.

Alright

ValuedMammal

Made some comments regarding the error module

Suggestions for simpler names
Suggest to remove unused HexToBytes
Don't implement Error::source ?
Use explicit names when doing map_err

src/error.rs

ValuedMammal · 2026-01-28T20:42:30Z

src/error.rs

+            Error::DecodeHex(e) => Some(e),
+            Error::GetBlockVerboseOneError(e) => Some(e),
+            Error::Overflow(e) => Some(e),
+            Error::GetBlockFilterError(e) => Some(e),


❓ Is it necessary to implement source here (If not, I'd say remove it). From the docs for std::error::Error:

In error types that wrap an underlying error, the underlying error should be either returned by the outer error’s Error::source(), or rendered by the outer error’s Display implementation, but not both.

src/error.rs

src/client.rs

ValuedMammal · 2026-01-28T21:23:56Z

While reviewing the code in test_rpc_client.rs I thought it'd be worthwhile to develop a simple test harness, similar to what's used in bdk_testenv but tailored to what we need here compare.

tvpeter · 2026-01-28T21:35:07Z

While reviewing the code in test_rpc_client.rs I thought it'd be worthwhile to develop a simple test harness, similar to what's used in bdk_testenv but tailored to what we need here compare.

Yes, I noticed how clean the TestEnv made the tests across the crates.

tvpeter · 2026-01-30T13:59:00Z

While reviewing the code in test_rpc_client.rs I thought it'd be worthwhile to develop a simple test harness, similar to what's used in bdk_testenv but tailored to what we need here compare.

Can this come in a different PR?

ValuedMammal

ACK f076f6f; tested on Bitcoin Core versions 28.1 and 29.0.

I have some remaining comments that can probably be done in a followup PR.

src/client.rs

ValuedMammal · 2026-01-30T17:43:41Z

src/error.rs

📌 Overlooked it, but seems we'll still need an implementation of std::error::Error for Error.

impl std::error::Error for Error {}

- getblockcount - getblockhash - getblockfilter - getblockheader - getrawmempool - getrawtransaction

- update `corepc-types` to v0.11.0 to support Bitcoind v30

- refactor tests - update the error enum

- update json-rpc to v0.19.0 - switch from minreq_http to bitreq_http

oleonardolima

Looks like it's almost there, I'm only looking forward to bitcoindevkit/bdk#2109 being rebased on top of master so I could test it through that PR.

Also, we should use the same standard of other BDK projects and not commit the Cargo.lock file.

oleonardolima · 2026-02-03T14:28:10Z

Cargo.toml

 [dependencies]
 corepc-types = { version = "0.11.0", features = ["default"]}
-jsonrpc = { version = "0.18.0", features = ["simple_http", "simple_tcp", "minreq_http", "simple_uds", "proxy"] }
+jsonrpc = { version = "0.19.0", features = ["simple_http", "simple_tcp", "bitreq_http", "simple_uds", "proxy"] }


question: do we need all these features ? I guess probably only bitreq and proxy ones are sufficient.

Initially, I wanted all features because the client should support all JSON-RPC transport layers. It appears that #27 will eventually remove them.

ValuedMammal · 2026-02-11T21:46:37Z

reACK 06526db

f1db39a ci: Run `test_rpc_client` integration tests (valued mammal) ee52af4 test: Improve unit, integration tests (valued mammal) d77416c error: Unimplement `Error::source` (valued mammal) Pull request description: ### Description This is a follow up to #5 that introduces a `TestEnv` struct used for integration tests and fixes a number of nitpicks that were previously left out. Summary: - Add simple `TestEnv` struct with convenient interface for improved ergonomics - Avoid manually implementing RPC calls (e.g. `generate_to_address`) - Move auth tests to `client::test_auth` module - Ignore (or remove) test using potentially insecure `std::env::tempdir` - Don't call `node.stop()`, as this is handled by the `Drop` implementation of `Node` - Add missing tests for existing RPC methods `get_block_verbose`, `get_block_header_verbose` - Don't print to stdout - Have more effective test assertions. For example it's sufficient to check that the RPC method returns the expected type. Keep some basic "sanity check" assertions, but try to avoid testing functionality that is defined outside of this library (e.g. the length of a `BlockHash`, and Bitcoin Core itself). ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) * [x] I ran `cargo fmt` and `cargo clippy` before committing ACKs for top commit: ValuedMammal: self-ACK f1db39a Tree-SHA512: 3634e0e00ed910b979eb998ad13b6a786f827a679495a12237c543a9a8e291eb04602cf0105753fa56dc542cdb57471d87bf630b8afee3bd1564d558cb1b016b

oleonardolima self-requested a review November 19, 2025 17:38

oleonardolima assigned tvpeter Nov 19, 2025

oleonardolima added the enhancement New feature or request label Nov 19, 2025

oleonardolima added this to BDK Chain Nov 19, 2025

tvpeter force-pushed the feat/blockchain-rpc-methods branch 2 times, most recently from 6543635 to 3a16fa4 Compare November 25, 2025 05:22

ValuedMammal reviewed Nov 27, 2025

View reviewed changes

src/client.rs Outdated Show resolved Hide resolved

src/client.rs Outdated Show resolved Hide resolved

src/client.rs Outdated Show resolved Hide resolved

src/client.rs Outdated Show resolved Hide resolved

tvpeter force-pushed the feat/blockchain-rpc-methods branch 2 times, most recently from 3632601 to 685e258 Compare December 10, 2025 17:16

tvpeter mentioned this pull request Dec 11, 2025

Use corepc_node to minimize manual testing and integration tests in CI #19

Closed

tvpeter force-pushed the feat/blockchain-rpc-methods branch from c5f1106 to 61599ad Compare December 11, 2025 14:06

tvpeter requested a review from ValuedMammal December 11, 2025 14:10

ValuedMammal reviewed Dec 12, 2025

View reviewed changes

src/client.rs Outdated Show resolved Hide resolved

tvpeter force-pushed the feat/blockchain-rpc-methods branch 2 times, most recently from bb3f1b1 to b0731c1 Compare December 13, 2025 09:59

tvpeter force-pushed the feat/blockchain-rpc-methods branch from cbbedbe to 0778704 Compare December 18, 2025 07:34

oleonardolima moved this to Needs Review in BDK Chain Dec 19, 2025

oleonardolima reviewed Dec 19, 2025

View reviewed changes

ValuedMammal reviewed Dec 20, 2025

View reviewed changes

src/client/v29.rs Outdated Show resolved Hide resolved

src/client.rs Outdated Show resolved Hide resolved

tests/test_rpc_client.rs Show resolved Hide resolved

src/client/v28.rs Outdated Show resolved Hide resolved

tvpeter force-pushed the feat/blockchain-rpc-methods branch from c036a8d to 17266ca Compare December 21, 2025 04:32

oleonardolima mentioned this pull request Jan 20, 2026

feat(client)!: update to new jsonrpc dependency and use bitreq instead #20

Closed

ValuedMammal mentioned this pull request Jan 28, 2026

build(deps): bump corepc-types from 0.10.1 to 0.11.0 #13

Closed

ValuedMammal reviewed Jan 28, 2026

View reviewed changes

tvpeter mentioned this pull request Jan 29, 2026

Refactor: update bdk-bitcoind-rpc to use bdk-bitcoind-client bitcoindevkit/bdk#2109

Closed

1 task

tvpeter force-pushed the feat/blockchain-rpc-methods branch 3 times, most recently from ee2ebf6 to f076f6f Compare January 30, 2026 13:53

ValuedMammal approved these changes Jan 30, 2026

View reviewed changes

src/client.rs Outdated Show resolved Hide resolved

src/client.rs Outdated Show resolved Hide resolved

ValuedMammal reviewed Jan 30, 2026

View reviewed changes

ValuedMammal mentioned this pull request Jan 30, 2026

test: Add testenv module #26

Merged

3 tasks

tvpeter force-pushed the feat/blockchain-rpc-methods branch from f076f6f to fe96e78 Compare January 30, 2026 20:49

tvpeter and others added 5 commits January 30, 2026 22:48

feat(client): Add RPC methods

9a9779b

- getblockcount - getblockhash - getblockfilter - getblockheader - getrawmempool - getrawtransaction

test: Add client integration tests

5367165

- update `corepc-types` to v0.11.0 to support Bitcoind v30

feat(client): Add v28 module

3374d27

test: Use corepc-node for integration tests

160a130

- refactor tests - update the error enum

feat(client): Remove Auth::None and update Error

6ff6641

tvpeter force-pushed the feat/blockchain-rpc-methods branch from fe96e78 to 6ff6641 Compare January 30, 2026 21:51

tvpeter requested a review from oleonardolima January 30, 2026 21:54

feat(client): Update json-rpc & switch to bitreq

06526db

- update json-rpc to v0.19.0 - switch from minreq_http to bitreq_http

tvpeter mentioned this pull request Feb 3, 2026

Docs: Update README for library #28

Open

3 tasks

oleonardolima reviewed Feb 3, 2026

View reviewed changes

tvpeter mentioned this pull request Feb 9, 2026

Refactor: update bdk-bitcoind-rpc to use bdk-bitcoind-client bitcoindevkit/bdk#2119

Draft

1 task

ValuedMammal merged commit ae754b3 into bitcoindevkit:master Feb 11, 2026
9 checks passed

github-project-automation bot moved this from Needs Review to Done in BDK Chain Feb 11, 2026

Add Blockchain RPC methods #5

Add Blockchain RPC methods #5

Conversation

tvpeter commented Nov 18, 2025 • edited by ValuedMammal Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklists

All Submissions:

New Features:

Uh oh!

ValuedMammal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ValuedMammal commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tvpeter commented Dec 12, 2025

Uh oh!

ValuedMammal commented Dec 17, 2025

Uh oh!

oleonardolima left a comment

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!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tvpeter commented Dec 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleonardolima commented Jan 20, 2026

Uh oh!

tvpeter commented Jan 21, 2026

Uh oh!

ValuedMammal 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ValuedMammal commented Jan 28, 2026

Uh oh!

tvpeter commented Jan 28, 2026

Uh oh!

tvpeter commented Jan 30, 2026

Uh oh!

ValuedMammal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

tvpeter commented Nov 18, 2025 •

edited by ValuedMammal

Loading

ValuedMammal commented Dec 12, 2025 •

edited

Loading

ValuedMammal left a comment •

edited

Loading