tapcfg+tapfreighter: configure sweeping with wallet flag

Author: darioAnongba

config.go

@@ -190,6 +190,10 @@ type Config struct {
 
 	ChainPorter tapfreighter.Porter
 
+	// SweepOrphanUtxos toggles sweeping orphaned UTXOs into anchor
+	// transactions for sends and burns.
+	SweepOrphanUtxos bool
+
 	// FsmDaemonAdapters is a set of adapters that allow a state machine to
 	// interact with external daemons.
 	FsmDaemonAdapters *lndservices.LndFsmDaemonAdapters

docs/release-notes/release-notes-0.8.0.md

@@ -37,10 +37,11 @@
 
 ## Functional Updates
 
-- [Garbage collection of zero-value UTXOs](https://github.com/lightninglabs/taproot-assets/pull/1832)
+- [Garbage collection of orphaned UTXOs](https://github.com/lightninglabs/taproot-assets/pull/1832)
   by sweeping tombstones and burn outputs when executing onchain transactions.
   Garbage collection will be executed on every burn, transfer or call to
-  `AnchorVirtualPsbts`.
+  `AnchorVirtualPsbts`. A new configuration is available to control the sweeping 
+  via the flag `wallet.sweep-orphan-utxos`.
 
 ## RPC Updates
 

itest/assertions.go

@@ -1276,10 +1276,6 @@ func AssertAssetOutboundTransferWithOutputs(t *testing.T,
 		scripts[string(o.ScriptKey)] = struct{}{}
 	}
 
-	sendRespJSON, err := formatProtoJSON(transfer)
-	require.NoError(t, err)
-	t.Logf("Got response from sending assets: %v", sendRespJSON)
-
 	// Mine a block to force the send event to complete (confirm on-chain).
 	var newBlock *wire.MsgBlock
 	if confirm {
@@ -1325,16 +1321,6 @@ func AssertAssetOutboundTransferWithOutputs(t *testing.T,
 				return slices.Contains(actualInputAssetIDs, id)
 			})
 	}, defaultTimeout, wait.PollInterval)
-	require.NoError(t, err)
-
-	transferResp, err := sender.ListTransfers(
-		ctxb, &taprpc.ListTransfersRequest{},
-	)
-	require.NoError(t, err)
-
-	transferRespJSON, err := formatProtoJSON(transferResp)
-	require.NoError(t, err)
-	t.Logf("Got response from list transfers: %v", transferRespJSON)
 
 	return newBlock
 }
@@ -2410,7 +2396,7 @@ func AssertBalances(t *testing.T, client taprpc.TaprootAssetsClient,
 			actualBalance := balanceSum(resp, false)
 			if balance != actualBalance {
 				return fmt.Errorf("asset balance, wanted %d, "+
-					"got: %v", balance, toJSON(t, resp))
+					"got: %v", balance, actualBalance)
 			}
 
 			// If we query for grouped asset balances too, it means
@@ -2528,7 +2514,7 @@ func AssertBalances(t *testing.T, client taprpc.TaprootAssetsClient,
 		}
 		if balance != totalBalance {
 			return fmt.Errorf("ListAssets balance, wanted %d, "+
-				"got: %v", balance, toJSON(t, resp))
+				"got: %v", balance, totalBalance)
 		}
 
 		// The number of UTXOs means asset outputs in this case. We
@@ -2605,7 +2591,7 @@ func AssertBalances(t *testing.T, client taprpc.TaprootAssetsClient,
 
 		if balance != totalBalance {
 			return fmt.Errorf("ListUtxos balance, wanted %d, "+
-				"got: %v", balance, toJSON(t, resp))
+				"got: %v", balance, totalBalance)
 		}
 
 		if config.numAnchorUtxos > 0 {

itest/burn_test.go

@@ -246,11 +246,6 @@ func testBurnAssets(t *harnessTest) {
 		WithScriptKeyType(asset.ScriptKeyBurn),
 	)
 
-	_, err = t.tapd.ListAssets(ctxt, &taprpc.ListAssetRequest{
-		IncludeSpent: true,
-	})
-	require.NoError(t.t, err)
-
 	// Test case 4: Burn some units of a grouped asset. We start by making
 	// sure we still have the full balance before burning.
 	AssertBalanceByID(

itest/integration_test.go

@@ -120,6 +120,7 @@ func TestTaprootAssetsDaemon(t *testing.T) {
 			tapdHarness, uniHarness, proofCourier := setupHarnesses(
 				t1, ht, lndHarness, uniServerLndHarness,
 				testCase.proofCourierType,
+				testCase.tapdOptions...,
 			)
 
 			ht := ht.newHarnessTest(

itest/tapd_harness.go

@@ -145,6 +145,10 @@ type harnessOpts struct {
 	// verification should only occur for commitments submitted by peers,
 	// not via on-chain spend detection.
 	disableSupplyVerifierChainWatch bool
+
+	// sweepOrphanUtxos indicates whether orphaned anchor UTXOs should be
+	// swept into anchor transactions.
+	sweepOrphanUtxos bool
 }
 
 type harnessOption func(*harnessOpts)
@@ -256,6 +260,10 @@ func newTapdHarness(t *testing.T, ht *harnessTest, cfg tapdConfig,
 	// nolint: lll
 	tapCfg.Universe.DisableSupplyVerifierChainWatch = opts.disableSupplyVerifierChainWatch
 
+	// Pass through the sweep orphan UTXOs flag. If the option was not set,
+	// this will be false, which is the default.
+	tapCfg.Wallet.SweepOrphanUtxos = opts.sweepOrphanUtxos
+
 	switch {
 	case len(opts.oracleServerAddress) > 0:
 		tapCfg.Experimental.Rfq.PriceOracleAddress =

itest/test_harness.go

@@ -70,6 +70,7 @@ type testCase struct {
 	name             string
 	test             func(t *harnessTest)
 	proofCourierType proof.CourierType
+	tapdOptions      []Option
 }
 
 // harnessTest wraps a regular testing.T providing enhanced error detection
@@ -270,7 +271,7 @@ func (h *harnessTest) addFederationServer(host string, target *tapdHarness) {
 // to each other through an in-memory gRPC connection.
 func setupHarnesses(t *testing.T, ht *harnessTest,
 	lndHarness *lntest.HarnessTest, uniServerLndHarness *node.HarnessNode,
-	proofCourierType proof.CourierType) (*tapdHarness,
+	proofCourierType proof.CourierType, tapdOpts ...Option) (*tapdHarness,
 	*universeServerHarness, proof.CourierHarness) {
 
 	// Create a new universe server harness and start it.
@@ -306,10 +307,11 @@ func setupHarnesses(t *testing.T, ht *harnessTest,
 	alice := lndHarness.NewNodeWithCoins("Alice", nil)
 
 	// Create a tapd that uses Alice and connect it to the universe server.
+	tapdOptions := append(tapdOpts, func(params *tapdHarnessParams) {
+		params.proofCourier = proofCourier
+	})
 	tapdHarness := setupTapdHarness(
-		t, ht, alice, universeServer, func(params *tapdHarnessParams) {
-			params.proofCourier = proofCourier
-		},
+		t, ht, alice, universeServer, tapdOptions...,
 	)
 	return tapdHarness, universeServer, proofCourier
 }
@@ -372,6 +374,10 @@ type tapdHarnessParams struct {
 	// sendPriceHint indicates whether the tapd should send price hints from
 	// the local oracle to the counterparty when requesting a quote.
 	sendPriceHint bool
+
+	// sweepOrphanUtxos indicates whether orphaned UTXOs should be swept
+	// into anchor transactions.
+	sweepOrphanUtxos bool
 }
 
 // Option is a tapd harness option.
@@ -400,6 +406,14 @@ func WithSendPriceHint() Option {
 	}
 }
 
+// WithSweepOrphanUtxos enables sweeping zero-value anchor UTXOs for
+// the tapd harness created with this option.
+func WithSweepOrphanUtxos() Option {
+	return func(th *tapdHarnessParams) {
+		th.sweepOrphanUtxos = true
+	}
+}
+
 // setupTapdHarness creates a new tapd that connects to the given lnd node
 // and to the given universe server.
 func setupTapdHarness(t *testing.T, ht *harnessTest,
@@ -434,6 +448,7 @@ func setupTapdHarness(t *testing.T, ht *harnessTest,
 		ho.disableSyncCache = params.disableSyncCache
 		ho.oracleServerAddress = params.oracleServerAddress
 		ho.sendPriceHint = params.sendPriceHint
+		ho.sweepOrphanUtxos = params.sweepOrphanUtxos
 	}
 
 	tapdCfg := tapdConfig{

itest/test_list_on_test.go

@@ -104,6 +104,13 @@ var allTestCases = []*testCase{
 	{
 		name: "zero value anchor sweep",
 		test: testZeroValueAnchorSweep,
+		tapdOptions: []Option{
+			WithSweepOrphanUtxos(),
+		},
+	},
+	{
+		name: "zero value anchor accumulation",
+		test: testZeroValueAnchorAccumulation,
 	},
 	{
 		name: "restart receiver check balance",

itest/zero_value_anchor_test.go

@@ -113,7 +113,7 @@ func testZeroValueAnchorSweep(t *harnessTest) {
 			AssetId: genInfo3.AssetId,
 		},
 		AmountToBurn:     assetAmount,
-		ConfirmationText: "assets will be destroyed",
+		ConfirmationText: taprootassets.AssetBurnConfirmationText,
 	})
 	require.NoError(t.t, err)
 
@@ -290,7 +290,7 @@ func testZeroValueAnchorAccumulation(t *harnessTest) {
 	require.NoError(t.t, t.tapd.stop(false))
 
 	// Enable sweeping in the config.
-	t.tapd.clientCfg.Wallet.SweepZeroValueAnchorUtxos = true
+	t.tapd.clientCfg.Wallet.SweepOrphanUtxos = true
 
 	// Restart with the modified config.
 	require.NoError(t.t, t.tapd.start(false))

rpcserver.go

@@ -2671,11 +2671,18 @@ func (r *rpcServer) AnchorVirtualPsbts(ctx context.Context,
 			prevID.OutPoint.String())
 	}
 
-	// Fetch zero-value UTXOs that should be swept as additional inputs.
-	zeroValueInputs, err := r.cfg.AssetStore.FetchZeroValueAnchorUTXOs(ctx)
-	if err != nil {
-		return nil, fmt.Errorf("unable to fetch zero-value "+
-			"UTXOs: %w", err)
+	// Fetch zero-value UTXOs that should be swept as additional inputs if
+	// the feature is enabled.
+	var (
+		zeroValueInputs []*tapfreighter.ZeroValueInput
+		err             error
+	)
+	if r.cfg.SweepOrphanUtxos {
+		zeroValueInputs, err = r.cfg.AssetStore.FetchOrphanUTXOs(ctx)
+		if err != nil {
+			return nil, fmt.Errorf("unable to fetch zero-value "+
+				"UTXOs: %w", err)
+		}
 	}
 
 	resp, err := r.cfg.ChainPorter.RequestShipment(