sweepbatcher: add option WithPublishDelay

WithPublishDelay sets the delay of batch publishing that is applied in the
beginning, after the appearance of a new block in the network or after the
end of initial delay (see WithInitialDelay). It is needed to prevent
unnecessary transaction publishments when a spend is detected on that block.
Default value depends on the network: 5 seconds in mainnet, 0.5s in testnet.
For batches recovered from DB this value is always 0s.

Author: starius

sweepbatcher/sweep_batcher.go

@@ -265,6 +265,12 @@ type Batcher struct {
 	// skipped.
 	initialDelay time.Duration
 
+	// publishDelay is the delay of batch publishing that is applied in the
+	// beginning, after the appearance of a new block in the network or
+	// after the end of initial delay. For batches recovered from DB this
+	// value is always 0s, regardless of this setting.
+	publishDelay time.Duration
+
 	// customFeeRate provides custom min fee rate per swap. The batch uses
 	// max of the fee rates of its swaps. In this mode confTarget is
 	// ignored and fee bumping by sweepbatcher is disabled.
@@ -290,6 +296,12 @@ type BatcherConfig struct {
 	// skipped.
 	initialDelay time.Duration
 
+	// publishDelay is the delay of batch publishing that is applied in the
+	// beginning, after the appearance of a new block in the network or
+	// after the end of initial delay. For batches recovered from DB this
+	// value is always 0s, regardless of this setting.
+	publishDelay time.Duration
+
 	// customFeeRate provides custom min fee rate per swap. The batch uses
 	// max of the fee rates of its swaps. In this mode confTarget is
 	// ignored and fee bumping by sweepbatcher is disabled.
@@ -324,6 +336,18 @@ func WithInitialDelay(initialDelay time.Duration) BatcherOption {
 	}
 }
 
+// WithPublishDelay sets the delay of batch publishing that is applied in the
+// beginning, after the appearance of a new block in the network or after the
+// end of initial delay (see WithInitialDelay). It is needed to prevent
+// unnecessary transaction publishments when a spend is detected on that block.
+// Default value depends on the network: 5 seconds in mainnet, 0.5s in testnet.
+// For batches recovered from DB this value is always 0s.
+func WithPublishDelay(publishDelay time.Duration) BatcherOption {
+	return func(cfg *BatcherConfig) {
+		cfg.publishDelay = publishDelay
+	}
+}
+
 // WithCustomFeeRate instructs sweepbatcher not to fee bump itself and rely on
 // external source of fee rates (FeeRateProvider). To apply a fee rate change,
 // the caller should re-add the sweep by calling AddSweep.
@@ -383,6 +407,7 @@ func NewBatcher(wallet lndclient.WalletKitClient,
 		sweepStore:         sweepStore,
 		clock:              cfg.clock,
 		initialDelay:       cfg.initialDelay,
+		publishDelay:       cfg.publishDelay,
 		customFeeRate:      cfg.customFeeRate,
 		customMuSig2Signer: cfg.customMuSig2Signer,
 	}
@@ -588,6 +613,14 @@ func (b *Batcher) spinUpBatch(ctx context.Context) (*batch, error) {
 		cfg.batchPublishDelay = defaultTestnetPublishDelay
 	}
 
+	if b.publishDelay != 0 {
+		if b.publishDelay < 0 {
+			return nil, fmt.Errorf("negative publishDelay: %v",
+				b.publishDelay)
+		}
+		cfg.batchPublishDelay = b.publishDelay
+	}
+
 	if b.initialDelay < 0 {
 		return nil, fmt.Errorf("negative initialDelay: %v",
 			b.initialDelay)