Merge pull request #8791 from ellemouton/assumeTLV

routing: assume TLV onion feature bit

Author: ellemouton

docs/release-notes/release-notes-0.18.1.md

@@ -79,6 +79,11 @@
 
 # Technical and Architectural Updates
 ## BOLT Spec Updates
+
+* Start assuming that all hops used during path-finding and route construction
+  [support the TLV onion 
+  format](https://github.com/lightningnetwork/lnd/pull/8791).
+
 ## Testing
 ## Database
 ## Code Health
@@ -88,5 +93,6 @@
 
 * Andras Banki-Horvath
 * Bufo
+* Elle Mouton
 * Matheus Degiovani
 * Slyghtning

routing/additional_edge.go

@@ -25,15 +25,15 @@ type AdditionalEdge interface {
 	// additional edge when being an intermediate hop in a route NOT the
 	// final hop.
 	IntermediatePayloadSize(amount lnwire.MilliSatoshi, expiry uint32,
-		legacy bool, channelID uint64) uint64
+		channelID uint64) uint64
 
 	// EdgePolicy returns the policy of the additional edge.
 	EdgePolicy() *models.CachedEdgePolicy
 }
 
 // PayloadSizeFunc defines the interface for the payload size function.
 type PayloadSizeFunc func(amount lnwire.MilliSatoshi, expiry uint32,
-	legacy bool, channelID uint64) uint64
+	channelID uint64) uint64
 
 // PrivateEdge implements the AdditionalEdge interface. As the name implies it
 // is used for private route hints that the receiver adds for example to an
@@ -50,12 +50,11 @@ func (p *PrivateEdge) EdgePolicy() *models.CachedEdgePolicy {
 // IntermediatePayloadSize returns the sphinx payload size defined in BOLT04 if
 // this edge were to be included in a route.
 func (p *PrivateEdge) IntermediatePayloadSize(amount lnwire.MilliSatoshi,
-	expiry uint32, legacy bool, channelID uint64) uint64 {
+	expiry uint32, channelID uint64) uint64 {
 
 	hop := route.Hop{
 		AmtToForward:     amount,
 		OutgoingTimeLock: expiry,
-		LegacyPayload:    legacy,
 	}
 
 	return hop.PayloadSize(channelID)
@@ -77,11 +76,10 @@ func (b *BlindedEdge) EdgePolicy() *models.CachedEdgePolicy {
 // IntermediatePayloadSize returns the sphinx payload size defined in BOLT04 if
 // this edge were to be included in a route.
 func (b *BlindedEdge) IntermediatePayloadSize(_ lnwire.MilliSatoshi, _ uint32,
-	_ bool, _ uint64) uint64 {
+	_ uint64) uint64 {
 
 	hop := route.Hop{
 		BlindingPoint: b.blindingPoint,
-		LegacyPayload: false,
 		EncryptedData: b.cipherText,
 	}
 
@@ -97,11 +95,11 @@ var _ AdditionalEdge = (*BlindedEdge)(nil)
 // defaultHopPayloadSize is the default payload size of a normal (not-blinded)
 // hop in the route.
 func defaultHopPayloadSize(amount lnwire.MilliSatoshi, expiry uint32,
-	legacy bool, channelID uint64) uint64 {
+	channelID uint64) uint64 {
 
 	// The payload size of a cleartext intermediate hop is equal to the
 	// payload size of a private edge therefore we reuse its size function.
 	edge := PrivateEdge{}
 
-	return edge.IntermediatePayloadSize(amount, expiry, legacy, channelID)
+	return edge.IntermediatePayloadSize(amount, expiry, channelID)
 }

routing/additional_edge_test.go

@@ -27,24 +27,12 @@ func TestIntermediatePayloadSize(t *testing.T) {
 		nextHop uint64
 		edge    AdditionalEdge
 	}{
-		{
-			name: "Legacy payload private edge",
-			hop: route.Hop{
-				AmtToForward:     1000,
-				OutgoingTimeLock: 600000,
-				ChannelID:        3432483437438,
-				LegacyPayload:    true,
-			},
-			nextHop: 1,
-			edge:    &PrivateEdge{},
-		},
 		{
 			name: "Tlv payload private edge",
 			hop: route.Hop{
 				AmtToForward:     1000,
 				OutgoingTimeLock: 600000,
 				ChannelID:        3432483437438,
-				LegacyPayload:    false,
 			},
 			nextHop: 1,
 			edge:    &PrivateEdge{},
@@ -86,7 +74,6 @@ func TestIntermediatePayloadSize(t *testing.T) {
 				IntermediatePayloadSize(
 					testCase.hop.AmtToForward,
 					testCase.hop.OutgoingTimeLock,
-					testCase.hop.LegacyPayload,
 					testCase.nextHop,
 				)
 

routing/blinding_test.go

@@ -202,10 +202,10 @@ func TestBlindedPaymentToHints(t *testing.T) {
 		// The arguments we use for the payload do not matter as long as
 		// both functions return the same payload.
 		expectedPayloadSize := expectedHint[0].IntermediatePayloadSize(
-			0, 0, false, 0,
+			0, 0, 0,
 		)
 		actualPayloadSize := actualHint[0].IntermediatePayloadSize(
-			0, 0, false, 0,
+			0, 0, 0,
 		)
 
 		require.Equal(t, expectedPayloadSize, actualPayloadSize)

routing/mocks.go

@@ -161,7 +161,6 @@ func newRoute(sourceVertex route.Vertex,
 			fee                 int64
 			totalAmtMsatBlinded lnwire.MilliSatoshi
 			outgoingTimeLock    uint32
-			tlvPayload          bool
 			customRecords       record.CustomSet
 			mpp                 *record.MPP
 			metadata            []byte
@@ -180,13 +179,6 @@ func newRoute(sourceVertex route.Vertex,
 			return edge.ToNodeFeatures.HasFeature(feature)
 		}
 
-		// We start by assuming the node doesn't support TLV. We'll now
-		// inspect the node's feature vector to see if we can promote
-		// the hop. We assume already that the feature vector's
-		// transitive dependencies have already been validated by path
-		// finding or some other means.
-		tlvPayload = supports(lnwire.TLVOnionPayloadOptional)
-
 		if i == len(pathEdges)-1 {
 			// If this is the last hop, then the hop payload will
 			// contain the exact amount. In BOLT #4: Onion Routing
@@ -204,12 +196,7 @@ func newRoute(sourceVertex route.Vertex,
 			totalTimeLock += uint32(finalHop.cltvDelta)
 			outgoingTimeLock = totalTimeLock
 
-			// Attach any custom records to the final hop if the
-			// receiver supports TLV.
-			if !tlvPayload && finalHop.records != nil {
-				return nil, errors.New("cannot attach " +
-					"custom records")
-			}
+			// Attach any custom records to the final hop.
 			customRecords = finalHop.records
 
 			// If we're attaching a payment addr but the receiver
@@ -275,7 +262,6 @@ func newRoute(sourceVertex route.Vertex,
 			ChannelID:        edge.ChannelID,
 			AmtToForward:     amtToForward,
 			OutgoingTimeLock: outgoingTimeLock,
-			LegacyPayload:    !tlvPayload,
 			CustomRecords:    customRecords,
 			MPP:              mpp,
 			Metadata:         metadata,
@@ -659,8 +645,7 @@ func findPath(g *graphParams, r *RestrictParams, cfg *PathFindingConfig,
 
 	// The payload size of the final hop differ from intermediate hops
 	// and depends on whether the destination is blinded or not.
-	lastHopPayloadSize := lastHopPayloadSize(r, finalHtlcExpiry, amt,
-		!features.HasFeature(lnwire.TLVOnionPayloadOptional))
+	lastHopPayloadSize := lastHopPayloadSize(r, finalHtlcExpiry, amt)
 
 	// We can't always assume that the end destination is publicly
 	// advertised to the network so we'll manually include the target node.
@@ -882,14 +867,10 @@ func findPath(g *graphParams, r *RestrictParams, cfg *PathFindingConfig,
 				return
 			}
 
-			supportsTlv := fromFeatures.HasFeature(
-				lnwire.TLVOnionPayloadOptional,
-			)
-
 			payloadSize = edge.hopPayloadSizeFn(
 				amountToSend,
 				uint32(toNodeDist.incomingCltv),
-				!supportsTlv, edge.policy.ChannelID,
+				edge.policy.ChannelID,
 			)
 		}
 
@@ -1176,7 +1157,7 @@ func getProbabilityBasedDist(weight int64, probability float64,
 // It depends on the tlv types which are present and also whether the hop is
 // part of a blinded route or not.
 func lastHopPayloadSize(r *RestrictParams, finalHtlcExpiry int32,
-	amount lnwire.MilliSatoshi, legacy bool) uint64 {
+	amount lnwire.MilliSatoshi) uint64 {
 
 	if r.BlindedPayment != nil {
 		blindedPath := r.BlindedPayment.BlindedPath.BlindedHops
@@ -1186,7 +1167,6 @@ func lastHopPayloadSize(r *RestrictParams, finalHtlcExpiry int32,
 		finalHop := route.Hop{
 			AmtToForward:     amount,
 			OutgoingTimeLock: uint32(finalHtlcExpiry),
-			LegacyPayload:    false,
 			EncryptedData:    encryptedData,
 		}
 		if len(blindedPath) == 1 {
@@ -1214,7 +1194,6 @@ func lastHopPayloadSize(r *RestrictParams, finalHtlcExpiry int32,
 		AmtToForward:     amount,
 		OutgoingTimeLock: uint32(finalHtlcExpiry),
 		CustomRecords:    r.DestCustomRecords,
-		LegacyPayload:    legacy,
 		MPP:              mpp,
 		AMP:              amp,
 		Metadata:         r.Metadata,