Merge pull request #9359 from NishantBansal2003/fix-timeout

guggero · web-flow · commit 27df4af53e8f · 2025-01-17T09:43:38.000-06:00
routerrpc: add a default value for timeout_seconds in SendPaymentV2
diff --git a/docs/release-notes/release-notes-0.19.0.md b/docs/release-notes/release-notes-0.19.0.md
@@ -94,6 +94,10 @@
   are now [sorted](https://github.com/lightningnetwork/lnd/pull/9337) based on
   the `InvoiceHTLC.HtlcIndex`.
 
+* [routerrpc.SendPaymentV2](https://github.com/lightningnetwork/lnd/pull/9359)
+  RPC method now applies a default timeout of 60 seconds when the
+  `timeout_seconds` field is not set or is explicitly set to 0.
+
 ## lncli Additions
 
 * [A pre-generated macaroon root key can now be specified in `lncli create` and
diff --git a/itest/lnd_amp_test.go b/itest/lnd_amp_test.go
@@ -118,7 +118,6 @@ func testSendPaymentAMPInvoiceCase(ht *lntest.HarnessTest,
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: addInvoiceResp.PaymentRequest,
 		PaymentAddr:    externalPayAddr,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		Amp:            true,
 	}
@@ -400,7 +399,6 @@ func testSendPaymentAMP(ht *lntest.HarnessTest) {
 		Dest:           mts.bob.PubKey[:],
 		Amt:            int64(paymentAmt),
 		FinalCltvDelta: chainreg.DefaultBitcoinTimeLockDelta,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		Amp:            true,
 	}
diff --git a/itest/lnd_channel_balance_test.go b/itest/lnd_channel_balance_test.go
@@ -150,7 +150,6 @@ func testChannelUnsettledBalance(ht *lntest.HarnessTest) {
 				Amt:            int64(payAmt),
 				PaymentHash:    ht.Random32Bytes(),
 				FinalCltvDelta: finalCltvDelta,
-				TimeoutSeconds: 60,
 				FeeLimitMsat:   noFeeLimitMsat,
 			}
 			ht.SendPaymentAssertInflight(alice, req)
diff --git a/itest/lnd_channel_force_close_test.go b/itest/lnd_channel_force_close_test.go
@@ -111,7 +111,6 @@ func runChannelForceClosureTest(ht *lntest.HarnessTest,
 			Amt:            int64(paymentAmt),
 			PaymentHash:    ht.Random32Bytes(),
 			FinalCltvDelta: finalCltvDelta,
-			TimeoutSeconds: 60,
 			FeeLimitMsat:   noFeeLimitMsat,
 		}
 		ht.SendPaymentAssertInflight(alice, req)
@@ -811,7 +810,6 @@ func testFailingChannel(ht *lntest.HarnessTest) {
 	// won't work as the channel cannot be found.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: resp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAndAssertStatus(alice, req, lnrpc.Payment_IN_FLIGHT)
diff --git a/itest/lnd_channel_policy_test.go b/itest/lnd_channel_policy_test.go
@@ -141,7 +141,6 @@ func testUpdateChannelPolicy(ht *lntest.HarnessTest) {
 	// not be able to find a path during routing.
 	payReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: resp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertFail(
diff --git a/itest/lnd_coop_close_with_htlcs_test.go b/itest/lnd_coop_close_with_htlcs_test.go
@@ -73,7 +73,6 @@ func coopCloseWithHTLCs(ht *lntest.HarnessTest) {
 	// HTLC for it.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: resp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitSat:    1000000,
 	}
 	ht.SendPaymentAndAssertStatus(bob, req, lnrpc.Payment_IN_FLIGHT)
@@ -166,7 +165,6 @@ func coopCloseWithHTLCsWithRestart(ht *lntest.HarnessTest) {
 	// for it.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: resp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitSat:    1000000,
 	}
 	ht.SendPaymentAndAssertStatus(bob, req, lnrpc.Payment_IN_FLIGHT)
diff --git a/itest/lnd_hold_invoice_force_test.go b/itest/lnd_hold_invoice_force_test.go
@@ -42,7 +42,6 @@ func testHoldInvoiceForceClose(ht *lntest.HarnessTest) {
 	// single htlc.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: bobInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
diff --git a/itest/lnd_hold_persistence_test.go b/itest/lnd_hold_persistence_test.go
@@ -108,7 +108,6 @@ func testHoldInvoicePersistence(ht *lntest.HarnessTest) {
 	for _, payReq := range payReqs {
 		req := &routerrpc.SendPaymentRequest{
 			PaymentRequest: payReq,
-			TimeoutSeconds: 60,
 			FeeLimitSat:    1000000,
 		}
 
diff --git a/itest/lnd_htlc_timeout_resolver_test.go b/itest/lnd_htlc_timeout_resolver_test.go
@@ -128,7 +128,6 @@ func testHtlcTimeoutResolverExtractPreimageRemote(ht *lntest.HarnessTest) {
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: eveInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -267,7 +266,6 @@ func testHtlcTimeoutResolverExtractPreimageLocal(ht *lntest.HarnessTest) {
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
diff --git a/itest/lnd_max_htlcs_test.go b/itest/lnd_max_htlcs_test.go
@@ -59,12 +59,11 @@ func testMaxHtlcPathfind(ht *lntest.HarnessTest) {
 	// We've hit our max remote htlcs, so we expect this payment to spin
 	// out dramatically with pathfinding.
 	sendReq := &routerrpc.SendPaymentRequest{
-		Amt:            1000,
-		Dest:           alice.PubKey[:],
-		TimeoutSeconds: 60,
-		FeeLimitSat:    1000000,
-		MaxParts:       10,
-		Amp:            true,
+		Amt:         1000,
+		Dest:        alice.PubKey[:],
+		FeeLimitSat: 1000000,
+		MaxParts:    10,
+		Amp:         true,
 	}
 	ht.SendPaymentAndAssertStatus(bob, sendReq, lnrpc.Payment_FAILED)
 
@@ -130,7 +129,6 @@ func acceptHoldInvoice(ht *lntest.HarnessTest, idx int, sender,
 
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitSat:    1000000,
 	}
 	payStream := sender.RPC.SendPayment(sendReq)
diff --git a/itest/lnd_misc_test.go b/itest/lnd_misc_test.go
@@ -178,7 +178,6 @@ func testSphinxReplayPersistence(ht *lntest.HarnessTest) {
 	// to the above generated invoice.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoiceResp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	payStream := fred.RPC.SendPayment(req)
@@ -607,7 +606,6 @@ func testRejectHTLC(ht *lntest.HarnessTest) {
 	// lnd with --rejecthtlc.
 	paymentReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: resp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertFail(
diff --git a/itest/lnd_mpp_test.go b/itest/lnd_mpp_test.go
@@ -63,7 +63,6 @@ func testSendMultiPathPayment(ht *lntest.HarnessTest) {
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: payReq,
 		MaxParts:       10,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	payment := ht.SendPaymentAssertSettled(mts.alice, sendReq)
diff --git a/itest/lnd_multi-hop-error-propagation_test.go b/itest/lnd_multi-hop-error-propagation_test.go
@@ -134,7 +134,6 @@ func testHtlcErrorPropagation(ht *lntest.HarnessTest) {
 		Dest:           carol.PubKey[:],
 		Amt:            payAmt,
 		FinalCltvDelta: int32(carolPayReq.CltvExpiry),
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		MaxParts:       1,
 	}
@@ -203,7 +202,6 @@ func testHtlcErrorPropagation(ht *lntest.HarnessTest) {
 		// 10k satoshis are expected.
 		Amt:            int64(htlcAmt.ToSatoshis()),
 		FinalCltvDelta: int32(carolPayReq.CltvExpiry),
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		MaxParts:       1,
 	}
@@ -251,7 +249,6 @@ func testHtlcErrorPropagation(ht *lntest.HarnessTest) {
 
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice2.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		MaxParts:       1,
 	}
@@ -287,7 +284,6 @@ func testHtlcErrorPropagation(ht *lntest.HarnessTest) {
 
 	sendReq = &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice3.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		MaxParts:       1,
 	}
@@ -336,7 +332,6 @@ func testHtlcErrorPropagation(ht *lntest.HarnessTest) {
 
 	req = &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		MaxParts:       1,
 	}
diff --git a/itest/lnd_multi-hop_force_close_test.go b/itest/lnd_multi-hop_force_close_test.go
@@ -372,7 +372,6 @@ func runLocalClaimOutgoingHTLC(ht *lntest.HarnessTest,
 		Amt:            int64(dustHtlcAmt),
 		PaymentHash:    dustPayHash,
 		FinalCltvDelta: finalCltvDelta,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		RouteHints:     routeHints,
 	}
@@ -383,7 +382,6 @@ func runLocalClaimOutgoingHTLC(ht *lntest.HarnessTest,
 		Amt:            int64(htlcAmt),
 		PaymentHash:    payHash,
 		FinalCltvDelta: finalCltvDelta,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		RouteHints:     routeHints,
 	}
@@ -726,7 +724,6 @@ func runMultiHopReceiverPreimageClaim(ht *lntest.HarnessTest,
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -1093,7 +1090,6 @@ func runLocalForceCloseBeforeHtlcTimeout(ht *lntest.HarnessTest,
 		Amt:            int64(htlcAmt),
 		PaymentHash:    payHash,
 		FinalCltvDelta: finalCltvDelta,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 		RouteHints:     routeHints,
 	}
@@ -1415,7 +1411,6 @@ func runRemoteForceCloseBeforeHtlcTimeout(ht *lntest.HarnessTest,
 
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -1685,7 +1680,6 @@ func runLocalClaimIncomingHTLC(ht *lntest.HarnessTest,
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -1998,7 +1992,6 @@ func runLocalClaimIncomingHTLCLeased(ht *lntest.HarnessTest,
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -2349,7 +2342,6 @@ func runLocalPreimageClaim(ht *lntest.HarnessTest,
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -2655,7 +2647,6 @@ func runLocalPreimageClaimLeased(ht *lntest.HarnessTest,
 	// will not immediately settle the payment.
 	req := &routerrpc.SendPaymentRequest{
 		PaymentRequest: carolInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertInflight(alice, req)
@@ -3104,7 +3095,6 @@ func runHtlcAggregation(ht *lntest.HarnessTest,
 	for _, carolInvoice := range carolInvoices {
 		req := &routerrpc.SendPaymentRequest{
 			PaymentRequest: carolInvoice.PaymentRequest,
-			TimeoutSeconds: 60,
 			FeeLimitMsat:   noFeeLimitMsat,
 		}
 		ht.SendPaymentAssertInflight(alice, req)
@@ -3114,7 +3104,6 @@ func runHtlcAggregation(ht *lntest.HarnessTest,
 	for _, aliceInvoice := range aliceInvoices {
 		req := &routerrpc.SendPaymentRequest{
 			PaymentRequest: aliceInvoice.PaymentRequest,
-			TimeoutSeconds: 60,
 			FeeLimitMsat:   noFeeLimitMsat,
 		}
 		ht.SendPaymentAssertInflight(carol, req)
diff --git a/itest/lnd_open_channel_test.go b/itest/lnd_open_channel_test.go
@@ -674,7 +674,6 @@ func testUpdateOnFunderPendingOpenChannels(ht *lntest.HarnessTest) {
 	// in-flight instead of being failed by Alice.
 	bobReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	bobStream := bob.RPC.SendPayment(bobReq)
@@ -750,7 +749,6 @@ func testUpdateOnFundeePendingOpenChannels(ht *lntest.HarnessTest) {
 	// in-flight instead of being failed by Bob.
 	aliceReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: bobInvoice.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	aliceStream := alice.RPC.SendPayment(aliceReq)
diff --git a/itest/lnd_payment_test.go b/itest/lnd_payment_test.go
@@ -1086,7 +1086,6 @@ func sendPaymentInterceptAndCancel(ht *lntest.HarnessTest,
 	go func() {
 		req := &routerrpc.SendPaymentRequest{
 			PaymentRequest: invoice.PaymentRequest,
-			TimeoutSeconds: 60,
 			FeeLimitSat:    100000,
 			Cancelable:     true,
 		}
diff --git a/itest/lnd_quiescence_test.go b/itest/lnd_quiescence_test.go
@@ -37,7 +37,6 @@ func testQuiescence(ht *lntest.HarnessTest) {
 		Amt:            100,
 		PaymentHash:    ht.Random32Bytes(),
 		FinalCltvDelta: finalCltvDelta,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 
diff --git a/itest/lnd_route_blinding_test.go b/itest/lnd_route_blinding_test.go
@@ -552,7 +552,6 @@ func (b *blindedForwardTest) drainCarolLiquidity(incoming bool) {
 	pmtClient := sendingNode.RPC.SendPayment(
 		&routerrpc.SendPaymentRequest{
 			PaymentRequest: invoice.PaymentRequest,
-			TimeoutSeconds: 60,
 		},
 	)
 
@@ -957,7 +956,6 @@ func testMPPToSingleBlindedPath(ht *lntest.HarnessTest) {
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoiceResp.PaymentRequest,
 		MaxParts:       10,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	payment := ht.SendPaymentAssertSettled(alice, sendReq)
@@ -1302,7 +1300,6 @@ func testMPPToMultipleBlindedPaths(ht *lntest.HarnessTest) {
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoiceResp.PaymentRequest,
 		MaxParts:       10,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   noFeeLimitMsat,
 	}
 	payment := ht.SendPaymentAssertSettled(alice, sendReq)
diff --git a/itest/lnd_routing_test.go b/itest/lnd_routing_test.go
@@ -1429,7 +1429,6 @@ func testRouteFeeCutoff(ht *lntest.HarnessTest) {
 
 		sendReq := &routerrpc.SendPaymentRequest{
 			PaymentRequest: invoiceResp.PaymentRequest,
-			TimeoutSeconds: 60,
 			FeeLimitMsat:   noFeeLimitMsat,
 		}
 		switch limit := feeLimit.Limit.(type) {
@@ -1529,7 +1528,6 @@ func testFeeLimitAfterQueryRoutes(ht *lntest.HarnessTest) {
 	invoiceResp := carol.RPC.AddInvoice(invoice)
 	sendReq := &routerrpc.SendPaymentRequest{
 		PaymentRequest: invoiceResp.PaymentRequest,
-		TimeoutSeconds: 60,
 		FeeLimitMsat:   0,
 	}
 
diff --git a/itest/lnd_single_hop_invoice_test.go b/itest/lnd_single_hop_invoice_test.go
@@ -85,8 +85,7 @@ func testSingleHopInvoice(ht *lntest.HarnessTest) {
 		DestCustomRecords: map[uint64][]byte{
 			record.KeySendType: keySendPreimage[:],
 		},
-		TimeoutSeconds: 60,
-		FeeLimitMsat:   noFeeLimitMsat,
+		FeeLimitMsat: noFeeLimitMsat,
 	}
 	ht.SendPaymentAssertSettled(alice, req)
 
diff --git a/itest/lnd_sweep_test.go b/itest/lnd_sweep_test.go
diff --git a/itest/lnd_trackpayments_test.go b/itest/lnd_trackpayments_test.go
diff --git a/itest/lnd_watchtower_test.go b/itest/lnd_watchtower_test.go
diff --git a/lnrpc/routerrpc/router.pb.go b/lnrpc/routerrpc/router.pb.go
diff --git a/lnrpc/routerrpc/router.proto b/lnrpc/routerrpc/router.proto
diff --git a/lnrpc/routerrpc/router.swagger.json b/lnrpc/routerrpc/router.swagger.json
diff --git a/lnrpc/routerrpc/router_backend.go b/lnrpc/routerrpc/router_backend.go
diff --git a/lnrpc/routerrpc/router_server.go b/lnrpc/routerrpc/router_server.go

Original file line number	Diff line number	Diff line change
`@@ -150,7 +150,6 @@ func testChannelUnsettledBalance(ht *lntest.HarnessTest) {`
`150`	`150`	`Amt: int64(payAmt),`
`151`	`151`	`PaymentHash: ht.Random32Bytes(),`
`152`	`152`	`FinalCltvDelta: finalCltvDelta,`
`153`		`- TimeoutSeconds: 60,`
`154`	`153`	`FeeLimitMsat: noFeeLimitMsat,`
`155`	`154`	`}`
`156`	`155`	`ht.SendPaymentAssertInflight(alice, req)`
Original file line number	Diff line number	Diff line change
`@@ -141,7 +141,6 @@ func testUpdateChannelPolicy(ht *lntest.HarnessTest) {`
`141`	`141`	`// not be able to find a path during routing.`
`142`	`142`	`payReq := &routerrpc.SendPaymentRequest{`
`143`	`143`	`PaymentRequest: resp.PaymentRequest,`
`144`		`- TimeoutSeconds: 60,`
`145`	`144`	`FeeLimitMsat: noFeeLimitMsat,`
`146`	`145`	`}`
`147`	`146`	`ht.SendPaymentAssertFail(`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,6 @@ func testHoldInvoiceForceClose(ht *lntest.HarnessTest) {`
`42`	`42`	`// single htlc.`
`43`	`43`	`req := &routerrpc.SendPaymentRequest{`
`44`	`44`	`PaymentRequest: bobInvoice.PaymentRequest,`
`45`		`- TimeoutSeconds: 60,`
`46`	`45`	`FeeLimitMsat: noFeeLimitMsat,`
`47`	`46`	`}`
`48`	`47`	`ht.SendPaymentAssertInflight(alice, req)`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,6 @@ func testHoldInvoicePersistence(ht *lntest.HarnessTest) {`
`108`	`108`	`for _, payReq := range payReqs {`
`109`	`109`	`req := &routerrpc.SendPaymentRequest{`
`110`	`110`	`PaymentRequest: payReq,`
`111`		`- TimeoutSeconds: 60,`
`112`	`111`	`FeeLimitSat: 1000000,`
`113`	`112`	`}`
`114`	`113`