itest: add and use rpcassert.ListUtxosRPC

Add test helper function rpcassert.ListUtxosRPC, which calls the
ListUtxos RPC endpoint on the provided client. The call is wrapped
with wait.NoError to allow for more lenient timing expectations, thus
reducing test flakes.

Use the new helper in AssertBalances.

Author: ffranr

itest/assertions.go

@@ -2550,74 +2550,86 @@ func AssertBalances(t *testing.T, client taprpc.TaprootAssetsClient,
 		},
 	)
 
-	utxoList, err := client.ListUtxos(ctxt, &taprpc.ListUtxosRequest{
-		IncludeLeased: config.includeLeased,
-		ScriptKeyType: rpcTypeQuery,
-	})
-	require.NoError(t, err)
-
 	// Make sure the ListUtxos call returns the same number of (asset) UTXOs
 	// as the ListAssets call.
-	var (
-		numAnchorUtxos uint32
-		totalBalance   uint64
-		numUtxos       uint32
-	)
+	assertPredUtxos := func(resp *taprpc.ListUtxosResponse) error {
+		var (
+			numAnchorUtxos uint32
+			totalBalance   uint64
+			numUtxos       uint32
+		)
 
-	for _, btcUtxo := range utxoList.ManagedUtxos {
-		numAnchorUtxos++
-		for _, assetUtxo := range btcUtxo.Assets {
-			if len(config.assetID) > 0 {
-				if !bytes.Equal(
-					assetUtxo.AssetGenesis.AssetId,
-					config.assetID,
-				) {
+		for _, btcUtxo := range resp.ManagedUtxos {
+			numAnchorUtxos++
+			for _, assetUtxo := range btcUtxo.Assets {
+				if len(config.assetID) > 0 {
+					if !bytes.Equal(
+						assetUtxo.AssetGenesis.AssetId,
+						config.assetID,
+					) {
 
-					continue
+						continue
+					}
 				}
-			}
 
-			if len(config.groupKey) > 0 {
-				if assetUtxo.AssetGroup == nil {
-					continue
-				}
+				if len(config.groupKey) > 0 {
+					if assetUtxo.AssetGroup == nil {
+						continue
+					}
 
-				if !bytes.Equal(
-					assetUtxo.AssetGroup.TweakedGroupKey,
-					config.groupKey,
-				) {
+					// nolint: lll
+					actualGK := assetUtxo.AssetGroup.TweakedGroupKey
 
-					continue
+					if !bytes.Equal(
+						actualGK, config.groupKey,
+					) {
+
+						continue
+					}
 				}
-			}
 
-			if len(config.scriptKey) > 0 {
-				if !bytes.Equal(
-					assetUtxo.ScriptKey, config.scriptKey,
-				) {
+				if len(config.scriptKey) > 0 {
+					if !bytes.Equal(
+						assetUtxo.ScriptKey,
+						config.scriptKey,
+					) {
 
-					continue
+						continue
+					}
 				}
+
+				totalBalance += assetUtxo.Amount
+				numUtxos++
 			}
+		}
 
-			totalBalance += assetUtxo.Amount
-			numUtxos++
+		if balance != totalBalance {
+			return fmt.Errorf("ListUtxos balance, wanted %d, "+
+				"got: %v", balance, toJSON(t, resp))
 		}
-	}
-	require.Equal(t, balance, totalBalance, "ListUtxos balance")
 
-	if config.numAnchorUtxos > 0 {
-		require.Equal(
-			t, config.numAnchorUtxos, numAnchorUtxos, "num anchor "+
-				"utxos",
-		)
-	}
-	if config.numAssetUtxos > 0 {
-		require.Equal(
-			t, config.numAssetUtxos, numUtxos, "ListUtxos num "+
-				"asset utxos",
-		)
+		if config.numAnchorUtxos > 0 {
+			if config.numAnchorUtxos != numAnchorUtxos {
+				return fmt.Errorf("unexpected number of " +
+					"anchor UTXOs")
+			}
+		}
+		if config.numAssetUtxos > 0 {
+			if config.numAssetUtxos != numUtxos {
+				return fmt.Errorf("unexpected number of " +
+					"asset UTXOs")
+			}
+		}
+
+		return nil
 	}
+
+	rpcassert.ListUtxosRPC(t, ctxt, client, assertPredUtxos,
+		&taprpc.ListUtxosRequest{
+			IncludeLeased: config.includeLeased,
+			ScriptKeyType: rpcTypeQuery,
+		},
+	)
 }
 
 func assertGroups(t *testing.T, client taprpc.TaprootAssetsClient,

itest/rpcassert/taprpc.go

@@ -124,3 +124,40 @@ func ListAssetsRPC(t *testing.T, ctx context.Context,
 
 	return resp
 }
+
+// ListUtxosRPC calls ListUtxos RPC with the given request until the
+// given assertion predicate returns no error or the timeout is reached. If the
+// predicate is nil, only basic checks are performed (non-nil response).
+//
+// If the assertion fails, the test is failed.
+func ListUtxosRPC(t *testing.T, ctx context.Context,
+	client taprpc.TaprootAssetsClient,
+	assertPredicate func(*taprpc.ListUtxosResponse) error,
+	req *taprpc.ListUtxosRequest) *taprpc.ListUtxosResponse {
+
+	t.Helper()
+
+	var resp *taprpc.ListUtxosResponse
+	err := wait.NoError(func() error {
+		var err error
+		resp, err = client.ListUtxos(ctx, req)
+		if err != nil {
+			return err
+		}
+
+		if resp == nil {
+			return fmt.Errorf("nil response")
+		}
+
+		if assertPredicate != nil {
+			return assertPredicate(resp)
+		}
+
+		return nil
+	}, defaultWaitTimeout)
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	return resp
+}