tapdb: renumber migrations after rebase onto main

jtobin · jtobin · commit 080e146aaa42 · 2026-06-29T11:39:43.000-02:30
Main introduced 000060_asset_transfers_superseded, colliding with
this branch's 000060_unique_pending_or_frozen_batch. Renumber this
branch's migrations and all their narrative references:

  60 unique_pending_or_frozen_batch     -&gt; 61
  61 dedupe_supply_update_events        -&gt; 62
  62 backfill_supply_update_event_keys  -&gt; 63

LatestMigrationVersion bumps to 63 and the Migration62BackfillEventKeys
constant becomes Migration63BackfillEventKeys.
diff --git a/sample-tapd.conf b/sample-tapd.conf
@@ -529,7 +529,7 @@
 ; One-shot recovery: when set, tapd cancels all but the most recent
 ; minting batch in BatchStatePending or BatchStateFrozen and then
 ; exits. Used to recover a legacy database that violates the
-; singleton pre-broadcast batch invariant added in migration 000060
+; singleton pre-broadcast batch invariant added in migration 000061
 ; (e.g. one with duplicate pending batches that blocks the
 ; migration). Default value is false.
 ; repair.cancel-duplicate-batches=false
diff --git a/tapcfg/config.go b/tapcfg/config.go
@@ -365,7 +365,7 @@ type ExperimentalConfig struct {
 // for operator use after a constraint or invariant failure has
 // prevented normal startup.
 type RepairConfig struct {
-	CancelDuplicateBatches bool `long:"cancel-duplicate-batches" description:"If set, tapd cancels all but the most recent minting batch in BatchStatePending or BatchStateFrozen and then exits. Used to recover from a database that violates the singleton pre-broadcast batch invariant added in migration 000060 (e.g. a legacy DB with duplicate pending batches that blocks the migration)."`
+	CancelDuplicateBatches bool `long:"cancel-duplicate-batches" description:"If set, tapd cancels all but the most recent minting batch in BatchStatePending or BatchStateFrozen and then exits. Used to recover from a database that violates the singleton pre-broadcast batch invariant added in migration 000061 (e.g. a legacy DB with duplicate pending batches that blocks the migration)."`
 }
 
 // CleanAndValidate performs final processing on the ExperimentalConfig,
diff --git a/tapcfg/repair.go b/tapcfg/repair.go
@@ -14,19 +14,19 @@ import (
 
 // RunRepairTool inspects the configured database for batches that
 // violate the singleton "≤ 1 in {Pending, Frozen}" invariant added
-// in migration 000060, and cancels all but the most recent. The
+// in migration 000061, and cancels all but the most recent. The
 // preserved batch is the one with the latest CreationTime; cancelled
 // batches transition to BatchStateSeedlingCancelled, leaving their
 // row and seedlings on disk for later inspection.
 //
 // The function opens the database with migrations skipped, so it can
 // run against a legacy database whose state would otherwise fail the
 // migration. After this tool exits cleanly, restarting tapd normally
-// will let migration 000060 succeed.
+// will let migration 000061 succeed.
 func RunRepairTool(cfg *Config, cfgLogger btclog.Logger) error {
 	// Open the database with migrations skipped. We want to inspect
 	// and repair a database whose state would otherwise prevent
-	// migration 000060 from applying; running migrations as part of
+	// migration 000061 from applying; running migrations as part of
 	// opening the DB would defeat the purpose.
 	var (
 		db  tapdb.DatabaseBackend
@@ -127,6 +127,6 @@ func RunRepairTool(cfg *Config, cfgLogger btclog.Logger) error {
 
 	cfgLogger.Infof("repair: complete; cancelled %d duplicate "+
 		"batches, preserved 1. Restart tapd normally to let "+
-		"migration 000060 apply.", len(preBroadcast)-1)
+		"migration 000061 apply.", len(preBroadcast)-1)
 	return nil
 }
diff --git a/tapdb/asset_minting_test.go b/tapdb/asset_minting_test.go
@@ -2157,7 +2157,7 @@ func TestUpdateBatchStateMemoryCoherence(t *testing.T) {
 }
 
 // TestSingletonPreBroadcastBatchConstraint exercises the partial
-// unique index added in migration 000060. At most one
+// unique index added in migration 000061. At most one
 // asset_minting_batches row may be in BatchStatePending or
 // BatchStateFrozen at any time; the second insert into that set
 // must fail with a constraint error, and a row in
diff --git a/tapdb/migrations.go b/tapdb/migrations.go
@@ -24,7 +24,7 @@ const (
 	// daemon.
 	//
 	// NOTE: This MUST be updated when a new migration is added.
-	LatestMigrationVersion = 62
+	LatestMigrationVersion = 63
 )
 
 // DatabaseBackend is an interface that contains all methods our different
diff --git a/tapdb/migrations_test.go b/tapdb/migrations_test.go
@@ -1401,19 +1401,19 @@ func TestSequenceConsistency(t *testing.T) {
 	}
 }
 
-// TestMigration62BackfillSupplyUpdateEventKeys verifies that the
-// programmatic migration at version 62 fills the event_key column for
+// TestMigration63BackfillSupplyUpdateEventKeys verifies that the
+// programmatic migration at version 63 fills the event_key column for
 // every supply_update_events row created before the column existed.
-// Migration 61 added the column nullable; rows inserted at version 61
+// Migration 62 added the column nullable; rows inserted at version 62
 // (or earlier) have event_key=NULL, and the dedup invariant only kicks
 // in once the backfill has run.
-func TestMigration62BackfillSupplyUpdateEventKeys(t *testing.T) {
+func TestMigration63BackfillSupplyUpdateEventKeys(t *testing.T) {
 	ctx := context.Background()
 
-	// Start at version 61: the event_key column exists, the unique
+	// Start at version 62: the event_key column exists, the unique
 	// index exists (and tolerates multiple NULLs), but no rows have
 	// been hashed yet.
-	db := NewTestDBWithVersion(t, 61)
+	db := NewTestDBWithVersion(t, 62)
 
 	// Insert three rows with NULL event_key. update_type_id values
 	// match the rows seeded by migration 40 (0=mint, 1=burn,
@@ -1436,7 +1436,7 @@ func TestMigration62BackfillSupplyUpdateEventKeys(t *testing.T) {
 
 	for _, s := range seeds {
 		// EventKey is intentionally nil so the row mimics what a
-		// legacy database holds before migration 62's backfill.
+		// legacy database holds before migration 63's backfill.
 		_, err := db.InsertSupplyUpdateEvent(
 			ctx, sqlc.InsertSupplyUpdateEventParams{
 				GroupKey:     groupKey,
@@ -1465,7 +1465,7 @@ func TestMigration62BackfillSupplyUpdateEventKeys(t *testing.T) {
 	}
 	require.NoError(t, preRows.Close())
 
-	// Advance to latest -- the programmatic migration at 62 runs the
+	// Advance to latest -- the programmatic migration at 63 runs the
 	// backfill.
 	err = db.ExecuteMigrations(TargetLatest, WithProgrammaticMigrations(
 		makeProgrammaticMigrations(db, programmaticMigrations, true),
@@ -1498,15 +1498,15 @@ func TestMigration62BackfillSupplyUpdateEventKeys(t *testing.T) {
 	require.Equal(t, len(seeds), seen)
 }
 
-// TestMigration62BackfillDedupesLegacyDuplicates simulates the legacy
+// TestMigration63BackfillDedupesLegacyDuplicates simulates the legacy
 // failure mode this PR closes: pre-migration databases could contain
 // multiple supply_update_events rows with identical content. The
-// migration 62 backfill must drop the duplicates rather than fail on
-// the unique index added in migration 61.
-func TestMigration62BackfillDedupesLegacyDuplicates(t *testing.T) {
+// migration 63 backfill must drop the duplicates rather than fail on
+// the unique index added in migration 62.
+func TestMigration63BackfillDedupesLegacyDuplicates(t *testing.T) {
 	ctx := context.Background()
 
-	db := NewTestDBWithVersion(t, 61)
+	db := NewTestDBWithVersion(t, 62)
 
 	groupKey := bytes.Repeat([]byte{0x42}, 32)
 	payload := []byte("event-payload-duplicate")
@@ -1533,7 +1533,7 @@ func TestMigration62BackfillDedupesLegacyDuplicates(t *testing.T) {
 	`).Scan(&preCount))
 	require.Equal(t, 3, preCount)
 
-	// Run the backfill. The unique index added in migration 61
+	// Run the backfill. The unique index added in migration 62
 	// would reject the naive UPDATE for the second and third
 	// rows; the backfill must dedupe before writing.
 	err := db.ExecuteMigrations(TargetLatest, WithProgrammaticMigrations(
diff --git a/tapdb/programmatic_migrations.go b/tapdb/programmatic_migrations.go
@@ -28,12 +28,12 @@ const (
 	// witnesses.
 	Migration51InsertAssetBurns = 51
 
-	// Migration62BackfillEventKeys is the version of the
+	// Migration63BackfillEventKeys is the version of the
 	// programmatic migration that computes the dedup content-hash for
 	// every supply_update_events row that pre-dates the event_key
 	// column. SQLite has no native SHA-256, so the work cannot be
 	// expressed as portable SQL.
-	Migration62BackfillEventKeys = 62
+	Migration63BackfillEventKeys = 63
 )
 
 // programmaticMigration is a function type for a function that performs a
@@ -48,7 +48,7 @@ var (
 	programmaticMigrations = map[uint]programmaticMigration{
 		Migration50ScriptKeyType:     determineAndAssignScriptKeyType,
 		Migration51InsertAssetBurns:  insertAssetBurns,
-		Migration62BackfillEventKeys: backfillSupplyUpdateEventKeys,
+		Migration63BackfillEventKeys: backfillSupplyUpdateEventKeys,
 	}
 )
 
@@ -339,15 +339,15 @@ func insertAssetBurns(ctx context.Context, q sqlc.Querier) error {
 
 // backfillSupplyUpdateEventKeys computes a content-hash for every
 // supply_update_events row that pre-dates the event_key column (added
-// in migration 000061) and stores it in the new column. After this
+// in migration 000062) and stores it in the new column. After this
 // migration runs every row holds a hash, and the unique index on
 // event_key enforces the no-duplicates invariant for new inserts.
 //
 // Legacy databases may already contain duplicate rows (the bug this
 // PR fixes -- restart re-fires of the same logical event). Two rows
 // with identical content hash to the same key, so the second
 // SetSupplyUpdateEventKey would violate the unique index added in
-// migration 000061. We dedupe in-memory by tracking the hashes we've
+// migration 000062. We dedupe in-memory by tracking the hashes we've
 // already assigned and dropping any row whose hash we've seen.
 func backfillSupplyUpdateEventKeys(ctx context.Context,
 	q sqlc.Querier) error {
@@ -371,7 +371,7 @@ func backfillSupplyUpdateEventKeys(ctx context.Context,
 			// A prior row in this loop already claimed this
 			// hash, so the current row is a duplicate of an
 			// earlier logical event. Drop it; the unique
-			// index in migration 000061 would otherwise
+			// index in migration 000062 would otherwise
 			// reject the UPDATE below.
 			log.Debugf("Dropping duplicate supply update "+
 				"event %d during backfill", row.EventID)
diff --git a/tapdb/sqlc/migrations/000061_unique_pending_or_frozen_batch.down.sql b/tapdb/sqlc/migrations/000061_unique_pending_or_frozen_batch.down.sql
diff --git a/tapdb/sqlc/migrations/000061_unique_pending_or_frozen_batch.up.sql b/tapdb/sqlc/migrations/000061_unique_pending_or_frozen_batch.up.sql
diff --git a/tapdb/sqlc/migrations/000062_backfill_supply_update_event_keys.down.sql b/tapdb/sqlc/migrations/000062_backfill_supply_update_event_keys.down.sql
diff --git a/tapdb/sqlc/migrations/000062_dedupe_supply_update_events.down.sql b/tapdb/sqlc/migrations/000062_dedupe_supply_update_events.down.sql
diff --git a/tapdb/sqlc/migrations/000062_dedupe_supply_update_events.up.sql b/tapdb/sqlc/migrations/000062_dedupe_supply_update_events.up.sql
@@ -6,7 +6,7 @@
 -- BTREE indexed-tuple size limit.
 --
 -- The column is nullable in this migration so it applies cleanly to
--- existing DBs. Migration 000062 backfills the rows that pre-date
+-- existing DBs. Migration 000063 backfills the rows that pre-date
 -- this column (SQLite has no native SHA-256 so the backfill is a
 -- programmatic step). New inserts must always provide a value.
 ALTER TABLE supply_update_events
@@ -16,7 +16,7 @@ ALTER TABLE supply_update_events
 -- The unique index covers all rows, but SQLite and Postgres both
 -- treat NULL as distinct from every other NULL in a UNIQUE index,
 -- so pre-backfill rows do not collide with one another. After
--- migration 000062 every row holds a hash and the index enforces
+-- migration 000063 every row holds a hash and the index enforces
 -- dedup across the whole table.
 CREATE UNIQUE INDEX IF NOT EXISTS supply_update_events_event_key_idx
     ON supply_update_events(event_key);
diff --git a/tapdb/sqlc/migrations/000063_backfill_supply_update_event_keys.down.sql b/tapdb/sqlc/migrations/000063_backfill_supply_update_event_keys.down.sql
@@ -0,0 +1,3 @@
+-- The backfill cannot be cleanly undone in isolation -- the column
+-- itself is dropped by the 000062 down-migration. This file exists
+-- only so the migration runner can step back through version 62.
diff --git a/tapdb/sqlc/migrations/000063_backfill_supply_update_event_keys.up.sql b/tapdb/sqlc/migrations/000063_backfill_supply_update_event_keys.up.sql
diff --git a/tapdb/sqlc/querier.go b/tapdb/sqlc/querier.go
diff --git a/tapdb/sqlc/queries/supply_commit.sql b/tapdb/sqlc/queries/supply_commit.sql
@@ -89,15 +89,15 @@ ON CONFLICT (event_key) DO NOTHING;
 -- name: FetchSupplyUpdateEventsForBackfill :many
 -- Returns rows that pre-date the event_key column and still need
 -- a hash computed. Used by the programmatic migration that runs
--- at schema version 61.
+-- at schema version 62.
 SELECT event_id, group_key, update_type_id, event_data
 FROM supply_update_events
 WHERE event_key IS NULL;
 
 -- name: SetSupplyUpdateEventKey :exec
 -- Sets the content-hash key for a single supply update event row.
 -- Used by the programmatic migration that backfills pre-existing
--- rows after column 000061 is added.
+-- rows after column 000062 is added.
 UPDATE supply_update_events
 SET event_key = @event_key
 WHERE event_id = @event_id;
@@ -235,7 +235,7 @@ WHERE transition_id = @transition_id;
 
 -- name: DeleteSupplyUpdateEvent :exec
 -- Deletes a single supply update event row identified by its
--- event_id. Used by the migration 62 backfill to drop duplicate
+-- event_id. Used by the migration 63 backfill to drop duplicate
 -- rows that hash to the same event_key as an earlier row.
 DELETE FROM supply_update_events
 WHERE event_id = @event_id;
diff --git a/tapdb/sqlc/supply_commit.sql.go b/tapdb/sqlc/supply_commit.sql.go
diff --git a/tapdb/supply_commit_test.go b/tapdb/supply_commit_test.go
@@ -151,7 +151,7 @@ func (h *supplyCommitTestHarness) addTestMintingBatch() ([]byte, int64,
 	// NewMintingBatch hardcodes state=BatchStatePending. These
 	// supply-commit tests need to create multiple batches as
 	// fixtures, which would violate the singleton invariant added
-	// in migration 000060 (≤ 1 batch in {Pending, Frozen}).
+	// in migration 000061 (≤ 1 batch in {Pending, Frozen}).
 	// Immediately advance to a terminal state so each fixture is
 	// outside the constrained set; the tests do not exercise the
 	// planter state machine, only the supply-commit logic, so the
diff --git a/tapgarden/interface.go b/tapgarden/interface.go
@@ -178,7 +178,7 @@ type BatchStore interface {
 	//
 	// The "exactly one batch in BatchStatePending or BatchStateFrozen
 	// at a time" invariant the planter relies on is enforced at the
-	// DB layer by migration 000060 (a partial unique index on
+	// DB layer by migration 000061 (a partial unique index on
 	// asset_minting_batches). Callers may assume that any successful
 	// CommitMintingBatch left the singleton slot occupied by exactly
 	// the batch they just committed.
diff --git a/tapgarden/planter.go b/tapgarden/planter.go
@@ -495,7 +495,7 @@ func (c *ChainPlanter) Start() error {
 
 		// Enforce the singleton invariant: at most one batch may
 		// be in BatchStatePending or BatchStateFrozen at a time.
-		// The DB constraint added in migration 000060 should
+		// The DB constraint added in migration 000061 should
 		// already make this impossible, but a legacy DB that was
 		// migrated post-population, or a manually-modified row,
 		// could still violate it. Surfacing the error here gives
@@ -1235,7 +1235,7 @@ func freezeMintingBatch(ctx context.Context, batchStore BatchStore,
 // checkSingletonInvariant verifies that at most one batch in the
 // supplied slice is in a pre-broadcast state (BatchStatePending or
 // BatchStateFrozen). The invariant is enforced at the DB layer by
-// the partial unique index added in migration 000060; this Go-level
+// the partial unique index added in migration 000061; this Go-level
 // check exists as defense in depth and to produce a human-readable
 // diagnostic naming the offending batch keys, since a raw SQL
 // constraint error from a downstream insert is harder to act on.
@@ -1641,7 +1641,7 @@ func (c *ChainPlanter) canCancelBatch() (*btcec.PublicKey, error) {
 		// cultivator may be handling a post-broadcast batch
 		// (Committed/Broadcast/Confirmed) while a fresh
 		// Pending/Frozen batch has begun in c.pendingBatch. The
-		// singleton constraint added in migration 000060 only
+		// singleton constraint added in migration 000061 only
 		// applies to {Pending, Frozen}, so this case is real,
 		// not unreachable.
 		if c.pendingBatch != nil {
@@ -1663,7 +1663,7 @@ func (c *ChainPlanter) canCancelBatch() (*btcec.PublicKey, error) {
 
 	// Multiple cultivators can coexist when several post-broadcast
 	// batches are awaiting confirmation in parallel. The singleton
-	// constraint added in migration 000060 does not forbid this; it
+	// constraint added in migration 000061 does not forbid this; it
 	// only constrains {Pending, Frozen}.
 	return nil, fmt.Errorf("cancellation ambiguous: %d active "+
 		"cultivators; cancel-by-batch-key not implemented",
@@ -2646,7 +2646,7 @@ func (c *ChainPlanter) FinalizeBatch(params FinalizeParams) (*MintingBatch,
 				// Cancel the failed batch on disk so it does
 				// not stay wedged in a pre-broadcast state,
 				// where the singleton invariant added in
-				// migration 000060 would block any
+				// migration 000061 would block any
 				// subsequent batch from being created. We
 				// use the same cancel-state rule as
 				// cultivator.Cancel(): Pending or Frozen →
diff --git a/tapgarden/planter_test.go b/tapgarden/planter_test.go
@@ -1635,7 +1635,7 @@ func testFinalizeWithTapscriptTree(t *mintingTestHarness) {
 	// The caretaker should fail when computing the Taproot output key.
 	// The gardener cancels the failed batch on disk so it does not
 	// block subsequent pending batches via the singleton invariant
-	// added in migration 000060.
+	// added in migration 000061.
 	_ = t.assertGenesisTxFunded(nil)
 	t.assertFinalizeBatch(&wg, respChan, "failed to load tapscript tree")
 	t.assertLastBatchState(
@@ -2173,7 +2173,7 @@ func testFundSealOnRestart(t *mintingTestHarness) {
 	// The original test continued by inserting a second Pending
 	// batch directly on disk to exercise recovery when multiple
 	// pending batches were present. That scenario is now forbidden
-	// by the singleton invariant added in migration 000060, so the
+	// by the singleton invariant added in migration 000061, so the
 	// section has been removed. The single-pending-batch recovery
 	// paths exercised above are the surviving useful coverage; the
 	// "multiple pre-broadcast batches" case is covered by

Original file line number	Diff line number	Diff line change
`@@ -365,7 +365,7 @@ type ExperimentalConfig struct {`
`365`	`365`	`// for operator use after a constraint or invariant failure has`
`366`	`366`	`// prevented normal startup.`
`367`	`367`	`type RepairConfig struct {`
`368`		- CancelDuplicateBatches bool `long:"cancel-duplicate-batches" description:"If set, tapd cancels all but the most recent minting batch in BatchStatePending or BatchStateFrozen and then exits. Used to recover from a database that violates the singleton pre-broadcast batch invariant added in migration 000060 (e.g. a legacy DB with duplicate pending batches that blocks the migration)."`
	`368`	+ CancelDuplicateBatches bool `long:"cancel-duplicate-batches" description:"If set, tapd cancels all but the most recent minting batch in BatchStatePending or BatchStateFrozen and then exits. Used to recover from a database that violates the singleton pre-broadcast batch invariant added in migration 000061 (e.g. a legacy DB with duplicate pending batches that blocks the migration)."`
`369`	`369`	`}`
`370`	`370`
`371`	`371`	`// CleanAndValidate performs final processing on the ExperimentalConfig,`
Original file line number	Diff line number	Diff line change
`@@ -2157,7 +2157,7 @@ func TestUpdateBatchStateMemoryCoherence(t *testing.T) {`
`2157`	`2157`	`}`
`2158`	`2158`
`2159`	`2159`	`// TestSingletonPreBroadcastBatchConstraint exercises the partial`
`2160`		`-// unique index added in migration 000060. At most one`
	`2160`	`+// unique index added in migration 000061. At most one`
`2161`	`2161`	`// asset_minting_batches row may be in BatchStatePending or`
`2162`	`2162`	`// BatchStateFrozen at any time; the second insert into that set`
`2163`	`2163`	`// must fail with a constraint error, and a row in`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ const (`
`24`	`24`	`// daemon.`
`25`	`25`	`//`
`26`	`26`	`// NOTE: This MUST be updated when a new migration is added.`
`27`		`- LatestMigrationVersion = 62`
	`27`	`+ LatestMigrationVersion = 63`
`28`	`28`	`)`
`29`	`29`
`30`	`30`	`// DatabaseBackend is an interface that contains all methods our different`