sweepbatcher: add an option to ignore HTLC txids

Added option WithSkippedTxns, which has one historical problematic tx by default.
Sweeps originating from these transactions are omitted when reading from DB.

loopdb: add column sweep_batches.cancelled and replaced DropBatch with
CancelBatch. It is needed, because sweep.batch_id is a foreign key to batch.

Changed StoreMock.InsertSweepBatch not to reuse batch_id. This is needed by
the test, which checks that new batch has fresh ID.

Author: starius

client.go

@@ -12,6 +12,7 @@ import (
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcec/v2/schnorr"
 	"github.com/btcsuite/btcd/btcutil"
+	"github.com/btcsuite/btcd/chaincfg/chainhash"
 	"github.com/lightninglabs/aperture/l402"
 	"github.com/lightninglabs/lndclient"
 	"github.com/lightninglabs/loop/assets"
@@ -146,6 +147,10 @@ type ClientConfig struct {
 	// be attempted.
 	LoopOutMaxParts uint32
 
+	// SkippedTxns is the list of existing HTLC txids to skip when starting
+	// Loop. This should only be used if affected by the historical bug.
+	SkippedTxns []string
+
 	// TotalPaymentTimeout is the total amount of time until we time out
 	// off-chain payments (used in loop out).
 	TotalPaymentTimeout time.Duration
@@ -246,11 +251,7 @@ func NewClient(dbDir string, loopDB loopdb.SwapStore,
 		sweeper, loopDB, cfg.Lnd.ChainParams, getHeight,
 	)
 
-	batcher := sweepbatcher.NewBatcher(
-		cfg.Lnd.WalletKit, cfg.Lnd.ChainNotifier, cfg.Lnd.Signer,
-		swapServerClient.MultiMuSig2SignSweep, verifySchnorrSig,
-		cfg.Lnd.ChainParams, sweeperDb, sweepStore,
-
+	batcherOpts := []sweepbatcher.BatcherOption{
 		// Disable 100 sats/kw fee bump every block and retarget feerate
 		// every block according to the current mempool condition.
 		sweepbatcher.WithCustomFeeRate(
@@ -265,8 +266,29 @@ func NewClient(dbDir string, loopDB loopdb.SwapStore,
 		// delay time to sweepbatcher's handling. The delay used in
 		// loopout.go is repushDelay.
 		sweepbatcher.WithPublishDelay(
-			repushDelay+additionalDelay,
+			repushDelay + additionalDelay,
 		),
+	}
+
+	if len(cfg.SkippedTxns) != 0 {
+		skippedTxns := make(map[chainhash.Hash]struct{})
+		for _, txid := range cfg.SkippedTxns {
+			txid, err := chainhash.NewHashFromStr(txid)
+			if err != nil {
+				return nil, nil, fmt.Errorf("failed to parse "+
+					"txid to skip %v: %w", txid, err)
+			}
+			skippedTxns[*txid] = struct{}{}
+		}
+		batcherOpts = append(batcherOpts, sweepbatcher.WithSkippedTxns(
+			skippedTxns,
+		))
+	}
+
+	batcher := sweepbatcher.NewBatcher(
+		cfg.Lnd.WalletKit, cfg.Lnd.ChainNotifier, cfg.Lnd.Signer,
+		swapServerClient.MultiMuSig2SignSweep, verifySchnorrSig,
+		cfg.Lnd.ChainParams, sweeperDb, sweepStore, batcherOpts...,
 	)
 
 	executor = newExecutor(&executorConfig{

loopd/config.go

@@ -184,6 +184,8 @@ type Config struct {
 
 	LoopOutMaxParts uint32 `long:"loopoutmaxparts" description:"The maximum number of payment parts that may be used for a loop out swap."`
 
+	SkippedTxns []string `long:"skippedtxns" description:"The list of existing HTLC txids to skip when starting Loop. This should only be used if affected by the historical bug." hidden:"true"`
+
 	TotalPaymentTimeout time.Duration `long:"totalpaymenttimeout" description:"The timeout to use for off-chain payments."`
 	MaxPaymentRetries   int           `long:"maxpaymentretries" description:"The maximum number of times an off-chain payment may be retried."`
 

loopd/utils.go

@@ -50,6 +50,7 @@ func getClient(cfg *Config, swapDb loopdb.SwapStore,
 		MaxL402Cost:                          btcutil.Amount(cfg.MaxL402Cost),
 		MaxL402Fee:                           btcutil.Amount(cfg.MaxL402Fee),
 		LoopOutMaxParts:                      cfg.LoopOutMaxParts,
+		SkippedTxns:                          cfg.SkippedTxns,
 		TotalPaymentTimeout:                  cfg.TotalPaymentTimeout,
 		MaxPaymentRetries:                    cfg.MaxPaymentRetries,
 		MaxStaticAddrHtlcFeePercentage:       cfg.MaxStaticAddrHtlcFeePercentage,

loopdb/sqlc/batch.sql.go

@@ -0,0 +1 @@
+ALTER TABLE sweep_batches DROP COLUMN cancelled;

loopdb/sqlc/migrations/000016_batch_cancelled.down.sql

@@ -0,0 +1 @@
+ALTER TABLE sweep_batches ADD COLUMN cancelled BOOLEAN NOT NULL DEFAULT FALSE;

loopdb/sqlc/migrations/000016_batch_cancelled.up.sql

@@ -4,7 +4,7 @@ SELECT
 FROM
         sweep_batches
 WHERE
-        confirmed = FALSE;
+        confirmed = FALSE AND cancelled = FALSE;
 
 -- name: InsertBatch :one
 INSERT INTO sweep_batches (
@@ -23,8 +23,10 @@ INSERT INTO sweep_batches (
         $6
 ) RETURNING id;
 
--- name: DropBatch :exec
-DELETE FROM sweep_batches WHERE id = $1;
+-- name: CancelBatch :exec
+UPDATE sweep_batches SET
+        cancelled = TRUE
+WHERE id = $1;
 
 -- name: UpdateBatch :exec
 UPDATE sweep_batches SET

loopdb/sqlc/models.go

@@ -126,6 +126,8 @@ func (b *batch) getOrderedSweeps(ctx context.Context) ([]sweep, error) {
 		return nil, fmt.Errorf("FetchBatchSweeps(%d) failed: %w", b.id,
 			err)
 	}
+	dbSweeps = filterDbSweeps(b.cfg.skippedTxns, dbSweeps)
+
 	if len(dbSweeps) != len(utxo2sweep) {
 		return nil, fmt.Errorf("FetchBatchSweeps(%d) returned %d "+
 			"sweeps, len(b.sweeps) is %d", b.id, len(dbSweeps),