multi: remove deprecated RPCs and config flags scheduled for 0.21#10795
multi: remove deprecated RPCs and config flags scheduled for 0.21#10795erickcestari wants to merge 7 commits intolightningnetwork:masterfrom
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request completes the deprecation cycle for several RPCs, configuration flags, and fields that were announced for removal in the 0.20 release. By removing these legacy components, the codebase is simplified and technical debt is reduced, while ensuring that users migrate to the more robust V2 alternatives. Highlights
New Features🧠 You can now enable Memory (public preview) to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
github-actions
Bot
added
the
severity-critical
🔴 PR Severity: CRITICAL
🔴 Critical (2 files)
🟠 High (3 files, plus 7 auto-generated excluded from count)
🟡 Medium (9 files)
🟢 Low (7 files — excluded from severity calculation)
AnalysisThis PR touches Even though most changes are deletions (3,055 deletions vs. 423 additions, net reduction of ~2,632 lines), removing RPC handlers from the core server warrants careful expert review to ensure no active functionality is inadvertently dropped and that all call sites have been migrated. The >500 non-test/non-generated lines changed threshold for a severity bump is met (~1,473 lines), but the PR is already at the maximum CRITICAL level. To override, add a |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request removes deprecated Tor v2 support and several legacy payment and tracking RPCs, including SendPayment, SendPaymentSync, SendToRoute, and TrackPayment, along with associated configuration flags and test cases. The changes simplify the codebase by removing obsolete logic and updating integration tests to use V2 RPC equivalents. Review feedback suggests moving the QueryProbability function to router_server.go and deleting the now-redundant router_server_deprecated.go file, while also improving the function's documentation to comply with the LND style guide for exported functions.
| // QueryProbability returns the current success probability estimate for a | ||
| // given node pair and amount. | ||
| func (s *Server) QueryProbability(_ context.Context, |
There was a problem hiding this comment.
The function QueryProbability is the only remaining function in this file. It should be moved to router_server.go and this file should be deleted. Additionally, as an exported function, it requires a more detailed comment for the caller per the LND style guide.
References
- Exported functions require detailed comments for the caller. (link)
erickcestari
force-pushed
the
remove-deprecated-rpcs-20
branch
2 times, most recently
from
b6c6036 to
74f5520
Compare
github-actions
Bot
added
severity-critical
Remove the compatibility fallback in QueryRoutes and ExtractPaymentIntent that accepted the deprecated single outgoing_chan_id field alongside the replacement outgoing_chan_ids. Callers must now use outgoing_chan_ids. Update TestQueryRoutes and TestExtractPaymentIntent accordingly.
Remove the --tor.v2 config flag and all associated handling. Tor v2 onion services have been obsolete since October 2021 when the Tor network dropped support for them. Update config.go, lnd.go, and server.go to assume v3 when a tor hidden service is configured.
Remove SendToRoute and SendToRouteSync helpers from the test harness and update integration tests to use routerrpc.SendToRouteV2: - lnd_routing_test.go: collapse three SendToRoute test cases (sync, stream, v2) into a single test using SendToRouteV2; update testSendToRouteErrorPropagation to assert on Failure.Code instead of PaymentError string - lnd_channel_policy_test.go: replace streaming SendToRoute with SendToRouteV2 and assert on HTLCAttempt.Failure instead of PaymentError string
Remove handler implementations and macaroon permission entries for the now-deleted lnrpc RPCs: SendPayment, SendPaymentSync, SendToRoute, and SendToRouteSync. Also remove the dead payment infrastructure that was exclusively used by these handlers: paymentStream, rpcPaymentRequest, rpcPaymentIntent, extractPaymentIntent, dispatchPaymentIntent, sendPayment, and sendPaymentSync.
…mpls Remove the SendPayment, SendToRoute, and TrackPayment shim methods from router_server_deprecated.go that delegated to their V2 counterparts. Remove their macaroon permission entries from router_server.go and the now-unused legacyTrackPaymentServer wrapper.
Remove the following deprecated RPC definitions that were announced for removal in 0.21 via the 0.20 release notes: lnrpc: - SendPayment (bidirectional streaming) - SendPaymentSync - SendToRoute (bidirectional streaming) - SendToRouteSync routerrpc: - SendPayment (streaming) - SendToRoute - TrackPayment (streaming) Also remove the now-unused PaymentState enum and PaymentStatus message that were only used by the deprecated TrackPayment response stream, plus the corresponding REST annotations from the yaml files. Regenerate all protobuf, gRPC, REST gateway, JSON, and swagger files.
…e notes Add entries to the Breaking Changes section of the 0.21 release notes covering the RPCs, fields, and config flags removed in this PR that were announced for removal in 0.21 via the 0.20 release notes.
erickcestari
force-pushed
the
remove-deprecated-rpcs-20
branch
from
74f5520 to
a99d010
Compare
1 participant
This PR removes the deprecated RPCs, fields, and configuration options that
were announced for removal in 0.21 via the
0.20 release notes.
Changes
Removed deprecated RPCs
The following RPCs are removed. Callers must migrate to the V2 equivalents
listed in the 0.20 release notes:
lnrpc.SendPayment(streaming)routerrpc.SendPaymentV2lnrpc.SendPaymentSyncrouterrpc.SendPaymentV2lnrpc.SendToRoute(streaming)routerrpc.SendToRouteV2lnrpc.SendToRouteSyncrouterrpc.SendToRouteV2routerrpc.SendPayment(streaming)routerrpc.SendPaymentV2routerrpc.SendToRouterouterrpc.SendToRouteV2routerrpc.TrackPayment(streaming)routerrpc.TrackPaymentV2This includes removing the corresponding REST gateway routes:
POST /v1/channels/transaction-streamPOST /v1/channels/transactionsPOST /v1/channels/transactions/routeRemoved deprecated
OutgoingChanIdfieldThe single-channel
outgoing_chan_idfield onQueryRoutesRequestandSendPaymentRequestis no longer honored. Callers must use the multi-channeloutgoing_chan_idsfield introduced in 0.20.The compatibility fallback that accepted either field (and errored when both
were set) is removed from the routerrpc backend.
Removed deprecated tor v2 support
The
--tor.v2configuration flag is removed. Tor v2 onion services have beenobsolete since October 2021 when the Tor network dropped support for them.
The hidden service setup paths in
config.go,lnd.go, andserver.goaresimplified to assume v3 whenever a hidden service is configured.
Internal cleanups
rpcserver.gothat wasexclusively used by the deleted lnrpc handlers:
paymentStream,rpcPaymentRequest,rpcPaymentIntent,extractPaymentIntent,dispatchPaymentIntent,sendPayment, andsendPaymentSync(~640 lines).legacyTrackPaymentServerwrapper,PaymentStateenum, andPaymentStatusmessage that were only used by the deletedrouterrpc.TrackPaymentstream.SendToRouteandSendToRouteSynchelpers from the integrationtest harness.
Test changes
itest/lnd_routing_test.go: collapsed threeSendToRoutetest cases (sync,stream, v2) into a single test exercising
SendToRouteV2. Updated the errorpropagation test to assert on
HTLCAttempt.Failure.Codeinstead of thelegacy
PaymentErrorstring.itest/lnd_channel_policy_test.go: migrated from streamingSendToRoutetoSendToRouteV2with structured failure assertions.lnrpc/routerrpc/router_backend_test.go: removed thesingleChanIDandbothChanIdstest variants that exercised the deprecated single-field pathand its conflict detection.
Commits
The PR is split into six logical commits:
proto: remove deprecated SendPayment, SendToRoute, TrackPayment RPCs- allproto, yaml, and regenerated stub files
lnrpc: remove deprecated Send* RPC server implementations- server-sidehandlers and dead payment infrastructure in
rpcserver.gorouterrpc: remove deprecated SendPayment, SendToRoute, TrackPayment impls-server-side shims and macaroon entries
routerrpc: remove deprecated outgoing_chan_id field handling- backendcompatibility fallback removal
lncfg: remove deprecated tor v2 support- tor v2 config flag removalitest: migrate deprecated lnrpc Send* calls to routerrpc V2- test harnessand integration test updates
Breaking changes
This is a breaking change for any client that still uses the deprecated RPCs,
fields, or config flag listed above. All have had V2 / replacement equivalents
available for multiple releases.