Skip to content

Remove deprecated BlockSummary and get_blocks #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
luisschwab merged 2 commits into from
Jul 8, 2026
Merged

Remove deprecated BlockSummary and get_blocks #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd14a2e
chore!: remove deprecated `BlockSummary` and `get_block`
luisschwab Jul 3, 2026
32f76da
chore: bump Rust toolchains
luisschwab Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

## [Unreleased]

### Added

### Changed

* chore!: remove deprecated `BlockSummary` and `get_block` [#225]

### Fixed

## [0.13.0] – 2026-06-28

### Added
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ blocking-https-rustls = ["blocking", "bitreq/https-rustls"]
blocking-https-rustls-probe = ["blocking", "bitreq/https-rustls-probe"]

[package.metadata.rbmt.toolchains]
stable = "1.96.0"
nightly = "nightly-2026-05-08"
stable = "1.96.1"
nightly = "nightly-2026-07-03"

[package.metadata.docs.rs]
all-features = true
Expand Down
19 changes: 0 additions & 19 deletions src/api.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ use std::collections::HashMap;

pub use bitcoin::consensus::{deserialize, serialize};
use bitcoin::hash_types;
use bitcoin::hash_types::TxMerkleNode;
pub use bitcoin::hex::FromHex;
pub use bitcoin::{
absolute, block, transaction, Address, Amount, Block, BlockHash, CompactTarget, FeeRate,
Expand Down Expand Up @@ -211,24 +210,6 @@ pub struct BlockTime {
pub height: u32,
}

/// Summary about a [`Block`].
#[allow(deprecated)]
#[deprecated(since = "0.13.0", note = "use `BlockInfo` instead")]
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
pub struct BlockSummary {
/// The [`BlockHash`] of the [`Block`].
pub id: BlockHash,
/// The UNIX timestamp and height of the [`Block`].
#[serde(flatten)]
pub time: BlockTime,
/// The [`BlockHash`] of the previous [`Block`].
///
/// `None` for the genesis block.
pub previousblockhash: Option<BlockHash>,
/// The Merkle root of this [`Block`].
pub merkle_root: TxMerkleNode,
}

/// Statistics about an [`Address`].
#[derive(Debug, Clone, Deserialize, PartialEq, Eq)]
pub struct AddressStats {
Expand Down
24 changes: 0 additions & 24 deletions src/async.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,6 @@ use crate::{
OutputStatus, ScriptHashStats, SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

#[allow(deprecated)]
use crate::BlockSummary;

// FIXME: (@oleonardolima) there's no `Debug` implementation for `bitreq::Client`.
/// An async client for interacting with an Esplora API server.
///
Expand Down Expand Up @@ -687,27 +684,6 @@ impl<S: Sleeper> AsyncClient<S> {
self.get_response_json(&path).await
}

/// Get [`BlockInfo`] summaries for recent [`Block`]s.
///
/// If `height` is `Some(h)`, returns blocks starting from height `h`.
/// If `height` is `None`, returns blocks starting from the current tip.
///
/// The maximum number of summaries returned depends on the backend itself:
/// Esplora returns `10` while [mempool.space](https://mempool.space/docs/api) returns `15`.
#[allow(deprecated)]
#[deprecated(since = "0.13.0", note = "use `get_block_infos` instead")]
pub async fn get_blocks(&self, height: Option<u32>) -> Result<Vec<BlockSummary>, Error> {
let path = match height {
Some(height) => format!("/blocks/{height}"),
None => "/blocks".to_string(),
};
let blocks: Vec<BlockSummary> = self.get_response_json(&path).await?;
if blocks.is_empty() {
return Err(Error::InvalidResponse);
}
Ok(blocks)
}

/// Get [`BlockInfo`] summaries for recent [`Block`]s.
///
/// If `height` is `Some(h)`, returns blocks starting from height `h`.
Expand Down
24 changes: 0 additions & 24 deletions src/blocking.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,6 @@ use crate::{
OutputStatus, ScriptHashStats, SubmitPackageResult, TxStatus, Utxo, BASE_BACKOFF_MILLIS,
};

#[allow(deprecated)]
use crate::BlockSummary;

/// A synchronous client for interacting with an Esplora API server.
///
/// Use [`Builder`] to construct an instance of this client. The client stores
Expand Down Expand Up @@ -639,27 +636,6 @@ impl BlockingClient {
self.get_response_json(&path)
}

/// Get [`BlockInfo`] summaries for recent [`Block`]s.
///
/// If `height` is `Some(h)`, returns blocks starting from height `h`.
/// If `height` is `None`, returns blocks starting from the current tip.
///
/// The maximum number of summaries returned depends on the backend itself:
/// Esplora returns `10` while [mempool.space](https://mempool.space/docs/api) returns `15`.
#[allow(deprecated)]
#[deprecated(since = "0.13.0", note = "use `get_block_infos` instead")]
pub fn get_blocks(&self, height: Option<u32>) -> Result<Vec<BlockSummary>, Error> {
let path = match height {
Some(height) => format!("/blocks/{height}"),
None => "/blocks".to_string(),
};
let blocks: Vec<BlockSummary> = self.get_response_json(&path)?;
if blocks.is_empty() {
return Err(Error::InvalidResponse);
}
Ok(blocks)
}

/// Get [`BlockInfo`] summaries for recent [`Block`]s.
///
/// If `height` is `Some(h)`, returns blocks starting from height `h`.
Expand Down
34 changes: 0 additions & 34 deletions tests/block.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,40 +201,6 @@ async fn test_get_block_txs() {
assert_eq!(txs_blocking.len(), txs_async.len());
}

#[allow(deprecated)]
#[tokio::test]
async fn test_get_blocks() {
let env = TestEnv::new();
let (blocking_client, async_client) = env.setup_clients();

let start_height = env.bitcoind_client().get_block_count().unwrap().0;
let blocks1 = blocking_client.get_blocks(None).unwrap();
let blocks_async1 = async_client.get_blocks(None).await.unwrap();
assert_eq!(blocks1[0].time.height, start_height as u32);
assert_eq!(blocks1, blocks_async1);
env.mine_and_wait(1);

let blocks2 = blocking_client.get_blocks(None).unwrap();
let blocks_async2 = async_client.get_blocks(None).await.unwrap();
assert_eq!(blocks2, blocks_async2);
assert_ne!(blocks2, blocks1);

let blocks3 = blocking_client
.get_blocks(Some(start_height as u32))
.unwrap();
let blocks_async3 = async_client
.get_blocks(Some(start_height as u32))
.await
.unwrap();
assert_eq!(blocks3, blocks_async3);
assert_eq!(blocks3[0].time.height, start_height as u32);
assert_eq!(blocks3, blocks1);

let blocks_genesis = blocking_client.get_blocks(Some(0)).unwrap();
let blocks_genesis_async = async_client.get_blocks(Some(0)).await.unwrap();
assert_eq!(blocks_genesis, blocks_genesis_async);
}

#[tokio::test]
async fn test_get_block_info() {
let env = TestEnv::new();
Expand Down
Loading