Skip to content

refactor: reduced amount of block hashes computed #834

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
xdustinface merged 1 commit into from
Jul 2, 2026
Merged

refactor: reduced amount of block hashes computed #834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions dash-spv/benches/storage.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ fn bench_disk_storage(c: &mut Criterion) {

let rt = Builder::new_multi_thread().worker_threads(4).enable_all().build().unwrap();

let headers = (0..NUM_ELEMENTS).map(create_test_header).collect::<Vec<Header>>();
let headers = (0..NUM_ELEMENTS)
.map(create_test_header)
.map(dash_spv::types::HashedBlockHeader::from)
.collect::<Vec<_>>();
let mut rng = StdRng::seed_from_u64(SEED);

c.bench_function("storage/disk/store", |b| {
Expand Down Expand Up @@ -75,7 +78,7 @@ fn bench_disk_storage(c: &mut Criterion) {
b.to_async(&rt).iter_batched(
|| {
let height = rand::random::<u32>() % NUM_ELEMENTS;
headers[height as usize].block_hash()
*headers[height as usize].hash()
},
async |hash| {
let _ = storage.get_header_height_by_hash(&hash).await.unwrap();
Expand Down
10 changes: 8 additions & 2 deletions dash-spv/src/client/lifecycle.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,10 @@ impl<W: WalletInterface, N: NetworkManager, S: StorageManager> DashSpvClient<W,
);
} else {
storage
.store_headers_at_height(&[checkpoint_header], checkpoint.height)
.store_headers_at_height(
&[crate::types::HashedBlockHeader::from(checkpoint_header)],
checkpoint.height,
)
.await?;

tracing::info!(
Expand Down Expand Up @@ -332,7 +335,10 @@ impl<W: WalletInterface, N: NetworkManager, S: StorageManager> DashSpvClient<W,
tracing::debug!("Using genesis block header with hash: {}", calculated_hash);

// Store the genesis header at height 0
storage.store_headers(&[genesis_header]).await.map_err(SpvError::Storage)?;
storage
.store_headers(&[crate::types::HashedBlockHeader::from(genesis_header)])
.await
.map_err(SpvError::Storage)?;

// Verify it was stored correctly
let stored_height = storage.get_tip_height().await;
Expand Down
74 changes: 21 additions & 53 deletions dash-spv/src/storage/block_headers.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,20 +42,9 @@ impl BlockHeaderTip {

#[async_trait]
pub trait BlockHeaderStorage: Send + Sync + 'static {
async fn store_headers(&mut self, headers: &[BlockHeader]) -> StorageResult<()>;
async fn store_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()>;

async fn store_headers_at_height(
&mut self,
headers: &[BlockHeader],
height: u32,
) -> StorageResult<()>;

//TODO - change API of the BlockHeaderStorage trait to accept (store) and return (load)
// HashedBlockHeaders instead of BlockHeaders to avoid unnecessary hashing and remove
// the two store_hashed_headers methods below.
async fn store_hashed_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()>;

async fn store_hashed_headers_at_height(
&mut self,
headers: &[HashedBlockHeader],
height: u32,
Expand All @@ -66,9 +55,9 @@ pub trait BlockHeaderStorage: Send + Sync + 'static {
/// Returns `StorageError::InvalidArgument` when the range extends into a
/// segment queued for deletion by a prior `truncate_above` (before the next
/// `persist`). Callers must clamp the range to at most `get_tip_height`.
async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<BlockHeader>>;
async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<HashedBlockHeader>>;

async fn get_header(&self, height: u32) -> StorageResult<Option<BlockHeader>> {
async fn get_header(&self, height: u32) -> StorageResult<Option<HashedBlockHeader>> {
if let Some(tip_height) = self.get_tip_height().await {
if height > tip_height {
return Ok(None);
Expand All @@ -85,7 +74,7 @@ pub trait BlockHeaderStorage: Send + Sync + 'static {
return Ok(None);
}

Ok(self.load_headers(height..height + 1).await?.first().copied())
Ok(self.load_headers(height..height + 1).await?.into_iter().next())
}

async fn get_tip_height(&self) -> Option<u32>;
Expand Down Expand Up @@ -161,27 +150,12 @@ impl PersistentStorage for PersistentBlockHeaderStorage {

#[async_trait]
impl BlockHeaderStorage for PersistentBlockHeaderStorage {
async fn store_headers(&mut self, headers: &[BlockHeader]) -> StorageResult<()> {
async fn store_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()> {
let height = self.block_headers.read().await.next_height();
self.store_headers_at_height(headers, height).await
}

async fn store_headers_at_height(
&mut self,
headers: &[BlockHeader],
height: u32,
) -> StorageResult<()> {
let headers =
headers.iter().map(HashedBlockHeader::from).collect::<Vec<HashedBlockHeader>>();
self.store_hashed_headers_at_height(&headers, height).await
}

async fn store_hashed_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()> {
let height = self.block_headers.read().await.next_height();
self.store_hashed_headers_at_height(headers, height).await
}

async fn store_hashed_headers_at_height(
&mut self,
headers: &[HashedBlockHeader],
height: u32,
Expand All @@ -198,16 +172,9 @@ impl BlockHeaderStorage for PersistentBlockHeaderStorage {
Ok(())
}

async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<BlockHeader>> {
Ok(self
.block_headers
.write()
.await
.get_items(range)
.await?
.into_iter()
.map(|cached| *cached.header())
.collect())
// Returns the cached `HashedBlockHeader`s straight from the segment cache — no recomputation.
async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<HashedBlockHeader>> {
self.block_headers.write().await.get_items(range).await
}

async fn get_tip_height(&self) -> Option<u32> {
Expand Down Expand Up @@ -268,23 +235,27 @@ mod tests {
use super::*;
use tempfile::TempDir;

fn hashed_batch(r: std::ops::Range<u32>) -> Vec<HashedBlockHeader> {
BlockHeader::dummy_batch(r).into_iter().map(HashedBlockHeader::from).collect()
}

#[tokio::test]
async fn test_get_tip() {
let headers = BlockHeader::dummy_batch(0..5);
let headers = hashed_batch(0..5);
let tmp_dir = TempDir::new().unwrap();
let mut storage = PersistentBlockHeaderStorage::open(tmp_dir.path()).await.unwrap();
// Tip should be none before storing headers
assert!(storage.get_tip().await.is_none());
// Add one header and validate tip
storage.store_headers(&headers[0..1]).await.unwrap();
let tip = storage.get_tip().await.unwrap();
let expected_tip = BlockHeaderTip::new(0, HashedBlockHeader::from(headers[0]));
let expected_tip = BlockHeaderTip::new(0, headers[0].clone());
assert_eq!(tip, expected_tip);
assert_eq!(storage.get_tip_height().await, Some(0));
// Add multiple headers and validate tip
storage.store_headers(&headers[1..]).await.unwrap();
let tip = storage.get_tip().await.unwrap();
let expected_tip = BlockHeaderTip::new(4, HashedBlockHeader::from(headers[4]));
let expected_tip = BlockHeaderTip::new(4, headers[4].clone());
assert_eq!(tip, expected_tip);
assert_eq!(storage.get_tip_height().await, Some(4));
}
Expand All @@ -294,35 +265,32 @@ mod tests {
let tmp_dir = TempDir::new().unwrap();
let mut storage = PersistentBlockHeaderStorage::open(tmp_dir.path()).await.unwrap();

let headers = BlockHeader::dummy_batch(0..10);
let headers = hashed_batch(0..10);
storage.store_headers(&headers).await.unwrap();

let orphaned_hash = headers[7].block_hash();
let orphaned_hash = *headers[7].hash();
assert_eq!(storage.get_header_height_by_hash(&orphaned_hash).await.unwrap(), Some(7));

storage.truncate_above(100).await.unwrap();
assert_eq!(storage.get_tip_height().await, Some(9));
assert_eq!(
storage.get_header_height_by_hash(&headers[4].block_hash()).await.unwrap(),
Some(4)
);
assert_eq!(storage.get_header_height_by_hash(headers[4].hash()).await.unwrap(), Some(4));

storage.truncate_above(5).await.unwrap();

assert_eq!(storage.get_tip_height().await, Some(5));
assert_eq!(storage.get_header_height_by_hash(&orphaned_hash).await.unwrap(), None);

let kept_hash = headers[3].block_hash();
let kept_hash = *headers[3].hash();
assert_eq!(storage.get_header_height_by_hash(&kept_hash).await.unwrap(), Some(3));

let replacement = BlockHeader::dummy_batch(100..105);
let replacement = hashed_batch(100..105);
storage.store_headers_at_height(&replacement, 6).await.unwrap();
assert_eq!(storage.get_tip_height().await, Some(10));

let reloaded = storage.load_headers(6..11).await.unwrap();
assert_eq!(reloaded, replacement);

let new_hash = replacement[0].block_hash();
let new_hash = *replacement[0].hash();
assert_eq!(storage.get_header_height_by_hash(&new_hash).await.unwrap(), Some(6));

// Exercise the durability contract: persist, drop, reopen, and verify
Expand Down
55 changes: 23 additions & 32 deletions dash-spv/src/storage/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ use crate::ClientConfig;
use async_trait::async_trait;
use dashcore::hash_types::FilterHeader;
use dashcore::prelude::CoreBlockHeight;
use dashcore::Header as BlockHeader;
use std::ops::Range;
use std::path::PathBuf;
use std::sync::Arc;
Expand Down Expand Up @@ -269,31 +268,19 @@ impl StorageManager for DiskStorageManager {

#[async_trait]
impl BlockHeaderStorage for DiskStorageManager {
async fn store_headers(&mut self, headers: &[BlockHeader]) -> StorageResult<()> {
async fn store_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()> {
self.block_headers.write().await.store_headers(headers).await
}

async fn store_headers_at_height(
&mut self,
headers: &[BlockHeader],
height: u32,
) -> StorageResult<()> {
self.block_headers.write().await.store_headers_at_height(headers, height).await
}

async fn store_hashed_headers(&mut self, headers: &[HashedBlockHeader]) -> StorageResult<()> {
self.block_headers.write().await.store_hashed_headers(headers).await
}

async fn store_hashed_headers_at_height(
&mut self,
headers: &[HashedBlockHeader],
height: u32,
) -> StorageResult<()> {
self.block_headers.write().await.store_hashed_headers_at_height(headers, height).await
self.block_headers.write().await.store_headers_at_height(headers, height).await
}

async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<BlockHeader>> {
async fn load_headers(&self, range: Range<u32>) -> StorageResult<Vec<HashedBlockHeader>> {
self.block_headers.read().await.load_headers(range).await
}

Expand Down Expand Up @@ -426,14 +413,18 @@ mod tests {
use dashcore::Header as BlockHeader;
use tempfile::TempDir;

fn hashed_batch(r: std::ops::Range<u32>) -> Vec<HashedBlockHeader> {
BlockHeader::dummy_batch(r).into_iter().map(HashedBlockHeader::from).collect()
}

#[tokio::test]
async fn test_store_load_headers() -> Result<(), Box<dyn std::error::Error>> {
// Create a temporary directory for the test
let temp_dir = TempDir::new()?;
let config = ClientConfig::testnet().with_storage_path(temp_dir.path());
let mut storage = DiskStorageManager::new(&config).await.expect("Unable to create storage");

let headers = BlockHeader::dummy_batch(0..60_000);
let headers = hashed_batch(0..60_000);

storage.store_headers(&headers[0..0]).await.expect("Should handle empty header batch");
assert_eq!(storage.get_tip_height().await, None);
Expand Down Expand Up @@ -478,8 +469,8 @@ mod tests {

// Create test headers starting from checkpoint height
const CHECKPOINT_HEIGHT: u32 = 1_100_000;
let headers: Vec<BlockHeader> =
BlockHeader::dummy_batch(CHECKPOINT_HEIGHT..CHECKPOINT_HEIGHT + 100);
let headers: Vec<HashedBlockHeader> =
hashed_batch(CHECKPOINT_HEIGHT..CHECKPOINT_HEIGHT + 100);

storage.store_headers_at_height(&headers, CHECKPOINT_HEIGHT).await?;

Expand All @@ -496,26 +487,26 @@ mod tests {

async fn check_storage(
storage: &DiskStorageManager,
headers: &[BlockHeader],
headers: &[HashedBlockHeader],
) -> StorageResult<()> {
assert_eq!(storage.get_stored_headers_len().await, headers.len() as u32);

let header_at_base = storage.get_header(CHECKPOINT_HEIGHT).await?;
assert_eq!(header_at_base, Some(headers[0]));
assert_eq!(header_at_base, Some(headers[0].clone()));

let header_at_ending = storage.get_header(CHECKPOINT_HEIGHT + 99).await?;
assert_eq!(header_at_ending, Some(headers[99]));
assert_eq!(header_at_ending, Some(headers[99].clone()));

// Test the reverse index (hash -> blockchain height)
let hash_0 = headers[0].block_hash();
let hash_0 = *headers[0].hash();
let height_0 = storage.get_header_height_by_hash(&hash_0).await?;
assert_eq!(
height_0,
Some(CHECKPOINT_HEIGHT),
"Hash should map to blockchain height 1,100,000"
);

let hash_99 = headers[99].block_hash();
let hash_99 = *headers[99].hash();
let height_99 = storage.get_header_height_by_hash(&hash_99).await?;
assert_eq!(
height_99,
Expand All @@ -536,13 +527,13 @@ mod tests {
let mut storage = DiskStorageManager::new(&config).await.unwrap();

// Create and store headers
let headers = BlockHeader::dummy_batch(0..10);
let headers = hashed_batch(0..10);

storage.store_headers(&headers).await.unwrap();

// Test reverse lookups
for (i, header) in headers.iter().enumerate() {
let hash = header.block_hash();
let hash = *header.hash();
let height = storage.get_header_height_by_hash(&hash).await.unwrap();
assert_eq!(height, Some(i as u32), "Height mismatch for header {}", i);
}
Expand All @@ -558,7 +549,7 @@ mod tests {
// We need to get the actual headers that were stored to test properly
for i in 0..10 {
let stored_header = storage.get_header(i).await.unwrap().unwrap();
let hash = stored_header.block_hash();
let hash = *stored_header.hash();
let height = storage.get_header_height_by_hash(&hash).await.unwrap();
assert_eq!(height, Some(i), "Height mismatch after reload for header {}", i);
}
Expand All @@ -571,10 +562,10 @@ mod tests {
DiskStorageManager::with_temp_dir().await.expect("Failed to create tmp storage");

// Store some headers
let header = BlockHeader::dummy_batch(0..1);
let header = hashed_batch(0..1);
storage.store_headers(&header).await.unwrap();

let hash = header[0].block_hash();
let hash = *header[0].hash();
assert!(storage.get_header_height_by_hash(&hash).await.unwrap().is_some());

// Clear storage
Expand All @@ -590,18 +581,18 @@ mod tests {
let config = ClientConfig::regtest().with_storage_path(temp_dir.path());
let mut mgr = DiskStorageManager::new(&config).await.unwrap();

let headers = BlockHeader::dummy_batch(0..10);
let headers = hashed_batch(0..10);
mgr.store_headers(&headers).await.unwrap();

let orphaned_hash = headers[7].block_hash();
let orphaned_hash = *headers[7].hash();
assert_eq!(mgr.get_header_height_by_hash(&orphaned_hash).await.unwrap(), Some(7));

<DiskStorageManager as BlockHeaderStorage>::truncate_above(&mut mgr, 5).await.unwrap();

assert_eq!(mgr.get_tip_height().await, Some(5));
assert_eq!(mgr.get_header_height_by_hash(&orphaned_hash).await.unwrap(), None);

let kept_hash = headers[3].block_hash();
let kept_hash = *headers[3].hash();
assert_eq!(mgr.get_header_height_by_hash(&kept_hash).await.unwrap(), Some(3));
}

Expand Down
9 changes: 7 additions & 2 deletions dash-spv/src/sync/block_headers/manager.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ impl<H: BlockHeaderStorage, M: MetadataStorage> BlockHeadersManager<H, M> {
BlockHeaderValidator::new().validate(headers)?;

// Store headers
self.header_storage.write().await.store_hashed_headers(headers).await?;
self.header_storage.write().await.store_headers(headers).await?;

let tip = self.tip().await?;

Expand Down Expand Up @@ -277,7 +277,12 @@ mod tests {
let mut storage = DiskStorageManager::with_temp_dir().await.unwrap();
// Store a genesis header so the manager can initialize
let genesis = Header::dummy_batch(0..1);
storage.store_headers(&genesis).await.unwrap();
storage
.store_headers(
&genesis.iter().map(crate::types::HashedBlockHeader::from).collect::<Vec<_>>(),
)
.await
.unwrap();
let checkpoint_manager = create_test_checkpoint_manager();
BlockHeadersManager::new(storage.block_headers(), storage.metadata(), checkpoint_manager)
.await
Expand Down
Loading
Loading