itest: custom channels flakes fixes

Author: GeorgeTsagk

itest/litd_custom_channels_test.go

@@ -99,7 +99,9 @@ var (
 )
 
 const (
-	fundingAmount = 50_000
+	fundingAmount     = 50_000
+	eventuallyTimeout = time.Second * 30
+	eventuallyTicker  = time.Millisecond * 250
 )
 
 // testCustomChannels tests that we can create a network with custom channels
@@ -380,13 +382,23 @@ func testCustomChannels(_ context.Context, net *NetworkHarness,
 	assertAssetChan(t.t, dave, yara, daveFundingAmount, assetID)
 	assertAssetChan(t.t, erin, fabia, erinFundingAmount, assetID)
 
+	// Before we start sending out payments, let's make sure each node can
+	// see the other one in the graph and has all required features.
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, charlie))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, yara))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(yara, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(erin, fabia))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(fabia, erin))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, erin))
+
 	// Print initial channel balances.
 	logBalance(t.t, nodes, assetID, "initial")
 
 	// ------------
 	// Test case 1: Send a direct keysend payment from Charlie to Dave.
 	// ------------
-	const keySendAmount = 100
+	const keySendAmount = 1000
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, keySendAmount, assetID, fn.None[int64](),
 	)
@@ -395,6 +407,12 @@ func testCustomChannels(_ context.Context, net *NetworkHarness,
 	charlieAssetBalance -= keySendAmount
 	daveAssetBalance += keySendAmount
 
+	require.Eventually(t.t, func() bool {
+		local, _ := getAssetChannelBalance(t.t, dave, assetID, false)
+
+		return local == daveAssetBalance
+	}, eventuallyTimeout, eventuallyTicker)
+
 	// We should be able to send the 100 assets back immediately, because
 	// there is enough on-chain balance on Dave's side to be able to create
 	// an HTLC.
@@ -723,18 +741,16 @@ func testCustomChannelsGroupedAsset(_ context.Context, net *NetworkHarness,
 	fabiaTap := newTapClient(t.t, fabia)
 	yaraTap := newTapClient(t.t, yara)
 
-	groupAsset := itestAsset
-	groupAsset.NewGroupedAsset = true
+	groupAssetReq := itest.CopyRequest(&mintrpc.MintAssetRequest{
+		Asset: itestAsset,
+	})
+	groupAssetReq.Asset.NewGroupedAsset = true
 
 	// Mint an asset on Charlie and sync all nodes to Charlie as the
 	// universe.
 	mintedAssets := itest.MintAssetsConfirmBatch(
 		t.t, t.lndHarness.Miner.Client, charlieTap,
-		[]*mintrpc.MintAssetRequest{
-			{
-				Asset: groupAsset,
-			},
-		},
+		[]*mintrpc.MintAssetRequest{groupAssetReq},
 	)
 
 	cents := mintedAssets[0]
@@ -924,13 +940,23 @@ func testCustomChannelsGroupedAsset(_ context.Context, net *NetworkHarness,
 	assertAssetChan(t.t, dave, yara, daveFundingAmount, assetID)
 	assertAssetChan(t.t, erin, fabia, erinFundingAmount, assetID)
 
+	// Before we start sending out payments, let's make sure each node can
+	// see the other one in the graph and has all required features.
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, charlie))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, yara))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(yara, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(erin, fabia))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(fabia, erin))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, erin))
+
 	// Print initial channel balances.
 	logBalance(t.t, nodes, assetID, "initial")
 
 	// ------------
 	// Test case 1: Send a direct keysend payment from Charlie to Dave.
 	// ------------
-	const keySendAmount = 100
+	const keySendAmount = 1000
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, keySendAmount, assetID, fn.None[int64](),
 	)
@@ -939,6 +965,12 @@ func testCustomChannelsGroupedAsset(_ context.Context, net *NetworkHarness,
 	charlieAssetBalance -= keySendAmount
 	daveAssetBalance += keySendAmount
 
+	require.Eventually(t.t, func() bool {
+		local, _ := getAssetChannelBalance(t.t, dave, assetID, false)
+
+		return local == daveAssetBalance
+	}, eventuallyTimeout, eventuallyTicker)
+
 	// We should be able to send the 100 assets back immediately, because
 	// there is enough on-chain balance on Dave's side to be able to create
 	// an HTLC.
@@ -1261,7 +1293,7 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 	t.Logf("Funded channel between Charlie and Dave: %v", assetFundResp)
 
 	// With the channel open, mine a block to confirm it.
-	mineBlocks(t, net, 6, 1)
+	mineBlocksSlow(t, net, 6, 1)
 
 	// A transfer for the funding transaction should be found in Charlie's
 	// DB.
@@ -1276,9 +1308,7 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 
 	// Charlie's balance should reflect that the funding asset was added to
 	// the DB.
-	assertAssetBalance(
-		t.t, charlieTap, assetID, uint64(itestAsset.Amount),
-	)
+	assertAssetBalance(t.t, charlieTap, assetID, itestAsset.Amount)
 
 	// Make sure that Charlie properly uploaded funding proof to the
 	// Universe server.
@@ -1291,6 +1321,14 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 		),
 	)
 
+	// Make sure the channel shows the correct asset information.
+	assertAssetChan(t.t, charlie, dave, fundingAmount, assetID)
+
+	// Before we start sending out payments, let's make sure each node can
+	// see the other one in the graph and has all required features.
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, charlie))
+
 	// We'll also have dave sync with Charlie+Zane to ensure he has the
 	// proof for the funding output. We sync the transfers as well so he
 	// has all the proofs needed.
@@ -1441,22 +1479,6 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 		t.t, charlieSweepTransfer,
 	))
 
-	charlieUTXOs, err := charlieTap.ListUtxos(
-		ctxb, &taprpc.ListUtxosRequest{},
-	)
-	require.NoError(t.t, err)
-
-	t.Logf("Charlie UTXOs: %v", toProtoJSON(t.t, charlieUTXOs))
-
-	daveUTXOs, err := daveTap.ListUtxos(
-		ctxb, &taprpc.ListUtxosRequest{},
-	)
-	require.NoError(t.t, err)
-
-	t.Logf("Dave UTXOs: %v", toProtoJSON(t.t, daveUTXOs))
-
-	// TODO(roasbeef): assert 2 charlie UTXOs
-
 	// Both sides should now reflect their updated asset balances.
 	daveBalance := uint64(numPayments * keySendAmount)
 	charlieBalance := itestAsset.Amount - daveBalance
@@ -1465,26 +1487,12 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 
 	// Dave should have a single managed UTXO that shows he has a new asset
 	// UTXO he can use.
-	err = wait.NoError(func() error {
-		daveUTXOs, err = daveTap.ListUtxos(
-			ctxb, &taprpc.ListUtxosRequest{},
-		)
-		if err != nil {
-			return err
-		}
-
-		if len(daveUTXOs.ManagedUtxos) != 1 {
-			return fmt.Errorf("expected 1 UTXO, got %d",
-				len(daveUTXOs.ManagedUtxos))
-		}
-
-		return nil
-	}, defaultTimeout)
-	require.NoError(t.t, err)
-
-	t.Logf("Dave UTXOs: %v", toProtoJSON(t.t, daveUTXOs))
+	assertNumAssetUTXOs(t.t, daveTap, 1)
+	assertNumAssetUTXOs(t.t, charlieTap, 2)
 }
 
+// testCustomChannelsBreach tests a force close scenario that breaches an old
+// state, after both parties have an active asset balance.
 func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 	t *harnessTest) {
 
@@ -1528,6 +1536,7 @@ func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 	connectAllNodes(t.t, net, nodes)
 	fundAllNodes(t.t, net, nodes)
 
+	universeTap := newTapClient(t.t, zane)
 	charlieTap := newTapClient(t.t, charlie)
 	daveTap := newTapClient(t.t, dave)
 
@@ -1569,7 +1578,39 @@ func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 	// With the channel open, mine a block to confirm it.
 	mineBlocks(t, net, 6, 1)
 
-	time.Sleep(time.Second * 1)
+	// A transfer for the funding transaction should be found in Charlie's
+	// DB.
+	fundingTxid, err := chainhash.NewHashFromStr(assetFundResp.Txid)
+	require.NoError(t.t, err)
+	assetFundingTransfer := locateAssetTransfers(
+		t.t, charlieTap, *fundingTxid,
+	)
+
+	t.Logf("Channel funding transfer: %v",
+		toProtoJSON(t.t, assetFundingTransfer))
+
+	// Charlie's balance should reflect that the funding asset was added to
+	// the DB.
+	assertAssetBalance(t.t, charlieTap, assetID, itestAsset.Amount)
+
+	// Make sure that Charlie properly uploaded funding proof to the
+	// Universe server.
+	fundingScriptTree := tapchannel.NewFundingScriptTree()
+	fundingScriptKey := fundingScriptTree.TaprootKey
+	fundingScriptTreeBytes := fundingScriptKey.SerializeCompressed()
+	assertUniverseProofExists(
+		t.t, universeTap, assetID, fundingScriptTreeBytes, fmt.Sprintf(
+			"%v:%v", assetFundResp.Txid, assetFundResp.OutputIndex,
+		),
+	)
+
+	// Make sure the channel shows the correct asset information.
+	assertAssetChan(t.t, charlie, dave, fundingAmount, assetID)
+
+	// Before we start sending out payments, let's make sure each node can
+	// see the other one in the graph and has all required features.
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(charlie, dave))
+	require.NoError(t.t, t.lndHarness.AssertNodeKnown(dave, charlie))
 
 	// Next, we'll make keysend payments from Charlie to Dave. we'll use
 	// this to reach a state where both parties have funds in the channel.
@@ -1672,8 +1713,10 @@ func assertNumAssetUTXOs(t *testing.T, tapdClient *tapClient,
 
 	ctxb := context.Background()
 
+	var clientUTXOs *taprpc.ListUtxosResponse
 	err := wait.NoError(func() error {
-		clientUTXOs, err := tapdClient.ListUtxos(
+		var err error
+		clientUTXOs, err = tapdClient.ListUtxos(
 			ctxb, &taprpc.ListUtxosRequest{},
 		)
 		if err != nil {
@@ -1687,21 +1730,8 @@ func assertNumAssetUTXOs(t *testing.T, tapdClient *tapClient,
 
 		return nil
 	}, defaultTimeout)
-
-	clientUTXOs, err2 := tapdClient.ListUtxos(
-		ctxb, &taprpc.ListUtxosRequest{},
-	)
-	require.NoError(t, err2)
-
-	if err != nil {
-		t.Logf("wrong amount of UTXOs, got %d, expected %d: %v",
-			len(clientUTXOs.ManagedUtxos), numUTXOs,
-			toProtoJSON(t, clientUTXOs))
-
-		t.Fatalf("failed to assert UTXOs: %v", err)
-
-		return nil
-	}
+	require.NoErrorf(t, err, "failed to assert UTXOs: %v, last state: %v",
+		err, clientUTXOs)
 
 	return clientUTXOs
 }

itest/network_harness.go

@@ -25,6 +25,7 @@ import (
 	"github.com/lightningnetwork/lnd/lntest/node"
 	"github.com/lightningnetwork/lnd/lntest/port"
 	"github.com/lightningnetwork/lnd/lntest/wait"
+	"github.com/lightningnetwork/lnd/lnwire"
 	"github.com/stretchr/testify/require"
 	"golang.org/x/sync/errgroup"
 	"google.golang.org/grpc/grpclog"
@@ -1180,6 +1181,50 @@ func (n *NetworkHarness) AssertChannelExists(node *HarnessNode,
 	}, lntest.DefaultTimeout)
 }
 
+// AssertNodeKnown makes sure the given node knows about the target node in the
+// network graph.
+func (n *NetworkHarness) AssertNodeKnown(node, target *HarnessNode) error {
+	ctxb := context.Background()
+	ctxt, cancel := context.WithTimeout(ctxb, wait.DefaultTimeout)
+	defer cancel()
+
+	req := &lnrpc.NodeInfoRequest{
+		PubKey: hex.EncodeToString(
+			target.PubKey[:],
+		),
+	}
+	return wait.NoError(func() error {
+		info, err := node.GetNodeInfo(ctxt, req)
+		if err != nil {
+			return err
+		}
+
+		if info.Node == nil {
+			return fmt.Errorf("node %x has no info about %x",
+				node.PubKey[:], target.PubKey[:])
+		}
+
+		if len(info.Node.Features) == 0 {
+			return fmt.Errorf("node %x has no features for %x",
+				node.PubKey[:], target.PubKey[:])
+		}
+
+		_, optional := info.Node.Features[uint32(
+			lnwire.TLVOnionPayloadOptional,
+		)]
+		_, required := info.Node.Features[uint32(
+			lnwire.TLVOnionPayloadRequired,
+		)]
+		if !optional && !required {
+			return fmt.Errorf("node %x has no onion payload "+
+				"features for %x", node.PubKey[:],
+				target.PubKey[:])
+		}
+
+		return nil
+	}, lntest.DefaultTimeout)
+}
+
 // DumpLogs reads the current logs generated by the passed node, and returns
 // the logs as a single string. This function is useful for examining the logs
 // of a particular node in the case of a test failure.