itest: parse old channel format, more compat tests

Author: guggero

itest/assets_test.go

@@ -984,18 +984,12 @@ func assertPendingChannels(t *testing.T, node *HarnessNode,
 	require.NoError(t, err)
 	require.Len(t, pendingChannelsResp.PendingOpenChannels, numChannels)
 
-	// For older versions (during the backward compatibility test), if the
-	// channel custom data is in the old format, we can't do further checks.
-	if node.Cfg.OldChannelFormat {
-		return
-	}
-
 	pendingChan := pendingChannelsResp.PendingOpenChannels[0]
-	var pendingJSON rfqmsg.JsonAssetChannel
-	err = json.Unmarshal(
-		pendingChan.Channel.CustomChannelData, &pendingJSON,
+	pendingJSON, err := parseChannelData(
+		node, pendingChan.Channel.CustomChannelData,
 	)
 	require.NoError(t, err)
+
 	require.GreaterOrEqual(t, len(pendingJSON.FundingAssets), 1)
 
 	require.NotZero(t, pendingJSON.Capacity)
@@ -1040,12 +1034,6 @@ func haveFundingAsset(assetChannel *rfqmsg.JsonAssetChannel,
 func assertAssetChan(t *testing.T, src, dst *HarnessNode, fundingAmount uint64,
 	channelAssets []*taprpc.Asset) {
 
-	if src.Cfg.OldChannelFormat {
-		t.Logf("Skipping asset channel check for %s->%s, old format",
-			src.Cfg.Name, dst.Cfg.Name)
-		return
-	}
-
 	err := wait.NoError(func() error {
 		a, err := getChannelCustomData(src, dst)
 		if err != nil {
@@ -1153,8 +1141,7 @@ func getChannelCustomData(src, dst *HarnessNode) (*rfqmsg.JsonAssetChannel,
 
 	targetChan := assetChannels[0]
 
-	var assetData rfqmsg.JsonAssetChannel
-	err = json.Unmarshal(targetChan.CustomChannelData, &assetData)
+	assetData, err := parseChannelData(src, targetChan.CustomChannelData)
 	if err != nil {
 		return nil, fmt.Errorf("unable to unmarshal asset data: %w",
 			err)
@@ -1165,7 +1152,7 @@ func getChannelCustomData(src, dst *HarnessNode) (*rfqmsg.JsonAssetChannel,
 			len(assetData.FundingAssets))
 	}
 
-	return &assetData, nil
+	return assetData, nil
 }
 
 func getAssetChannelBalance(t *testing.T, node *HarnessNode, assetIDs [][]byte,
@@ -1272,8 +1259,9 @@ func assertChannelAssetBalanceWithDelta(t *testing.T, node *HarnessNode,
 
 	targetChan := fetchChannel(t, node, chanPoint)
 
-	var assetBalance rfqmsg.JsonAssetChannel
-	err := json.Unmarshal(targetChan.CustomChannelData, &assetBalance)
+	assetBalance, err := parseChannelData(
+		node, targetChan.CustomChannelData,
+	)
 	require.NoError(t, err)
 
 	require.Len(t, assetBalance.FundingAssets, 1)
@@ -1287,8 +1275,9 @@ func channelAssetBalance(t *testing.T, node *HarnessNode,
 
 	targetChan := fetchChannel(t, node, chanPoint)
 
-	var assetBalance rfqmsg.JsonAssetChannel
-	err := json.Unmarshal(targetChan.CustomChannelData, &assetBalance)
+	assetBalance, err := parseChannelData(
+		node, targetChan.CustomChannelData,
+	)
 	require.NoError(t, err)
 
 	require.GreaterOrEqual(t, len(assetBalance.FundingAssets), 1)
@@ -2312,9 +2301,8 @@ func defaultCoOpCloseBalanceCheck(t *testing.T, local, remote *HarnessNode,
 	var closedJsonChannel *rfqmsg.JsonAssetChannel
 	for _, closedChan := range closedChans.Channels {
 		if closedChan.ClosingTxHash == closeTx.TxHash().String() {
-			closedJsonChannel = &rfqmsg.JsonAssetChannel{}
-			err = json.Unmarshal(
-				closedChan.CustomChannelData, closedJsonChannel,
+			closedJsonChannel, err = parseChannelData(
+				local, closedChan.CustomChannelData,
 			)
 			require.NoError(t, err)
 
@@ -2977,8 +2965,7 @@ func newCloseExpiryInfo(t *testing.T, node *HarnessNode) forceCloseExpiryInfo {
 		cltvs[payHash] = htlc.ExpirationHeight
 	}
 
-	var assetData rfqmsg.JsonAssetChannel
-	err = json.Unmarshal(mainChan.CustomChannelData, &assetData)
+	assetData, err := parseChannelData(node, mainChan.CustomChannelData)
 	require.NoError(t, err)
 
 	return forceCloseExpiryInfo{
@@ -3092,8 +3079,9 @@ func assertPendingChannelAssetData(t *testing.T, node *HarnessNode,
 				"custom channel data", targetChanPointStr)
 		}
 
-		var closeData rfqmsg.JsonAssetChannel
-		err = json.Unmarshal(targetChan.CustomChannelData, &closeData)
+		closeData, err := parseChannelData(
+			node, targetChan.CustomChannelData,
+		)
 		if err != nil {
 			return fmt.Errorf("error unmarshalling custom channel "+
 				"data: %v", err)
@@ -3191,8 +3179,7 @@ func assertClosedChannelAssetData(t *testing.T, node *HarnessNode,
 	require.NotNil(t, closedChan)
 	require.NotEmpty(t, closedChan.CustomChannelData)
 
-	var closeData rfqmsg.JsonAssetChannel
-	err = json.Unmarshal(closedChan.CustomChannelData, &closeData)
+	closeData, err := parseChannelData(node, closedChan.CustomChannelData)
 	require.NoError(t, err)
 
 	require.GreaterOrEqual(t, len(closeData.FundingAssets), 1)
@@ -3643,3 +3630,53 @@ func assertForceCloseSweeps(ctx context.Context, net *NetworkHarness,
 
 	return aliceExpectedBalance, bobExpectedBalance
 }
+
+// oldJsonAssetChanInfo is a struct that represents the old channel information
+// of a single asset within a channel, as it looked for litd v0.14.1 and before.
+type oldJsonAssetChanInfo struct {
+	AssetInfo     rfqmsg.JsonAssetUtxo `json:"asset_utxo"`
+	Capacity      uint64               `json:"capacity"`
+	LocalBalance  uint64               `json:"local_balance"`
+	RemoteBalance uint64               `json:"remote_balance"`
+}
+
+// oldJsonAssetChannel is a struct that represents the old channel information
+// of all assets within a channel, as it looked for litd v0.14.1 and before.
+type oldJsonAssetChannel struct {
+	Assets []oldJsonAssetChanInfo `json:"assets"`
+}
+
+// parseChannelData parses the given channel data into a rfqmsg.JsonAssetChannel
+// struct. It can deal with the old (litd v0.14.1 and before) and new (litd
+// v0.15.0 and after) channel data formats.
+func parseChannelData(node *HarnessNode,
+	data []byte) (*rfqmsg.JsonAssetChannel, error) {
+
+	var closeData rfqmsg.JsonAssetChannel
+	if node.Cfg.OldChannelFormat {
+		var oldData oldJsonAssetChannel
+		err := json.Unmarshal(data, &oldData)
+		if err != nil {
+			return nil, fmt.Errorf("error unmarshalling old "+
+				"channel data: %w", err)
+		}
+
+		oldAsset := oldData.Assets[0]
+		closeData.FundingAssets = []rfqmsg.JsonAssetUtxo{
+			oldAsset.AssetInfo,
+		}
+		closeData.Capacity = oldAsset.Capacity
+		closeData.LocalBalance = oldAsset.LocalBalance
+		closeData.RemoteBalance = oldAsset.RemoteBalance
+
+		return &closeData, nil
+	}
+
+	err := json.Unmarshal(data, &closeData)
+	if err != nil {
+		return nil, fmt.Errorf("error unmarshalling channel data: %w",
+			err)
+	}
+
+	return &closeData, nil
+}

itest/litd_test_list_on_test.go

@@ -138,4 +138,13 @@ var allTestCases = []*testCase{
 		test:       testCustomChannelsMultiChannelPathfinding,
 		noAliceBob: true,
 	},
+	{
+		name: "custom channels self-payment backward " +
+			"compatibility",
+		test:       testCustomChannelsSelfPayment,
+		noAliceBob: true,
+		backwardCompat: map[string]string{
+			"Alice": "v0.14.1-alpha",
+		},
+	},
 }