itest: add test for consistent balance reporting

This commit adds an integration test to ensure consistent balance
reporting across various scenarios. The test covers custom channel
funding and list balance operations to verify that balance information
is accurately reported between lnd's `ChannelBalance` and tapd's
`ListBalance` RPCs, without accidental double reporting.

Author: gijswijs

itest/litd_custom_channels_test.go

@@ -6,6 +6,7 @@ import (
 	"slices"
 	"time"
 
+	"github.com/btcsuite/btcd/btcec/v2/schnorr"
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/chaincfg/chainhash"
 	"github.com/lightninglabs/taproot-assets/itest"
@@ -1894,3 +1895,200 @@ func testCustomChannelsLiquidityEdgeCases(_ context.Context,
 
 	logBalance(t.t, nodes, assetID, "after giant asset payment")
 }
+
+// testCustomChannelsBalanceConsistency is a test that test the balance .
+func testCustomChannelsBalanceConsistency(_ 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)
+
+	nodes := []*HarnessNode{charlie, dave}
+	connectAllNodes(t.t, net, nodes)
+	fundAllNodes(t.t, net, nodes)
+
+	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
+	}
+
+	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
+
+	// Charlie should have a single balance output with the full balance.
+	assertAssetBalance(t.t, charlieTap, assetID, cents.Amount)
+
+	// The script key should be local to charlie, and the script key should
+	// be known. It is after all the asset he just minted himself.
+	scriptKeyLocal := true
+	scriptKeyKnown := false
+	scriptKeyHasScriptPath := false
+
+	scriptKey, err := schnorr.ParsePubKey(cents.ScriptKey[1:])
+	require.NoError(t.t, err)
+	assertAssetExists(
+		t.t, charlieTap, assetID, charlieBalance,
+		scriptKey, scriptKeyLocal, scriptKeyKnown,
+		scriptKeyHasScriptPath,
+	)
+
+	fundingScriptTree := tapchannel.NewFundingScriptTree()
+	fundingScriptKey := fundingScriptTree.TaprootKey
+	fundingScriptTreeBytes := fundingScriptKey.SerializeCompressed()
+
+	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)
+
+	// The script key should now not be local anymore, since he funded a
+	// channel with it. Charlie does still know the script key though.
+	scriptKeyLocal = false
+	scriptKeyKnown = true
+	scriptKeyHasScriptPath = true
+	assertAssetExists(
+		t.t, charlieTap, assetID, charlieBalance,
+		fundingScriptKey, scriptKeyLocal, scriptKeyKnown,
+		scriptKeyHasScriptPath,
+	)
+
+	// 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 500 assets from Charlie to Dave.
+	sendAssetKeySendPayment(
+		t.t, charlie, dave, 500, assetID,
+		fn.None[int64](), lnrpc.Payment_SUCCEEDED,
+		fn.None[lnrpc.PaymentFailureReason](),
+	)
+
+	logBalance(t.t, nodes, assetID, "after 500 assets")
+
+	// Charlie should have a single balance output with the full balance.
+	// TODO: THIS ASSUMPTION SHOULD BE CHANGED AFTER TAPD STOPS INCLUDING
+	// NON-LOCAL BALANCES IN LISTBALANCES CALLS.
+	assertAssetBalance(t.t, charlieTap, assetID, charlieBalance)
+	assertAssetBalance(t.t, daveTap, assetID, 0)
+
+	// Send 10k sats from Charlie to Dave. Dave needs the sats to be able to
+	// send assets.
+	sendKeySendPayment(t.t, charlie, dave, 10000)
+
+	// Now Dave tries to send 250 assets.
+	sendAssetKeySendPayment(
+		t.t, dave, charlie, 250, assetID,
+		fn.None[int64](), lnrpc.Payment_SUCCEEDED,
+		fn.None[lnrpc.PaymentFailureReason](),
+	)
+
+	logBalance(t.t, nodes, assetID, "after 250 sats backwards")
+
+	// Charlie should have a single balance output with the full balance.
+	// TODO: THIS ASSUMPTION SHOULD BE CHANGED AFTER TAPD STOPS INCLUDING
+	// NON-LOCAL BALANCES IN LISTBALANCES CALLS.
+	assertAssetBalance(t.t, charlieTap, assetID, charlieBalance)
+	assertAssetBalance(t.t, daveTap, assetID, 0)
+
+	// We will now close the channel.
+	t.Logf("Close the channel between Charlie and Dave...")
+	charlieChanPoint := &lnrpc.ChannelPoint{
+		OutputIndex: uint32(fundRespCD.OutputIndex),
+		FundingTxid: &lnrpc.ChannelPoint_FundingTxidStr{
+			FundingTxidStr: fundRespCD.Txid,
+		},
+	}
+
+	closeChannelAndAssert(t, net, charlie, charlieChanPoint, false)
+
+	// Charlie should have a single balance output with the balance 250 less
+	// than the total amount minted.
+	assertAssetBalance(t.t, charlieTap, assetID, charlieBalance-250)
+	assertAssetBalance(t.t, daveTap, assetID, 250)
+
+	// The script key should now be local to both Charlie and Dave, since
+	// the channel was closed.
+	scriptKeyLocal = true
+	scriptKeyKnown = true
+	scriptKeyHasScriptPath = false
+	assertAssetExists(
+		t.t, charlieTap, assetID, charlieBalance-250,
+		nil, scriptKeyLocal, scriptKeyKnown, scriptKeyHasScriptPath,
+	)
+	assertAssetExists(
+		t.t, daveTap, assetID, 250,
+		nil, scriptKeyLocal, scriptKeyKnown, scriptKeyHasScriptPath,
+	)
+
+	assertNumAssetOutputs(t.t, charlieTap, assetID, 1)
+	assertNumAssetOutputs(t.t, daveTap, assetID, 1)
+}

itest/litd_test_list_on_test.go

@@ -44,4 +44,8 @@ var allTestCases = []*testCase{
 		name: "test custom channels liquidity",
 		test: testCustomChannelsLiquidityEdgeCases,
 	},
+	{
+		name: "test custom channels balance consistency",
+		test: testCustomChannelsBalanceConsistency,
+	},
 }