Merge branch 'itest/logdir' into feat/zero-value-utxo-selection

Author: darioAnongba

docs/release-notes/release-notes-0.7.0.md

@@ -179,6 +179,9 @@
   configured with public read access. This matches the behavior of the  
   existing FetchSupplyCommit RPC endpoint.
 
+- The [`ListUtxos` RPC now returns a `Swept` field](https://github.com/lightninglabs/taproot-assets/pull/1832)
+  indicating whether the output is spent.
+
 ## tapcli Additions
 
 - [Rename](https://github.com/lightninglabs/taproot-assets/pull/1682) the mint
@@ -230,6 +233,9 @@
 - Enable [burning the full amount of an asset](https://github.com/lightninglabs/taproot-assets/pull/1791)
   when it is the sole one anchored to a Bitcoin UTXO.
 
+- [Garbage collection of zero-value UTXOs](https://github.com/lightninglabs/taproot-assets/pull/1832)
+  by sweeping tombstones and burn outputs when executing onchain transactions.
+
 ## RPC Updates
 
 ## tapcli Updates

itest/zero_value_anchor_test.go

@@ -8,17 +8,16 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-// testZeroValueAnchorSweep tests that zero-value anchor outputs (tombstones)
+// testZeroValueAnchorSweep tests that zero-value anchor outputs
 // are automatically swept when creating new on-chain transactions.
 func testZeroValueAnchorSweep(t *harnessTest) {
 	ctxb := context.Background()
 
-	// First, mint some simple assets.
+	// First, mint some simple asset.
 	rpcAssets := MintAssetsConfirmBatch(
 		t.t, t.lndHarness.Miner().Client, t.tapd,
 		[]*mintrpc.MintAssetRequest{simpleAssets[0]},
 	)
-
 	genInfo := rpcAssets[0].AssetGenesis
 	assetAmount := simpleAssets[0].Asset.Amount
 
@@ -29,88 +28,194 @@ func testZeroValueAnchorSweep(t *harnessTest) {
 		require.NoError(t.t, secondTapd.stop(!*noDelete))
 	}()
 
-	// Create an address for Bob to receive ALL assets (full value send).
-	// This should create a tombstone output on Alice's side.
 	bobAddr, err := secondTapd.NewAddr(ctxb, &taprpc.NewAddrRequest{
 		AssetId:      genInfo.AssetId,
-		Amt:          assetAmount, // Send ALL
+		Amt:          assetAmount,
 		AssetVersion: rpcAssets[0].Version,
 	})
 	require.NoError(t.t, err)
 
-	// Send ALL assets to Bob, which should create a tombstone output.
+	// Send ALL assets to Bob, which should create a tombstone.
 	sendResp, _ := sendAssetsToAddr(t, t.tapd, bobAddr)
 
-	// Confirm the send and wait for completion.
 	ConfirmAndAssertOutboundTransfer(
 		t.t, t.lndHarness.Miner().Client, t.tapd, sendResp,
 		genInfo.AssetId,
 		[]uint64{0, assetAmount}, 0, 1,
 	)
 	AssertNonInteractiveRecvComplete(t.t, secondTapd, 1)
 
-	// At this point, Alice should have a tombstone UTXO.
-	// Check Alice's UTXOs to see if there are any without assets (tombstones).
-	aliceUtxos, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{})
+	// Check Alice's UTXOs for tombstone script keys.
+	utxos, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{
+		ScriptKeyType: &taprpc.ScriptKeyTypeQuery{
+			Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+				ExplicitType: taprpc.
+					ScriptKeyType_SCRIPT_KEY_TOMBSTONE,
+			},
+		},
+	})
 	require.NoError(t.t, err)
+	require.Len(t.t, utxos.ManagedUtxos, 1)
 
-	tombstoneCount := 0
-	for _, utxo := range aliceUtxos.ManagedUtxos {
-		if len(utxo.Assets) == 0 {
-			tombstoneCount++
-			t.t.Logf("Found tombstone UTXO: %s, value=%d",
-				utxo.OutPoint, utxo.AmtSat)
+	tombstoneOp := ""
+	for outpoint, utxo := range utxos.ManagedUtxos {
+		if !utxo.Swept {
+			tombstoneOp = outpoint
+			break
 		}
 	}
 
-	t.t.Logf("Alice has %d tombstone UTXOs before sweep", tombstoneCount)
-	require.Greater(t.t, tombstoneCount, 0, "Should have at least one tombstone UTXO")
-
-	// Now mint more assets for Alice so she can create another transaction
-	// that should sweep the tombstones.
+	// Test 1: Send transaction sweeps tombstones.
 	rpcAssets2 := MintAssetsConfirmBatch(
 		t.t, t.lndHarness.Miner().Client, t.tapd,
-		[]*mintrpc.MintAssetRequest{simpleAssets[1]},
+		[]*mintrpc.MintAssetRequest{simpleAssets[0]},
 	)
-
 	genInfo2 := rpcAssets2[0].AssetGenesis
-	assetAmount2 := simpleAssets[1].Asset.Amount
 
-	// Create another address for Bob.
+	// Send full amount of the new asset. This should sweep Alice's
+	// first tombstone and create a new one.
 	bobAddr2, err := secondTapd.NewAddr(ctxb, &taprpc.NewAddrRequest{
 		AssetId:      genInfo2.AssetId,
-		Amt:          assetAmount2,
+		Amt:          assetAmount,
 		AssetVersion: rpcAssets2[0].Version,
 	})
 	require.NoError(t.t, err)
 
-	// Send the new assets. This should sweep Alice's tombstone UTXOs.
 	sendResp2, _ := sendAssetsToAddr(t, t.tapd, bobAddr2)
 
-	// Confirm the send.
 	ConfirmAndAssertOutboundTransfer(
 		t.t, t.lndHarness.Miner().Client, t.tapd, sendResp2,
 		genInfo2.AssetId,
-		[]uint64{0, assetAmount2}, 1, 2,
+		[]uint64{0, assetAmount}, 1, 2,
 	)
 	AssertNonInteractiveRecvComplete(t.t, secondTapd, 2)
 
-	// Check Alice's UTXOs again. The tombstones should have been swept.
-	finalAliceUtxos, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{})
+	// Check Alice's UTXOs again. The tombstone should have been swept.
+	utxosAfterSend, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{
+		ScriptKeyType: &taprpc.ScriptKeyTypeQuery{
+			Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+				ExplicitType: taprpc.
+					ScriptKeyType_SCRIPT_KEY_TOMBSTONE,
+			},
+		},
+	})
 	require.NoError(t.t, err)
+	require.Len(t.t, utxosAfterSend.ManagedUtxos, 2)
+
+	// After the sweep, check that the first tombstone
+	// is now marked as swept.
+	sweptUtxo, ok := utxosAfterSend.ManagedUtxos[tombstoneOp]
+	require.True(t.t, ok)
+	require.True(t.t, sweptUtxo.Swept)
+
+	tombstoneOp2 := ""
+	for outpoint, utxo := range utxosAfterSend.ManagedUtxos {
+		if !utxo.Swept {
+			tombstoneOp2 = outpoint
+			break
+		}
+	}
+	require.NotEmpty(t.t, tombstoneOp2)
 
-	finalTombstoneCount := 0
-	for _, utxo := range finalAliceUtxos.ManagedUtxos {
-		if len(utxo.Assets) == 0 {
-			finalTombstoneCount++
-			t.t.Logf("Found tombstone UTXO after sweep: %s, value=%d",
-				utxo.OutPoint, utxo.AmtSat)
+	// Test 2: Burning transaction sweeps tombstones.
+	rpcAssets3 := MintAssetsConfirmBatch(
+		t.t, t.lndHarness.Miner().Client, t.tapd,
+		[]*mintrpc.MintAssetRequest{simpleAssets[0]},
+	)
+	genInfo3 := rpcAssets3[0].AssetGenesis
+
+	// Full burn the asset to create a zero-value burn UTXO
+	// and sweep the second tombstone.
+	burnResp, err := t.tapd.BurnAsset(ctxb, &taprpc.BurnAssetRequest{
+		Asset: &taprpc.BurnAssetRequest_AssetId{
+			AssetId: genInfo3.AssetId,
+		},
+		AmountToBurn:     assetAmount,
+		ConfirmationText: "assets will be destroyed",
+	})
+	require.NoError(t.t, err)
+
+	AssertAssetOutboundTransferWithOutputs(
+		t.t, t.lndHarness.Miner().Client, t.tapd, burnResp.BurnTransfer,
+		[][]byte{genInfo3.AssetId},
+		[]uint64{assetAmount}, 2, 3, 1, true,
+	)
+
+	// Second tombstone should be swept.
+	utxosAfterBurn, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{
+		ScriptKeyType: &taprpc.ScriptKeyTypeQuery{
+			Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+				ExplicitType: taprpc.
+					ScriptKeyType_SCRIPT_KEY_TOMBSTONE,
+			},
+		},
+	},
+	)
+	require.NoError(t.t, err)
+
+	sweptTombstone2, ok := utxosAfterBurn.ManagedUtxos[tombstoneOp2]
+	require.True(t.t, ok)
+	require.True(t.t, sweptTombstone2.Swept)
+
+	burnUtxos, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{
+		ScriptKeyType: &taprpc.ScriptKeyTypeQuery{
+			Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+				ExplicitType: taprpc.
+					ScriptKeyType_SCRIPT_KEY_BURN,
+			},
+		},
+	})
+	require.NoError(t.t, err)
+	require.Len(t.t, burnUtxos.ManagedUtxos, 1)
+
+	burnOutpoint := ""
+	for outpoint, utxo := range burnUtxos.ManagedUtxos {
+		if !utxo.Swept {
+			burnOutpoint = outpoint
+			break
 		}
 	}
+	require.NotEmpty(t.t, burnOutpoint)
+
+	// Test 3: Send transactions sweeps zero-value burns.
+	rpcAssets4 := MintAssetsConfirmBatch(
+		t.t, t.lndHarness.Miner().Client, t.tapd,
+		[]*mintrpc.MintAssetRequest{simpleAssets[0]},
+	)
+	genInfo4 := rpcAssets4[0].AssetGenesis
+
+	// Send partial amouunt. This should NOT create a tombstone output
+	// and sweep the burn UTXO.
+	partialAmount := assetAmount / 2
+	bobAddr3, err := secondTapd.NewAddr(ctxb, &taprpc.NewAddrRequest{
+		AssetId:      genInfo4.AssetId,
+		Amt:          partialAmount,
+		AssetVersion: rpcAssets4[0].Version,
+	})
+	require.NoError(t.t, err)
+
+	sendResp3, _ := sendAssetsToAddr(t, t.tapd, bobAddr3)
 
-	t.t.Logf("Alice has %d tombstone UTXOs after sweep", finalTombstoneCount)
+	ConfirmAndAssertOutboundTransfer(
+		t.t, t.lndHarness.Miner().Client, t.tapd, sendResp3,
+		genInfo4.AssetId,
+		[]uint64{partialAmount, partialAmount}, 3, 4,
+	)
+	AssertNonInteractiveRecvComplete(t.t, secondTapd, 3)
+
+	// Burn UTXO should be swept.
+	finalBurnUtxos, err := t.tapd.ListUtxos(ctxb, &taprpc.ListUtxosRequest{
+		ScriptKeyType: &taprpc.ScriptKeyTypeQuery{
+			Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+				ExplicitType: taprpc.
+					ScriptKeyType_SCRIPT_KEY_BURN,
+			},
+		},
+	})
+	require.NoError(t.t, err)
+	require.Len(t.t, finalBurnUtxos.ManagedUtxos, 1)
 
-	// We expect no tombstones after the sweep transaction.
-	require.Equal(t.t, 0, finalTombstoneCount,
-		"All tombstones should be swept")
+	sweptBurnUtxo, ok := finalBurnUtxos.ManagedUtxos[burnOutpoint]
+	require.True(t.t, ok)
+	require.True(t.t, sweptBurnUtxo.Swept)
 }

rpcserver.go

@@ -1403,6 +1403,7 @@ func (r *rpcServer) ListUtxos(ctx context.Context,
 			MerkleRoot:       u.MerkleRoot,
 			LeaseOwner:       u.LeaseOwner[:],
 			LeaseExpiryUnix:  u.LeaseExpiry.Unix(),
+			Swept:            u.Swept,
 		}
 	}
 
@@ -1419,6 +1420,14 @@ func (r *rpcServer) ListUtxos(ctx context.Context,
 		utxos[op] = utxo
 	}
 
+	// As a final pass, we'll prune out any UTXOs that don't have any
+	// assets, as these may be in the DB just for record keeping.
+	for _, utxo := range utxos {
+		if len(utxo.Assets) == 0 {
+			delete(utxos, utxo.OutPoint)
+		}
+	}
+
 	return &taprpc.ListUtxosResponse{
 		ManagedUtxos: utxos,
 	}, nil
@@ -2612,8 +2621,17 @@ 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)
+	}
+
 	resp, err := r.cfg.ChainPorter.RequestShipment(
-		tapfreighter.NewPreSignedParcel(vPackets, inputCommitments, ""),
+		tapfreighter.NewPreSignedParcel(
+			vPackets, inputCommitments, zeroValueInputs, "",
+		),
 	)
 	if err != nil {
 		return nil, fmt.Errorf("error requesting delivery: %w", err)
@@ -3726,7 +3744,8 @@ func (r *rpcServer) BurnAsset(ctx context.Context,
 
 	resp, err := r.cfg.ChainPorter.RequestShipment(
 		tapfreighter.NewPreSignedParcel(
-			fundResp.VPackets, fundResp.InputCommitments, in.Note,
+			fundResp.VPackets, fundResp.InputCommitments,
+			fundResp.ZeroValueInputs, in.Note,
 		),
 	)
 	if err != nil {