routing+migration32: update MC encoding to use pure TLV

In this commit, we update an existing migration which at the time of
writing has not been included in a release. We update it so that it
converts the format used for MissionControl result encoding to use pure
TLV instead. The 3 structs that have been updated are: `mcHop`,
`mcRoute` and `paymentResult`.

channeldb/migration32/migration_test.go

@@ -9,6 +9,7 @@ import (
 	lnwire "github.com/lightningnetwork/lnd/channeldb/migration/lnwire21"
 	"github.com/lightningnetwork/lnd/channeldb/migtest"
 	"github.com/lightningnetwork/lnd/kvdb"
+	"github.com/lightningnetwork/lnd/tlv"
 )
 
 var (
@@ -24,174 +25,206 @@ var (
 	_       = pubKeyY.SetByteSlice(pubkeyBytes)
 	pubkey  = btcec.NewPublicKey(new(btcec.FieldVal).SetInt(4), pubKeyY)
 
-	paymentResultCommon1 = paymentResultCommon{
+	customRecord = map[uint64][]byte{
+		65536: {4, 2, 2},
+	}
+
+	resultOld1 = paymentResultOld{
 		id:               0,
 		timeFwd:          time.Unix(0, 1),
 		timeReply:        time.Unix(0, 2),
 		success:          false,
 		failureSourceIdx: &failureIndex,
 		failure:          &lnwire.FailFeeInsufficient{},
+		route: &Route{
+			TotalTimeLock: 100,
+			TotalAmount:   400,
+			SourcePubKey:  testPub,
+			Hops: []*Hop{
+				// A hop with MPP, AMP and custom
+				// records.
+				{
+					PubKeyBytes:      testPub,
+					ChannelID:        100,
+					OutgoingTimeLock: 300,
+					AmtToForward:     500,
+					MPP: &MPP{
+						paymentAddr: [32]byte{4, 5},
+						totalMsat:   900,
+					},
+					AMP: &AMP{
+						rootShare:  [32]byte{0, 0},
+						setID:      [32]byte{5, 5, 5},
+						childIndex: 90,
+					},
+					CustomRecords: customRecord,
+					Metadata:      []byte{6, 7, 7},
+				},
+				// A legacy hop.
+				{
+					PubKeyBytes:      testPub,
+					ChannelID:        800,
+					OutgoingTimeLock: 4,
+					AmtToForward:     4,
+					LegacyPayload:    true,
+				},
+				// A hop with a blinding key.
+				{
+					PubKeyBytes:      testPub,
+					ChannelID:        800,
+					OutgoingTimeLock: 4,
+					AmtToForward:     4,
+					BlindingPoint:    pubkey,
+					EncryptedData:    []byte{1, 2, 3},
+					TotalAmtMsat:     600,
+				},
+				// A hop with a blinding key and custom
+				// records.
+				{
+					PubKeyBytes:      testPub,
+					ChannelID:        800,
+					OutgoingTimeLock: 4,
+					AmtToForward:     4,
+					CustomRecords:    customRecord,
+					BlindingPoint:    pubkey,
+					EncryptedData:    []byte{1, 2, 3},
+					TotalAmtMsat:     600,
+				},
+			},
+		},
 	}
 
-	paymentResultCommon2 = paymentResultCommon{
+	resultOld2 = paymentResultOld{
 		id:        2,
 		timeFwd:   time.Unix(0, 4),
 		timeReply: time.Unix(0, 7),
 		success:   true,
-	}
-)
-
-// TestMigrateMCRouteSerialisation tests that the MigrateMCRouteSerialisation
-// migration function correctly migrates the MC store from using the old route
-// encoding to using the newer, more minimal route encoding.
-func TestMigrateMCRouteSerialisation(t *testing.T) {
-	customRecord := map[uint64][]byte{
-		65536: {4, 2, 2},
-	}
-
-	resultsOld := []*paymentResultOld{
-		{
-			paymentResultCommon: paymentResultCommon1,
-			route: &Route{
-				TotalTimeLock: 100,
-				TotalAmount:   400,
-				SourcePubKey:  testPub,
-				Hops: []*Hop{
-					// A hop with MPP, AMP and custom
-					// records.
-					{
-						PubKeyBytes:      testPub,
-						ChannelID:        100,
-						OutgoingTimeLock: 300,
-						AmtToForward:     500,
-						MPP: &MPP{
-							paymentAddr: [32]byte{
-								4, 5,
-							},
-							totalMsat: 900,
-						},
-						AMP: &AMP{
-							rootShare: [32]byte{
-								0, 0,
-							},
-							setID: [32]byte{
-								5, 5, 5,
-							},
-							childIndex: 90,
-						},
-						CustomRecords: customRecord,
-						Metadata:      []byte{6, 7, 7},
-					},
-					// A legacy hop.
-					{
-						PubKeyBytes:      testPub,
-						ChannelID:        800,
-						OutgoingTimeLock: 4,
-						AmtToForward:     4,
-						LegacyPayload:    true,
-					},
-					// A hop with a blinding key.
-					{
-						PubKeyBytes:      testPub,
-						ChannelID:        800,
-						OutgoingTimeLock: 4,
-						AmtToForward:     4,
-						BlindingPoint:    pubkey,
-						EncryptedData: []byte{
-							1, 2, 3,
-						},
-						TotalAmtMsat: 600,
-					},
-					// A hop with a blinding key and custom
-					// records.
-					{
-						PubKeyBytes:      testPub,
-						ChannelID:        800,
-						OutgoingTimeLock: 4,
-						AmtToForward:     4,
-						CustomRecords:    customRecord,
-						BlindingPoint:    pubkey,
-						EncryptedData: []byte{
-							1, 2, 3,
-						},
-						TotalAmtMsat: 600,
-					},
-				},
-			},
-		},
-		{
-			paymentResultCommon: paymentResultCommon2,
-			route: &Route{
-				TotalTimeLock: 101,
-				TotalAmount:   401,
-				SourcePubKey:  testPub2,
-				Hops: []*Hop{
-					{
-						PubKeyBytes:      testPub,
-						ChannelID:        800,
-						OutgoingTimeLock: 4,
-						AmtToForward:     4,
-						BlindingPoint:    pubkey,
-						EncryptedData: []byte{
-							1, 2, 3,
-						},
-						TotalAmtMsat: 600,
-					},
+		route: &Route{
+			TotalTimeLock: 101,
+			TotalAmount:   401,
+			SourcePubKey:  testPub2,
+			Hops: []*Hop{
+				{
+					PubKeyBytes:      testPub,
+					ChannelID:        800,
+					OutgoingTimeLock: 4,
+					AmtToForward:     4,
+					BlindingPoint:    pubkey,
+					EncryptedData:    []byte{1, 2, 3},
+					CustomRecords:    customRecord,
+					TotalAmtMsat:     600,
 				},
 			},
 		},
 	}
 
-	expectedResultsNew := []*paymentResultNew{
-		{
-			paymentResultCommon: paymentResultCommon1,
-			route: &mcRoute{
-				sourcePubKey: testPub,
-				totalAmount:  400,
-				hops: []*mcHop{
-					{
-						channelID:        100,
-						pubKeyBytes:      testPub,
-						amtToFwd:         500,
-						hasCustomRecords: true,
-					},
-					{
-						channelID:   800,
-						pubKeyBytes: testPub,
-						amtToFwd:    4,
-					},
-					{
-						channelID:        800,
-						pubKeyBytes:      testPub,
-						amtToFwd:         4,
-						hasBlindingPoint: true,
-					},
-					{
-						channelID:        800,
-						pubKeyBytes:      testPub,
-						amtToFwd:         4,
-						hasBlindingPoint: true,
-						hasCustomRecords: true,
-					},
+	resultNew1 = paymentResultNew{
+		id: 0,
+		timeFwd: tlv.NewPrimitiveRecord[tlv.TlvType1, uint64](
+			uint64(time.Unix(0, 1).UnixNano()),
+		),
+		timeReply: tlv.NewPrimitiveRecord[tlv.TlvType2, uint64](
+			uint64(time.Unix(0, 2).UnixNano()),
+		),
+		failureSourceIdx: tlv.SomeRecordT[tlv.TlvType5, uint8](
+			tlv.NewPrimitiveRecord[tlv.TlvType5, uint8](
+				uint8(failureIndex),
+			),
+		),
+		failure: tlv.SomeRecordT[tlv.TlvType6, failureMessage](
+			tlv.NewRecordT[tlv.TlvType6, failureMessage](
+				failureMessage{&lnwire.FailFeeInsufficient{}},
+			),
+		),
+		route: tlv.NewRecordT[tlv.TlvType3, mcRoute](mcRoute{
+			sourcePubKey: tlv.NewRecordT[tlv.TlvType0, Vertex](
+				testPub,
+			),
+			totalAmount: tlv.NewRecordT[tlv.TlvType1, lnwire.MilliSatoshi](400),
+			hops: tlv.NewRecordT[tlv.TlvType2, mcHops](mcHops{
+				{
+					channelID:   tlv.NewPrimitiveRecord[tlv.TlvType0, uint64](100),
+					pubKeyBytes: tlv.NewRecordT[tlv.TlvType1, Vertex](testPub),
+					amtToFwd:    tlv.NewPrimitiveRecord[tlv.TlvType2, lnwire.MilliSatoshi](500),
+					hasCustomRecords: tlv.SomeRecordT[tlv.TlvType4, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType4, lnwire.TrueBoolean](),
+					),
 				},
-			},
-		},
-		{
-			paymentResultCommon: paymentResultCommon2,
-			route: &mcRoute{
-				sourcePubKey: testPub2,
-				totalAmount:  401,
-				hops: []*mcHop{
-					{
-						channelID:        800,
-						pubKeyBytes:      testPub,
-						amtToFwd:         4,
-						hasBlindingPoint: true,
-					},
+				{
+					channelID:   tlv.NewPrimitiveRecord[tlv.TlvType0, uint64](800),
+					pubKeyBytes: tlv.NewRecordT[tlv.TlvType1, Vertex](testPub),
+					amtToFwd:    tlv.NewPrimitiveRecord[tlv.TlvType2, lnwire.MilliSatoshi](4),
 				},
-			},
-		},
+				{
+					channelID:   tlv.NewPrimitiveRecord[tlv.TlvType0, uint64](800),
+					pubKeyBytes: tlv.NewRecordT[tlv.TlvType1, Vertex](testPub),
+					amtToFwd:    tlv.NewPrimitiveRecord[tlv.TlvType2, lnwire.MilliSatoshi](4),
+					hasBlindingPoint: tlv.SomeRecordT[tlv.TlvType3, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType3, lnwire.TrueBoolean](),
+					),
+				},
+				{
+					channelID:   tlv.NewPrimitiveRecord[tlv.TlvType0, uint64](800),
+					pubKeyBytes: tlv.NewRecordT[tlv.TlvType1, Vertex](testPub),
+					amtToFwd:    tlv.NewPrimitiveRecord[tlv.TlvType2, lnwire.MilliSatoshi](4),
+					hasCustomRecords: tlv.SomeRecordT[tlv.TlvType4, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType4, lnwire.TrueBoolean](),
+					),
+					hasBlindingPoint: tlv.SomeRecordT[tlv.TlvType3, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType3, lnwire.TrueBoolean](),
+					),
+				},
+			}),
+		}),
+	}
+
+	resultNew2 = paymentResultNew{
+		id: 2,
+		timeFwd: tlv.NewPrimitiveRecord[tlv.TlvType1, uint64](
+			uint64(time.Unix(0, 4).UnixNano()),
+		),
+		timeReply: tlv.NewPrimitiveRecord[tlv.TlvType2, uint64](
+			uint64(time.Unix(0, 7).UnixNano()),
+		),
+		success: tlv.SomeRecordT[tlv.TlvType4, lnwire.TrueBoolean](
+			tlv.NewRecordT[tlv.TlvType4, lnwire.TrueBoolean](
+				lnwire.TrueBoolean{},
+			),
+		),
+		route: tlv.NewRecordT[tlv.TlvType3, mcRoute](mcRoute{
+			sourcePubKey: tlv.NewRecordT[tlv.TlvType0, Vertex](
+				testPub2,
+			),
+			totalAmount: tlv.NewRecordT[tlv.TlvType1, lnwire.MilliSatoshi](401),
+			hops: tlv.NewRecordT[tlv.TlvType2, mcHops](mcHops{
+				{
+					channelID:   tlv.NewPrimitiveRecord[tlv.TlvType0, uint64](800),
+					pubKeyBytes: tlv.NewRecordT[tlv.TlvType1, Vertex](testPub),
+					amtToFwd:    tlv.NewPrimitiveRecord[tlv.TlvType2, lnwire.MilliSatoshi](4),
+					hasCustomRecords: tlv.SomeRecordT[tlv.TlvType4, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType4, lnwire.TrueBoolean](),
+					),
+					hasBlindingPoint: tlv.SomeRecordT[tlv.TlvType3, lnwire.TrueBoolean](
+						tlv.ZeroRecordT[tlv.TlvType3, lnwire.TrueBoolean](),
+					),
+				},
+			}),
+		}),
 	}
+)
+
+// TestMigrateMCRouteSerialisation tests that the MigrateMCRouteSerialisation
+// migration function correctly migrates the MC store from using the old route
+// encoding to using the newer, more minimal route encoding.
+func TestMigrateMCRouteSerialisation(t *testing.T) {
+	var (
+		resultsOld = []*paymentResultOld{
+			&resultOld1, &resultOld2,
+		}
+		expectedResultsNew = []*paymentResultNew{
+			&resultNew1, &resultNew2,
+		}
+	)
 
 	// Prime the database with some mission control data that uses the
 	// old route encoding.