staticaddr: migrate swap hashes to deposits

Author: hieblmi

go.mod

@@ -16,6 +16,7 @@ require (
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.20.0
 	github.com/jackc/pgconn v1.14.3
 	github.com/jackc/pgerrcode v0.0.0-20240316143900-6e2875d9b438
+	github.com/jackc/pgx/v5 v5.6.0
 	github.com/jessevdk/go-flags v1.4.0
 	github.com/lib/pq v1.10.9
 	github.com/lightninglabs/aperture v0.3.13-beta
@@ -104,7 +105,6 @@ require (
 	github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
 	github.com/jackc/pgtype v1.14.0 // indirect
 	github.com/jackc/pgx/v4 v4.18.2 // indirect
-	github.com/jackc/pgx/v5 v5.6.0 // indirect
 	github.com/jackc/puddle v1.3.0 // indirect
 	github.com/jackc/puddle/v2 v2.2.1 // indirect
 	github.com/jackpal/gateway v1.0.5 // indirect

loopd/daemon.go

@@ -626,6 +626,16 @@ func (d *Daemon) initialize(withMacaroonService bool) error {
 		clock.NewDefaultClock(), d.lnd.ChainParams,
 	)
 
+	// Run the deposit swap hash migration.
+	err = loopin.MigrateDepositSwapHash(
+		d.mainCtx, swapDb, depositStore, staticAddressLoopInStore,
+	)
+	if err != nil {
+		errorf("Deposit swap hash migration failed: %v", err)
+
+		return err
+	}
+
 	staticLoopInManager = loopin.NewManager(&loopin.Config{
 		Server:                               staticAddressClient,
 		QuoteGetter:                          swapClient.Server,

loopdb/sqlc/migrations/000017_deposit_swaphash.down.sql

@@ -0,0 +1 @@
+ALTER TABLE deposits DROP COLUMN swap_hash;

loopdb/sqlc/migrations/000017_deposit_swaphash.up.sql

@@ -0,0 +1 @@
+ALTER TABLE deposits ADD swap_hash BLOB;

loopdb/sqlc/models.go

@@ -93,3 +93,30 @@ SELECT EXISTS (
     FROM static_address_swaps
     WHERE swap_hash = $1
 );
+
+-- name: MapDepositToSwap :exec
+UPDATE
+    deposits
+SET
+    swap_hash = $2
+WHERE
+    deposit_id = $1;
+
+-- name: SwapHashForDepositID :one
+SELECT
+    swap_hash
+FROM
+    deposits
+WHERE
+    deposit_id = $1;
+
+-- name: DepositIDsForSwapHash :many
+SELECT
+    deposit_id
+FROM
+    deposits
+WHERE
+    swap_hash = $1;
+
+
+

loopdb/sqlc/querier.go

@@ -0,0 +1,88 @@
+package loopin
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/lightninglabs/loop/loopdb"
+	"github.com/lightninglabs/loop/staticaddr/deposit"
+	"github.com/lightningnetwork/lnd/lntypes"
+)
+
+const (
+	// depositSwapHashMigrationID is the identifier for the deposit swap
+	// hash migration.
+	depositSwapHashMigrationID = "deposit_swap_hash"
+)
+
+// MigrateDepositSwapHash will retrieve the comma separated deposit list of
+// past and pending swaps and map them to the swap hash in the deposits table.
+func MigrateDepositSwapHash(ctx context.Context, db loopdb.SwapStore,
+	depositStore *deposit.SqlStore, swapStore *SqlStore) error {
+
+	migrationDone, err := db.HasMigration(
+		ctx, depositSwapHashMigrationID,
+	)
+	if err != nil {
+		return fmt.Errorf("unable to check migration status: %w", err)
+	}
+	if migrationDone {
+		log.Infof("Deposit swap hash migration already done, " +
+			"skipping")
+
+		return nil
+	}
+
+	log.Infof("Starting deposit swap hash migration")
+	startTs := time.Now()
+	defer func() {
+		log.Infof("Finished deposit swap hash migration in %v",
+			time.Since(startTs))
+	}()
+
+	// First we'll fetch all past loop in swaps from the database.
+	swaps, err := swapStore.GetStaticAddressLoopInSwapsByStates(
+		ctx, AllStates,
+	)
+	if err != nil {
+		return err
+	}
+
+	// Now we'll map each deposit of a swap to its respective swap hash.
+	depositsToSwapHashes := make(map[deposit.ID]lntypes.Hash)
+	for _, swap := range swaps {
+		for _, outpoint := range swap.DepositOutpoints {
+			deposit, err := depositStore.DepositForOutpoint(
+				ctx, outpoint,
+			)
+			if err != nil {
+				return fmt.Errorf("unable to fetch deposit "+
+					"for outpoint %s: %w", outpoint, err)
+			}
+			if deposit == nil {
+				return fmt.Errorf("deposit for outpoint %s "+
+					"not found", outpoint)
+			}
+
+			if _, ok := depositsToSwapHashes[deposit.ID]; !ok {
+				depositsToSwapHashes[deposit.ID] = swap.SwapHash
+			} else {
+				log.Warnf("Duplicate deposit ID %s found for "+
+					"outpoint %s, skipping",
+					deposit.ID, outpoint)
+			}
+		}
+	}
+
+	log.Infof("Batch-mapping %d deposits to swap hashes",
+		len(depositsToSwapHashes))
+
+	err = swapStore.BatchMapDepositsToSwapHashes(ctx, depositsToSwapHashes)
+	if err != nil {
+		return err
+	}
+
+	// Finally mark the migration as done.
+	return db.SetMigration(ctx, depositSwapHashMigrationID)
+}