itest: add custom channels liquidity edge cases test

Author: GeorgeTsagk

itest/assets_test.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"os"
 	"testing"
+	"time"
 
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcec/v2/schnorr"
@@ -45,6 +46,10 @@ import (
 	"gopkg.in/macaroon.v2"
 )
 
+var (
+	PaymentTimeoutSec = int32(6)
+)
+
 // createTestAssetNetwork sends asset funds from Charlie to Dave and Erin, so
 // they can fund asset channels with Yara and Fabia, respectively. So the asset
 // channels created are Charlie->Dave, Dave->Yara, Erin->Fabia. The channels
@@ -429,9 +434,10 @@ func assertPendingChannels(t *testing.T, node *HarnessNode, assetID []byte,
 
 	require.NotZero(t, pendingJSON.Assets[0].Capacity)
 
-	pendingLocalBalance, pendingRemoteBalance := getAssetChannelBalance(
-		t, node, assetID, true,
-	)
+	pendingLocalBalance, pendingRemoteBalance, _, _ :=
+		getAssetChannelBalance(
+			t, node, assetID, true,
+		)
 	require.EqualValues(t, localSum, pendingLocalBalance)
 	require.EqualValues(t, remoteSum, pendingRemoteBalance)
 }
@@ -542,7 +548,7 @@ func getChannelCustomData(src, dst *HarnessNode) (*rfqmsg.JsonAssetChanInfo,
 }
 
 func getAssetChannelBalance(t *testing.T, node *HarnessNode, assetID []byte,
-	pending bool) (uint64, uint64) {
+	pending bool) (uint64, uint64, uint64, uint64) {
 
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
@@ -572,11 +578,13 @@ func getAssetChannelBalance(t *testing.T, node *HarnessNode, assetID []byte,
 		remoteSum += balances[assetIDString].RemoteBalance
 	}
 
-	return localSum, remoteSum
+	return localSum, remoteSum, balance.LocalBalance.Sat,
+		balance.RemoteBalance.Sat
 }
 
 func sendAssetKeySendPayment(t *testing.T, src, dst *HarnessNode, amt uint64,
-	assetID []byte, btcAmt fn.Option[int64]) {
+	assetID []byte, btcAmt fn.Option[int64],
+	expectedStatus lnrpc.Payment_PaymentStatus) {
 
 	ctxb := context.Background()
 	ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
@@ -601,7 +609,7 @@ func sendAssetKeySendPayment(t *testing.T, src, dst *HarnessNode, amt uint64,
 		Amt:               btcAmt.UnwrapOr(500),
 		DestCustomRecords: customRecords,
 		PaymentHash:       hash[:],
-		TimeoutSeconds:    3,
+		TimeoutSeconds:    PaymentTimeoutSec,
 	}
 
 	stream, err := srcTapd.SendPayment(ctxt, &tchrpc.SendPaymentRequest{
@@ -613,7 +621,7 @@ func sendAssetKeySendPayment(t *testing.T, src, dst *HarnessNode, amt uint64,
 
 	result, err := getAssetPaymentResult(stream)
 	require.NoError(t, err)
-	require.Equal(t, lnrpc.Payment_SUCCEEDED, result.Status)
+	require.Equal(t, expectedStatus, result.Status)
 }
 
 func sendKeySendPayment(t *testing.T, src, dst *HarnessNode,
@@ -640,7 +648,7 @@ func sendKeySendPayment(t *testing.T, src, dst *HarnessNode,
 		Amt:               int64(amt),
 		DestCustomRecords: customRecords,
 		PaymentHash:       hash[:],
-		TimeoutSeconds:    3,
+		TimeoutSeconds:    PaymentTimeoutSec,
 	}
 
 	stream, err := src.RouterClient.SendPaymentV2(ctxt, req)
@@ -698,7 +706,7 @@ func payInvoiceWithSatoshi(t *testing.T, payer *HarnessNode,
 
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest:   invoice.PaymentRequest,
-		TimeoutSeconds:   2,
+		TimeoutSeconds:   PaymentTimeoutSec,
 		MaxShardSizeMsat: 80_000_000,
 		FeeLimitMsat:     1_000_000,
 	}
@@ -727,7 +735,7 @@ func payInvoiceWithAssets(t *testing.T, payer, rfqPeer *HarnessNode,
 
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoice.PaymentRequest,
-		TimeoutSeconds: 2,
+		TimeoutSeconds: PaymentTimeoutSec,
 		FeeLimitMsat:   1_000_000,
 	}
 
@@ -1422,10 +1430,15 @@ func logBalance(t *testing.T, nodes []*HarnessNode, assetID []byte,
 
 	t.Helper()
 
+	time.Sleep(time.Millisecond * 250)
+
 	for _, node := range nodes {
-		local, remote := getAssetChannelBalance(t, node, assetID, false)
-		t.Logf("%-7s balance: local=%-9d remote=%-9d (%v)",
-			node.Cfg.Name, local, remote, occasion)
+		local, remote, localSat, remoteSat :=
+			getAssetChannelBalance(t, node, assetID, false)
+
+		t.Logf("%-7s balance: local=%-9d remote=%-9d, localSat=%-9d, "+
+			"remoteSat=%-9d (%v)", node.Cfg.Name, local, remote,
+			localSat, remoteSat, occasion)
 	}
 }
 

itest/litd_custom_channels_test.go

@@ -238,7 +238,7 @@ func testCustomChannelsLarge(_ context.Context, net *NetworkHarness,
 		fabiaInvoiceAssetAmount/2
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, charlieRemainingBalance,
-		assetID, fn.None[int64](),
+		assetID, fn.None[int64](), lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend")
 
@@ -400,7 +400,7 @@ func testCustomChannels(_ context.Context, net *NetworkHarness,
 	keySendAmount := charlieFundingAmount
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, charlieFundingAmount, assetID,
-		fn.None[int64](),
+		fn.None[int64](), lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend")
 
@@ -431,7 +431,7 @@ func testCustomChannels(_ context.Context, net *NetworkHarness,
 	// Let's keysend the rest of the balance back to Charlie.
 	sendAssetKeySendPayment(
 		t.t, dave, charlie, charlieFundingAmount-charlieInvoiceAmount,
-		assetID, fn.None[int64](),
+		assetID, fn.None[int64](), lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend back")
 
@@ -856,6 +856,7 @@ func testCustomChannelsGroupedAsset(_ context.Context, net *NetworkHarness,
 	const keySendAmount = 100
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, keySendAmount, assetID, fn.None[int64](),
+		lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend")
 
@@ -867,6 +868,7 @@ func testCustomChannelsGroupedAsset(_ context.Context, net *NetworkHarness,
 	// an HTLC.
 	sendAssetKeySendPayment(
 		t.t, dave, charlie, keySendAmount, assetID, fn.None[int64](),
+		lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend back")
 
@@ -1266,7 +1268,7 @@ func testCustomChannelsForceClose(_ context.Context, net *NetworkHarness,
 	for i := 0; i < numPayments; i++ {
 		sendAssetKeySendPayment(
 			t.t, charlie, dave, keySendAmount, assetID,
-			fn.Some(btcAmt),
+			fn.Some(btcAmt), lnrpc.Payment_SUCCEEDED,
 		)
 	}
 
@@ -1590,7 +1592,7 @@ func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 	for i := 0; i < numPayments; i++ {
 		sendAssetKeySendPayment(
 			t.t, charlie, dave, keySendAmount, assetID,
-			fn.Some(btcAmt),
+			fn.Some(btcAmt), lnrpc.Payment_SUCCEEDED,
 		)
 	}
 
@@ -1605,6 +1607,7 @@ func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 	// just at above.
 	sendAssetKeySendPayment(
 		t.t, charlie, dave, keySendAmount, assetID, fn.Some(btcAmt),
+		lnrpc.Payment_SUCCEEDED,
 	)
 	logBalance(t.t, nodes, assetID, "after keysend -- final state")
 
@@ -1675,3 +1678,189 @@ func testCustomChannelsBreach(_ context.Context, net *NetworkHarness,
 
 	t.Logf("Charlie UTXOs after breach: %v", toProtoJSON(t.t, charlieUTXOs))
 }
+
+func testCustomChannelsLiquidityEdgeCases(_ context.Context,
+	net *NetworkHarness, t *harnessTest) {
+
+	ctxb := context.Background()
+	lndArgs := slices.Clone(lndArgsTemplate)
+	litdArgs := slices.Clone(litdArgsTemplate)
+
+	zane, err := net.NewNode(
+		t.t, "Zane", lndArgs, false, true, litdArgs...,
+	)
+	require.NoError(t.t, err)
+
+	litdArgs = append(litdArgs, fmt.Sprintf(
+		"--taproot-assets.proofcourieraddr=%s://%s",
+		proof.UniverseRpcCourierType, zane.Cfg.LitAddr(),
+	))
+
+	charlie, err := net.NewNode(
+		t.t, "Charlie", lndArgs, false, true, litdArgs...,
+	)
+	require.NoError(t.t, err)
+	dave, err := net.NewNode(t.t, "Dave", lndArgs, false, true, litdArgs...)
+	require.NoError(t.t, err)
+	erin, err := net.NewNode(t.t, "Erin", lndArgs, false, true, litdArgs...)
+	require.NoError(t.t, err)
+
+	nodes := []*HarnessNode{charlie, dave, erin}
+	connectAllNodes(t.t, net, nodes)
+	fundAllNodes(t.t, net, nodes)
+
+	// Create the normal channel between Dave and Erin.
+	t.Logf("Opening normal channel between Dave and Erin...")
+	channelOp := openChannelAndAssert(
+		t, net, dave, erin, lntest.OpenChannelParams{
+			Amt:         5_000_000,
+			SatPerVByte: 5,
+		},
+	)
+	defer closeChannelAndAssert(t, net, dave, channelOp, false)
+
+	assertChannelKnown(t.t, charlie, channelOp)
+
+	charlieTap := newTapClient(t.t, charlie)
+	daveTap := newTapClient(t.t, dave)
+	universeTap := newTapClient(t.t, zane)
+
+	// Mint an asset on Charlie and sync Dave to Charlie as the universe.
+	mintedAssets := itest.MintAssetsConfirmBatch(
+		t.t, t.lndHarness.Miner.Client, charlieTap,
+		[]*mintrpc.MintAssetRequest{
+			{
+				Asset: itestAsset,
+			},
+		},
+	)
+	cents := mintedAssets[0]
+	assetID := cents.AssetGenesis.AssetId
+	var groupKey []byte
+	if cents.AssetGroup != nil {
+		groupKey = cents.AssetGroup.TweakedGroupKey
+	}
+	fundingScriptTree := tapchannel.NewFundingScriptTree()
+	fundingScriptKey := fundingScriptTree.TaprootKey
+	fundingScriptTreeBytes := fundingScriptKey.SerializeCompressed()
+
+	t.Logf("Minted %d lightning cents, syncing universes...", cents.Amount)
+	syncUniverses(t.t, charlieTap, dave)
+	t.Logf("Universes synced between all nodes, distributing assets...")
+
+	charlieBalance := cents.Amount
+
+	fundRespCD, err := charlieTap.FundChannel(
+		ctxb, &tchrpc.FundChannelRequest{
+			AssetAmount:        charlieBalance,
+			AssetId:            assetID,
+			PeerPubkey:         daveTap.node.PubKey[:],
+			FeeRateSatPerVbyte: 5,
+			PushSat:            0,
+		},
+	)
+	require.NoError(t.t, err)
+	t.Logf("Funded channel between Charlie and Dave: %v", fundRespCD)
+
+	// Make sure the pending channel shows up in the list and has the
+	// custom records set as JSON.
+	assertPendingChannels(
+		t.t, charlieTap.node, assetID, 1, charlieBalance, 0,
+	)
+
+	// Let's confirm the channel.
+	mineBlocks(t, net, 6, 1)
+
+	assertAssetBalance(t.t, charlieTap, assetID, cents.Amount)
+
+	// There should only be a single asset piece for Charlie, the one in the
+	// channel.
+	assertNumAssetOutputs(t.t, charlieTap, assetID, 1)
+	assertAssetExists(
+		t.t, charlieTap, assetID, charlieBalance,
+		fundingScriptKey, false, true, true,
+	)
+
+	// Assert that the proofs for both channels has been uploaded to the
+	// designated Universe server.
+	assertUniverseProofExists(
+		t.t, universeTap, assetID, groupKey, fundingScriptTreeBytes,
+		fmt.Sprintf("%v:%v", fundRespCD.Txid, fundRespCD.OutputIndex),
+	)
+
+	// Make sure the channel shows the correct asset information.
+	assertAssetChan(
+		t.t, charlieTap.node, daveTap.node, charlieBalance, assetID,
+	)
+
+	logBalance(t.t, nodes, assetID, "initial")
+
+	// Normal case.
+	// Send 50 assets from Charlie to Dave.
+	sendAssetKeySendPayment(
+		t.t, charlie, dave, 50, assetID,
+		fn.None[int64](), lnrpc.Payment_SUCCEEDED,
+	)
+
+	logBalance(t.t, nodes, assetID, "after 50 assets")
+
+	// Normal case.
+	// Send 1k sats from Charlie to Dave.
+	sendKeySendPayment(t.t, charlie, dave, 1000)
+
+	logBalance(t.t, nodes, assetID, "after 1k sats")
+
+	// Edge case: The channel reserve check should trigger, and we should
+	// get a payment failure, not a timeout.
+	//
+	// Now Dave tries to send 50 assets to Charlie. There shouldn't be
+	// enough sats in the channel.
+	sendAssetKeySendPayment(
+		t.t, dave, charlie, 50, assetID,
+		fn.None[int64](), lnrpc.Payment_FAILED,
+	)
+
+	logBalance(t.t, nodes, assetID, "after failed 50 assets")
+
+	// Send 10k sats from Charlie to Dave.
+	sendKeySendPayment(t.t, charlie, dave, 10000)
+
+	logBalance(t.t, nodes, assetID, "10k sats")
+
+	// Now Dave tries to send 50 assets again, this time he should have
+	// enough sats.
+	sendAssetKeySendPayment(
+		t.t, dave, charlie, 50, assetID,
+		fn.None[int64](), lnrpc.Payment_SUCCEEDED,
+	)
+
+	logBalance(t.t, nodes, assetID, "after 50 sats backwards")
+
+	// Edge case: This refers to a bug where an asset allocation would be
+	// expected for this HTLC. This is a dust HTLC and it can not carry
+	// assets.
+	//
+	// Send 1 sat from Charlie to Dave.
+	sendKeySendPayment(t.t, charlie, dave, 1)
+
+	logBalance(t.t, nodes, assetID, "after 1 sat")
+
+	// Pay a normal bolt11 invoice involving RFQ flow.
+	_ = createAndPayNormalInvoice(
+		t.t, charlie, dave, erin, 20_000, assetID, true,
+	)
+
+	logBalance(t.t, nodes, assetID, "after 20k sat asset payment")
+
+	// Edge case: There was a bug when paying an asset invoice that would
+	// evaluate to more than the channel capacity, causing a payment failure
+	// even though enough asset balance exists.
+	//
+	// Pay a bolt11 invoice with assets, which evaluates to more than the
+	// channel btc capacity.
+	_ = createAndPayNormalInvoice(
+		t.t, charlie, dave, erin, 220_000, assetID, true,
+	)
+
+	logBalance(t.t, nodes, assetID, "after giant asset payment")
+}

itest/litd_test_list_on_test.go

@@ -40,4 +40,8 @@ var allTestCases = []*testCase{
 		name: "test custom channels breach",
 		test: testCustomChannelsBreach,
 	},
+	{
+		name: "test custom channels liquidity",
+		test: testCustomChannelsLiquidityEdgeCases,
+	},
 }