Skip to content

removed DB v1.0.0 -> v1.1.0 migration #914

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

Open
idky137 wants to merge 1 commit into
base: dev
Choose a base branch
from
+1 −104
Open

removed DB v1.0.0 -> v1.1.0 migration #914

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
12 changes: 1 addition & 11 deletions zaino-state/src/chain_index/finalised_state/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,7 @@ Migration
Bug Fixes / Optimisations
- Complete DB rework
--------------------------------------------------------------------------------
DB VERSION v1.1.0 (from v1.0.0)
Date: 2026-01-27
DB VERSION v1.0.0 (RC Bug Fixes)
--------------------------------------------------------------------------------

Summary
Expand Down Expand Up @@ -141,15 +140,6 @@ API / capabilities
- CompactBlockExt::get_compact_block(height, pool_types: PoolTypeFilter) signature updated.
- Compact block contents are now filtered by PoolTypeFilter, and may include transparent transaction data (vin/vout) when selected.

Migration
- Strategy: In-place (metadata-only).
- Backfill: None.
- Completion criteria:
- DbMetadata.version updated from 1.0.0 to 1.1.0.
- DbMetadata.migration_status reset to Empty.
- Failure handling:
- Idempotent: re-running re-writes the same metadata; no partial state beyond metadata.

Bug Fixes / Optimisations
- Added safety check for idempotent DB writes
- Updated 'fix_addr_hist_records_by_addr_and_index_blocking' to take and reuse an lmdb ro transaction, improving initial sync performance.
Expand Down
93 changes: 0 additions & 93 deletions zaino-state/src/chain_index/finalised_state/migrations.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,26 +111,6 @@
//! - Mark `migration_status = Complete` in shadow metadata.
//! - Promote shadow to primary via `router.promote_shadow()`.
//! - Delete the old v0 directory asynchronously once all strong references are dropped.
//!
//! ## v1.0.0 → v1.1.0
//!
//! `Migration1_0_0To1_1_0` is a **minor version bump** with **no schema changes**, but does include
//! changes to the external ZainoDB API.
//!
//! It updates the stored `DbMetadata` version to reflect the v1.1.0 API contract:
//! - `CompactBlockExt` now includes `get_compact_block_stream(...)`.
//! - compact block transaction materialization is now selected via `PoolTypeFilter` (including
//! optional transparent data).
//!
//! This release also introduces [`MigrationStep`], the enum-based migration dispatcher used by
//! [`MigrationManager`], to allow selecting between multiple concrete migration implementations.
//!
//! Bug Fixes / Improvements:
//! - Added safety check for idempotent DB writes
//!
//! Efficiency improvements:
//! - Updated 'fix_addr_hist_records_by_addr_and_index_blocking' to take and reuse an lmdb ro
//! transaction, improving initial sync performance.

use super::{
capability::{
Expand Down Expand Up @@ -291,7 +271,6 @@ impl<T: BlockchainSource> MigrationManager<T> {
self.current_version.patch,
) {
(0, 0, 0) => Ok(MigrationStep::Migration0_0_0To1_0_0(Migration0_0_0To1_0_0)),
(1, 0, 0) => Ok(MigrationStep::Migration1_0_0To1_1_0(Migration1_0_0To1_1_0)),
(_, _, _) => Err(FinalisedStateError::Custom(format!(
"Missing migration from version {}",
self.current_version
Expand All @@ -307,7 +286,6 @@ impl<T: BlockchainSource> MigrationManager<T> {
/// to select a step and call `migrate(...)`, and to read the step’s `TO_VERSION`.
enum MigrationStep {
Migration0_0_0To1_0_0(Migration0_0_0To1_0_0),
Migration1_0_0To1_1_0(Migration1_0_0To1_1_0),
}

impl MigrationStep {
Expand All @@ -316,9 +294,6 @@ impl MigrationStep {
MigrationStep::Migration0_0_0To1_0_0(_step) => {
<Migration0_0_0To1_0_0 as Migration<T>>::TO_VERSION
}
MigrationStep::Migration1_0_0To1_1_0(_step) => {
<Migration1_0_0To1_1_0 as Migration<T>>::TO_VERSION
}
}
}

Expand All @@ -330,7 +305,6 @@ impl MigrationStep {
) -> Result<(), FinalisedStateError> {
match self {
MigrationStep::Migration0_0_0To1_0_0(step) => step.migrate(router, cfg, source).await,
MigrationStep::Migration1_0_0To1_1_0(step) => step.migrate(router, cfg, source).await,
}
}
}
Expand Down Expand Up @@ -533,70 +507,3 @@ impl<T: BlockchainSource> Migration<T> for Migration0_0_0To1_0_0 {
Ok(())
}
}

/// Minor migration: v1.0.0 → v1.1.0.
///
/// There are **no on-disk schema changes** in this step.
///
/// This release updates the *API contract* for compact blocks:
/// - [`CompactBlockExt`] adds `get_compact_block_stream(...)`.
/// - Compact block transaction materialization is selected via [`PoolTypeFilter`], which may include
/// transparent data.
///
/// This release also introduces [`MigrationStep`], the enum-based migration dispatcher used by
/// [`MigrationManager`], to allow selecting between multiple concrete migration implementations.
///
/// Because the persisted schema contract is unchanged, this migration only updates the stored
/// [`DbMetadata::version`] from `1.0.0` to `1.1.0`.
///
/// Bug Fixes:
/// - Added safety check for idempotent DB writes
///
/// Safety and resumability:
/// - Idempotent: if run more than once, it will re-write the same metadata.
/// - No shadow database and no table rebuild.
/// - Clears any stale in-progress migration status.
///
/// Efficiency improvements:
/// - Updated 'fix_addr_hist_records_by_addr_and_index_blocking' to take and reuse an lmdb ro
/// transaction, improving initial sync performance.
struct Migration1_0_0To1_1_0;

#[async_trait]
impl<T: BlockchainSource> Migration<T> for Migration1_0_0To1_1_0 {
const CURRENT_VERSION: DbVersion = DbVersion {
major: 1,
minor: 0,
patch: 0,
};

const TO_VERSION: DbVersion = DbVersion {
major: 1,
minor: 1,
patch: 0,
};

async fn migrate(
&self,
router: Arc<Router>,
_cfg: BlockCacheConfig,
_source: T,
) -> Result<(), FinalisedStateError> {
info!("Starting v1.0.0 → v1.1.0 migration (metadata-only).");

let mut metadata: DbMetadata = router.get_metadata().await?;

// Preserve the schema hash because there are no schema changes in v1.1.0.
// Only advance the version marker to reflect the new API contract.
metadata.version = <Self as Migration<T>>::TO_VERSION;

// Outside of migrations this should be `Empty`. This step performs no build phases, so we
// ensure we do not leave a stale in-progress status behind.
metadata.migration_status = MigrationStatus::Empty;

router.update_metadata(metadata).await?;

info!("v1.0.0 to v1.1.0 migration complete.");
Ok(())
}
}
Loading