(to squash) make IsPresigned a field of SweepInfo

Author: starius

sweepbatcher/sweep_batcher.go

@@ -132,6 +132,11 @@ type SweepInfo struct {
 	// has to be spent using preimage. This is only used in fee estimations
 	// when selecting a batch for the sweep to minimize fees.
 	NonCoopHint bool
+
+	// IsPresigned stores if presigned mode is enabled for the sweep. This
+	// value should be stable for a sweep. Currently presigned and
+	// non-presigned sweeps never appear in the same batch.
+	IsPresigned bool
 }
 
 // SweepFetcher is used to get details of a sweep.
@@ -164,12 +169,6 @@ type SignMuSig2 func(ctx context.Context, muSig2Version input.MuSig2Version,
 // fails (e.g. because one of the inputs is offline), an input can't be added to
 // a batch.
 type PresignedHelper interface {
-	// IsPresigned returns if presigned mode is enabled for a particular
-	// sweep. This method should always return the same value for the same
-	// sweep. Currently presigned and non-presigned sweeps never appear in
-	// the same batch.
-	IsPresigned(ctx context.Context, input wire.OutPoint) (bool, error)
-
 	// Presign tries to presign a batch transaction. If the method returns
 	// nil, it is guaranteed that future calls to SignTx on this set of
 	// sweeps return valid signed transactions. The implementation should
@@ -1325,16 +1324,6 @@ func (b *Batcher) loadSweep(ctx context.Context, swapHash lntypes.Hash,
 			swapHash[:6], err)
 	}
 
-	// Determine if presigned mode is used for this sweep.
-	var presigned bool
-	if b.presignedHelper != nil {
-		presigned, err = b.presignedHelper.IsPresigned(ctx, outpoint)
-		if err != nil {
-			return nil, fmt.Errorf("failed to determine presigned "+
-				"status for sweep %x: %w", swapHash[:6], err)
-		}
-	}
-
 	// Find minimum fee rate for the sweep. Use customFeeRate if it is
 	// provided, otherwise use wallet's EstimateFeeRate.
 	var minFeeRate chainfee.SatPerKWeight
@@ -1378,7 +1367,7 @@ func (b *Batcher) loadSweep(ctx context.Context, swapHash lntypes.Hash,
 		destAddr:               s.DestAddr,
 		minFeeRate:             minFeeRate,
 		nonCoopHint:            s.NonCoopHint,
-		presigned:              presigned,
+		presigned:              s.IsPresigned,
 	}, nil
 }
 

sweepbatcher/sweep_batcher_presigned_test.go

@@ -95,19 +95,6 @@ func (h *mockPresignedHelper) getTxFeerate(tx *wire.MsgTx,
 	return chainfee.NewSatPerKWeight(fee, weight)
 }
 
-// IsPresigned returns if the input was previously used in any call to the
-// SetOutpointOnline method.
-func (h *mockPresignedHelper) IsPresigned(ctx context.Context,
-	input wire.OutPoint) (bool, error) {
-
-	h.mu.Lock()
-	defer h.mu.Unlock()
-
-	_, has := h.onlineOutpoints[input]
-
-	return has, nil
-}
-
 // Presign tries to presign the transaction. It succeeds if all the inputs
 // are online. In case of success it adds the transaction to presignedBatches.
 func (h *mockPresignedHelper) Presign(ctx context.Context,
@@ -237,18 +224,21 @@ func (h *mockPresignedHelper) CleanupTransactions(ctx context.Context,
 // sweepTimeout is swap timeout block height used in tests of presigned mode.
 const sweepTimeout = 1000
 
-// dummySweepFetcherMock implements SweepFetcher by returning blank SweepInfo.
-// It is used in TestPresigned, because it doesn't use any fields of SweepInfo.
-type dummySweepFetcherMock struct {
-}
-
 // FetchSweep returns blank SweepInfo.
-func (f *dummySweepFetcherMock) FetchSweep(_ context.Context,
-	_ lntypes.Hash, _ wire.OutPoint) (*SweepInfo, error) {
+// This method implements SweepFetcher interface.
+func (h *mockPresignedHelper) FetchSweep(_ context.Context,
+	_ lntypes.Hash, utxo wire.OutPoint) (*SweepInfo, error) {
+
+	h.mu.Lock()
+	defer h.mu.Unlock()
+
+	_, has := h.onlineOutpoints[utxo]
 
 	return &SweepInfo{
 		// Set Timeout to prevent warning messages about timeout=0.
 		Timeout: sweepTimeout,
+
+		IsPresigned: has,
 	}, nil
 }
 
@@ -274,7 +264,7 @@ func testPresigned_forgotten_presign(t *testing.T,
 
 	batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper))
 
@@ -350,7 +340,7 @@ func testPresigned_input1_offline_then_input2(t *testing.T,
 
 	batcher := NewBatcher(lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper))
 	go func() {
@@ -532,7 +522,7 @@ func testPresigned_two_inputs_one_goes_offline(t *testing.T,
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)
@@ -668,7 +658,7 @@ func testPresigned_first_publish_fails(t *testing.T,
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)
@@ -791,7 +781,7 @@ func testPresigned_locktime(t *testing.T,
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)
@@ -875,7 +865,7 @@ func testPresigned_presigned_group(t *testing.T,
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)
@@ -1052,6 +1042,30 @@ func testPresigned_presigned_group(t *testing.T,
 	require.Equal(t, batchPkScript, tx.TxOut[0].PkScript)
 }
 
+// wrappedStoreWithPresignedFlag wraps a SweepFetcher store adding IsPresigned
+// flag to the returned sweeps, taking it from mockPresignedHelper.
+type wrappedStoreWithPresignedFlag struct {
+	backend SweepFetcher
+	helper  *mockPresignedHelper
+}
+
+// // FetchSweep returns details of the sweep.
+func (s *wrappedStoreWithPresignedFlag) FetchSweep(ctx context.Context,
+	swap lntypes.Hash, utxo wire.OutPoint) (*SweepInfo, error) {
+
+	sweepInfo, err := s.backend.FetchSweep(ctx, swap, utxo)
+	if err != nil {
+		return nil, err
+	}
+
+	// Attach IsPresigned flag.
+	s.helper.mu.Lock()
+	defer s.helper.mu.Unlock()
+	_, sweepInfo.IsPresigned = s.helper.onlineOutpoints[utxo]
+
+	return sweepInfo, nil
+}
+
 // testPresigned_presigned_and_regular_sweeps tests a combination of presigned
 // mode and regular mode for the following scenario: one regular input is added,
 // then a presigned input is added and it goes to another batch, because they
@@ -1088,10 +1102,15 @@ func testPresigned_presigned_and_regular_sweeps(t *testing.T, store testStore,
 	sweepStore, err := NewSweepFetcherFromSwapStore(store, lnd.ChainParams)
 	require.NoError(t, err)
 
+	sweepFetcher := &wrappedStoreWithPresignedFlag{
+		backend: sweepStore,
+		helper:  presignedHelper,
+	}
+
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, sweepStore,
+		batcherStore, sweepFetcher,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)
@@ -1359,7 +1378,7 @@ func testPresigned_purging(t *testing.T, numSwaps, numConfirmedSwaps int,
 	batcher := NewBatcher(
 		lnd.WalletKit, lnd.ChainNotifier, lnd.Signer,
 		testMuSig2SignSweep, testVerifySchnorrSig, lnd.ChainParams,
-		batcherStore, &dummySweepFetcherMock{},
+		batcherStore, presignedHelper,
 		WithCustomFeeRate(customFeeRate),
 		WithPresignedHelper(presignedHelper),
 	)