routing: remove paymentResult pointer

This is done to unambiguously let newPaymentFailure construct a concrete
payment failure. newPaymentResult is update to give it an optional
payment failure that can distinguis the success and failure cases.

Author: bitromortac

channeldb/migration32/migration_test.go

@@ -208,7 +208,7 @@ var (
 		),
 		failure: tlv.SomeRecordT(
 			tlv.NewRecordT[tlv.TlvType3](
-				*newPaymentFailure(
+				newPaymentFailure(
 					&failureIndex,
 					&lnwire.FailFeeInsufficient{},
 				),
@@ -255,7 +255,7 @@ var (
 		),
 		failure: tlv.SomeRecordT(
 			tlv.NewRecordT[tlv.TlvType3](
-				*newPaymentFailure(
+				newPaymentFailure(
 					&failureIndex, nil,
 				),
 			),

channeldb/migration32/mission_control_store.go

@@ -93,9 +93,12 @@ func deserializeOldResult(k, v []byte) (*paymentResultOld, error) {
 
 // convertPaymentResult converts a paymentResultOld to a paymentResultNew.
 func convertPaymentResult(old *paymentResultOld) *paymentResultNew {
-	var failure *paymentFailure
+	var failure fn.Option[paymentFailure]
 	if !old.success {
-		failure = newPaymentFailure(old.failureSourceIdx, old.failure)
+		failure = fn.Some(newPaymentFailure(
+			old.failureSourceIdx,
+			old.failure,
+		))
 	}
 
 	return newPaymentResult(
@@ -106,7 +109,7 @@ func convertPaymentResult(old *paymentResultOld) *paymentResultNew {
 
 // newPaymentResult constructs a new paymentResult.
 func newPaymentResult(id uint64, rt *mcRoute, timeFwd, timeReply time.Time,
-	failure *paymentFailure) *paymentResultNew {
+	failure fn.Option[paymentFailure]) *paymentResultNew {
 
 	result := &paymentResultNew{
 		id: id,
@@ -119,11 +122,11 @@ func newPaymentResult(id uint64, rt *mcRoute, timeFwd, timeReply time.Time,
 		route: tlv.NewRecordT[tlv.TlvType2](*rt),
 	}
 
-	if failure != nil {
+	failure.WhenSome(func(f paymentFailure) {
 		result.failure = tlv.SomeRecordT(
-			tlv.NewRecordT[tlv.TlvType3](*failure),
+			tlv.NewRecordT[tlv.TlvType3](f),
 		)
-	}
+	})
 
 	return result
 }
@@ -153,10 +156,10 @@ type paymentFailure struct {
 // failure with unknown details. Otherwise, the index and failure message are
 // used to populate the info field of the paymentFailure.
 func newPaymentFailure(sourceIdx *int,
-	failureMsg lnwire.FailureMessage) *paymentFailure {
+	failureMsg lnwire.FailureMessage) paymentFailure {
 
 	if sourceIdx == nil {
-		return &paymentFailure{}
+		return paymentFailure{}
 	}
 
 	info := paymentFailureInfo{
@@ -166,7 +169,7 @@ func newPaymentFailure(sourceIdx *int,
 		msg: tlv.NewRecordT[tlv.TlvType1](failureMessage{failureMsg}),
 	}
 
-	return &paymentFailure{
+	return paymentFailure{
 		info: tlv.SomeRecordT(tlv.NewRecordT[tlv.TlvType0](info)),
 	}
 }

routing/missioncontrol.go

@@ -276,7 +276,7 @@ type paymentResult struct {
 
 // newPaymentResult constructs a new paymentResult.
 func newPaymentResult(id uint64, rt *mcRoute, timeFwd, timeReply time.Time,
-	failure *paymentFailure) *paymentResult {
+	failure fn.Option[paymentFailure]) *paymentResult {
 
 	result := &paymentResult{
 		id: id,
@@ -289,11 +289,11 @@ func newPaymentResult(id uint64, rt *mcRoute, timeFwd, timeReply time.Time,
 		route: tlv.NewRecordT[tlv.TlvType2](*rt),
 	}
 
-	if failure != nil {
+	failure.WhenSome(func(f paymentFailure) {
 		result.failure = tlv.SomeRecordT(
-			tlv.NewRecordT[tlv.TlvType3](*failure),
+			tlv.NewRecordT[tlv.TlvType3](f),
 		)
-	}
+	})
 
 	return result
 }
@@ -621,7 +621,7 @@ func (m *MissionControl) ReportPaymentFail(paymentID uint64, rt *route.Route,
 
 	result := newPaymentResult(
 		paymentID, extractMCRoute(rt), timestamp, timestamp,
-		newPaymentFailure(failureSourceIdx, failure),
+		fn.Some(newPaymentFailure(failureSourceIdx, failure)),
 	)
 
 	return m.processPaymentResult(result)
@@ -635,7 +635,8 @@ func (m *MissionControl) ReportPaymentSuccess(paymentID uint64,
 	timestamp := m.cfg.clock.Now()
 
 	result := newPaymentResult(
-		paymentID, extractMCRoute(rt), timestamp, timestamp, nil,
+		paymentID, extractMCRoute(rt), timestamp, timestamp,
+		fn.None[paymentFailure](),
 	)
 
 	_, err := m.processPaymentResult(result)
@@ -838,10 +839,10 @@ type paymentFailure struct {
 // failure with unknown details. Otherwise, the index and failure message are
 // used to populate the info field of the paymentFailure.
 func newPaymentFailure(sourceIdx *int,
-	failureMsg lnwire.FailureMessage) *paymentFailure {
+	failureMsg lnwire.FailureMessage) paymentFailure {
 
 	if sourceIdx == nil {
-		return &paymentFailure{}
+		return paymentFailure{}
 	}
 
 	info := paymentFailureInfo{
@@ -851,7 +852,7 @@ func newPaymentFailure(sourceIdx *int,
 		msg: tlv.NewRecordT[tlv.TlvType1](failureMessage{failureMsg}),
 	}
 
-	return &paymentFailure{
+	return paymentFailure{
 		info: tlv.SomeRecordT(tlv.NewRecordT[tlv.TlvType0](info)),
 	}
 }

routing/missioncontrol_store_test.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/btcsuite/btcwallet/walletdb"
+	"github.com/lightningnetwork/lnd/fn/v2"
 	"github.com/lightningnetwork/lnd/kvdb"
 	"github.com/lightningnetwork/lnd/lntest/wait"
 	"github.com/lightningnetwork/lnd/lnwire"
@@ -85,19 +86,19 @@ func TestMissionControlStore(t *testing.T) {
 
 	result1 := newPaymentResult(
 		99, mcStoreTestRoute, testTime, testTime,
-		newPaymentFailure(
+		fn.Some(newPaymentFailure(
 			&failureSourceIdx,
 			lnwire.NewFailIncorrectDetails(100, 1000),
-		),
+		)),
 	)
 
 	result2 := newPaymentResult(
 		2, mcStoreTestRoute, testTime.Add(time.Hour),
 		testTime.Add(time.Hour),
-		newPaymentFailure(
+		fn.Some(newPaymentFailure(
 			&failureSourceIdx,
 			lnwire.NewFailIncorrectDetails(100, 1000),
-		),
+		)),
 	)
 
 	// Store result.
@@ -134,7 +135,7 @@ func TestMissionControlStore(t *testing.T) {
 	)
 	result3.id = 3
 	result3.failure = tlv.SomeRecordT(
-		tlv.NewRecordT[tlv.TlvType3](*newPaymentFailure(
+		tlv.NewRecordT[tlv.TlvType3](newPaymentFailure(
 			&failureSourceIdx, &lnwire.FailMPPTimeout{},
 		)),
 	)
@@ -153,7 +154,7 @@ func TestMissionControlStore(t *testing.T) {
 	// Also demonstrate the persistence of a success result.
 	result4 := newPaymentResult(
 		5, mcStoreTestRoute, testTime.Add(3*time.Hour),
-		testTime.Add(3*time.Hour), nil,
+		testTime.Add(3*time.Hour), fn.None[paymentFailure](),
 	)
 	store.AddResult(result4)
 	require.NoError(t, store.storeResults())
@@ -186,7 +187,10 @@ func TestMissionControlStoreFlushing(t *testing.T) {
 		return newPaymentResult(
 			lastID, mcStoreTestRoute, testTime.Add(-time.Hour),
 			testTime,
-			newPaymentFailure(&failureSourceIdx, failureDetails),
+			fn.Some(newPaymentFailure(
+				&failureSourceIdx,
+				failureDetails,
+			)),
 		)
 	}
 
@@ -287,10 +291,10 @@ func BenchmarkMissionControlStoreFlushing(b *testing.B) {
 				result := newPaymentResult(
 					lastID, mcStoreTestRoute, testTimeFwd,
 					testTime,
-					newPaymentFailure(
+					fn.Some(newPaymentFailure(
 						&failureSourceIdx,
 						failureDetails,
-					),
+					)),
 				)
 				store.AddResult(result)
 			}
@@ -305,10 +309,10 @@ func BenchmarkMissionControlStoreFlushing(b *testing.B) {
 				results[i] = newPaymentResult(
 					0, mcStoreTestRoute, testTimeFwd,
 					testTime,
-					newPaymentFailure(
+					fn.Some(newPaymentFailure(
 						&failureSourceIdx,
 						failureDetails,
-					),
+					)),
 				)
 			}
 

routing/result_interpretation_test.go

@@ -732,7 +732,7 @@ func TestResultInterpretation(t *testing.T) {
 		t.Run(testCase.name, func(t *testing.T) {
 			var failure fn.Option[paymentFailure]
 			if !testCase.success {
-				failure = fn.Some(*newPaymentFailure(
+				failure = fn.Some(newPaymentFailure(
 					&testCase.failureSrcIdx,
 					testCase.failure,
 				))