multi: Remove endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync` #8348

mohamedawnallah · 2024-01-06T18:22:13Z

Change Description

This pull request removes the deprecated endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync in lightning.proto, rpcserver.go, lntest/rpc/lnd.go, and its related test cases in itest/lnd_routing_test.go and itest/lnd_channel_policy_test.go.

Closes #8175

Notes

The actual removal for those endpoints in 0.21 release was based on the discussion in this PR #9456.

Steps to Test

I ran the test cases using make check to make sure there were no regressions and all the test cases passed.

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

…oroutesync`, and `sendpaymentsync`. This pull request removes the deprecated endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync` in `lightning.proto`, `rpcserver.go`, `lntest/rpc/lnd.go`, and its related test cases in `itest/lnd_routing_test.go` and `itest/lnd_channel_policy_test.go`. docs: Update release notes for 0.18.0 Added release note in version 0.18.0 to notify about the upcoming removal of deprecated endpoints (`sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync`). Referenced PR (lightningnetwork#8348) for more details.

mohamedawnallah · 2024-01-07T17:32:41Z

Hey @yyforyongyu, to keep you updated all the test cases are passed in the Travis CI run. That said we need to double check on those assertions:

mohamedawnallah · 2024-01-12T16:21:13Z

Hey, @yyforyongyu @guggero is there any way we can get this in? :)

yyforyongyu · 2024-01-15T04:31:32Z

@mohamedawnallah Thanks for the PR! As mentioned in the issue, we won't add this in the upcoming release so this will be marked as low priority atm.

coderabbitai · 2025-01-02T21:35:46Z

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)

llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

mohamedawnallah · 2025-01-03T00:41:06Z

Hi @yyforyongyu,

It seems that the LND v0.19 release is now on track, as I see in the LND projects dashboard. I've rebased onto the master branch and resolved the conflicts.

I would love to receive any feedback on that PR! 🙏

yyforyongyu · 2025-01-06T03:33:20Z

Thanks for keeping an eye on this! I'm thinking we can start noticing the users about the upcoming removal in 0.19.0, and then remove these dead endpoints in 0.20.0, but wanna hear more from @guggero and @saubyk.

saubyk · 2025-01-06T15:35:52Z

Thanks for keeping an eye on this! I'm thinking we can start noticing the users about the upcoming removal in 0.19.0, and then remove these dead endpoints in 0.20.0, but wanna hear more from @guggero and @saubyk.

+1 for notifying about the upcoming removal with 0.19 and removing in 0.20

ziggie1984 · 2025-01-21T22:35:13Z

I am also in favour of notifying the user in 19 and removing it in 20 (maybe in a msg. in the release notes). That being said I think we can move this PR in the LND 20 scope as a consequence.

bitromortac

I am also in favour of notifying the user in 19 and removing it in 20 (maybe in a msg. in the release notes). That being said I think we can move this PR in the LND 20 scope as a consequence.

I agree that we need to publicize this removal a bit more since the endpoints are quite important. Thank you for this work, @mohamedawnallah, could you open a separate PR to add an entry to the release notes of v0.19, to notify users about this planned change (we could use camel case for the notation for the endpoints, as they appear in https://lightning.engineering/api-docs/category/lightning-service/, I think that would make the warning more recognizable for developers)?

ziggie1984

Thanks for addressing this issue.

I think there is still more to deprecate:

We have a file called: router_server_deprecated.go which maps SendToRoute, SendPayment grpc calls to the newer versions, we should remove them as well in LND 20.

Moreover check all files whether there are some leftover descriptions of the old endpoints, for example in python.md we still reference the SendPayment stub which will not exist after this PR is merged:

for payment in stub.SendPayment(request_iterable):
    print(payment)

rpcserver.go

docs/release-notes/release-notes-0.19.0.md

lnrpc/lightning.proto

lnrpc/lightning.swagger.json

bitromortac · 2025-01-23T09:21:20Z

Just an idea that we could also try to figure out how many projects still use those endpoints, a starting point could be by looking through the dependents https://github.com/lightningnetwork/lnd/network/dependents?package_id=UGFja2FnZS0yMjY0ODI4ODY5, or searching for the endpoints, for example https://github.com/search?q=%22SendToRouteSync%22+language%3Ago&type=code.

guggero · 2025-01-23T09:34:10Z

So this PR now removes the listed endpoints and has 0.20 scope.
But I still think we need a PR for 0.19 that actually adds the deprecation warning? I'd say at least a comment in the lightning.proto file that will make it into the API docs, and then the corresponding section in the release notes.

mohamedawnallah · 2025-01-29T16:29:21Z

Thanks, @ziggie1984, for the code review. It seems this PR will be merged in release 0.21, where we remove the deprecated endpoints after the warning in #9456. ~~I'll address the feedback at the release version 0.21 time and request a review.~~ 🙏

EDIT:
I've addressed the feedback and added the release-note-0.21.0.md where the actual removal of those endpoints happens, given we have deprecated endpoint warnings in release-notes-0.20.md and release-notes-0.19.md.

lightninglabs-deploy · 2025-05-01T00:42:34Z

@mohamedawnallah, remember to re-request review from reviewers when ready

guggero · 2025-05-01T06:08:34Z

!lightninglabs-deploy mute

In this commit, we remove deprecated endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync`.

In this commit, we update the `SendPayment` gRPC server-streaming example to use routerrpc `SendPaymentV2` gRPC in `docs/grpc/python.md`.

In this commit, we update the `SendPayment` gRPC server-streaming example to use routerrpc `SendPaymentV2` in `docs/grpc/c#.md`.

mohamedawnallah mentioned this pull request Jan 6, 2024

lnd: remove deprecated endpoints sendpayment and sendtoroute #8175

Open

mohamedawnallah marked this pull request as draft January 6, 2024 19:31

mohamedawnallah marked this pull request as ready for review January 6, 2024 21:01

mohamedawnallah force-pushed the remove-deprecated-endpoints-sendpayment-and-sendtoroute branch 2 times, most recently from e6bc25f to 7314e6c Compare January 7, 2024 16:32

saubyk assigned mohamedawnallah Jan 15, 2024

mohamedawnallah force-pushed the remove-deprecated-endpoints-sendpayment-and-sendtoroute branch from 7314e6c to 922e59d Compare January 2, 2025 21:35

mohamedawnallah force-pushed the remove-deprecated-endpoints-sendpayment-and-sendtoroute branch from 922e59d to a1d795e Compare January 2, 2025 21:39

mohamedawnallah changed the title ~~lnd: remove deprecated endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync~~ multi: Replace endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync Jan 2, 2025

mohamedawnallah changed the title ~~multi: Replace endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync~~ multi: Deprecate endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync Jan 2, 2025

mohamedawnallah force-pushed the remove-deprecated-endpoints-sendpayment-and-sendtoroute branch from a1d795e to c4dfad6 Compare January 2, 2025 22:29

saubyk requested review from yyforyongyu and guggero January 6, 2025 15:34

saubyk added this to the v0.19.0 milestone Jan 6, 2025

saubyk requested review from bitromortac and removed request for guggero January 7, 2025 16:33

saubyk requested review from ziggie1984 and removed request for yyforyongyu January 21, 2025 17:43

saubyk modified the milestones: v0.19.0, v0.20.0 Jan 22, 2025

bitromortac reviewed Jan 22, 2025

View reviewed changes

ziggie1984 requested changes Jan 23, 2025

View reviewed changes

rpcserver.go Show resolved Hide resolved

docs/release-notes/release-notes-0.19.0.md Outdated Show resolved Hide resolved

lnrpc/lightning.proto Outdated Show resolved Hide resolved

lnrpc/lightning.swagger.json Show resolved Hide resolved

guggero changed the title ~~multi: Deprecate endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync~~ multi: Remove endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync Jan 23, 2025

mohamedawnallah mentioned this pull request Jan 29, 2025

lnrpc+docs: deprecate warning SendToRoute, SendToRouteSync, SendPayment, and SendPaymentSync in Release 0.19 #9456

Merged

8 tasks

saubyk added this to lnd v0.20 Mar 27, 2025

saubyk moved this to In progress in lnd v0.20 Mar 27, 2025

mohamedawnallah added 4 commits May 1, 2025 12:12

multi: remove deprecated endpoints

5af2b74

In this commit, we remove deprecated endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync`.

docs: update SendPayment server-stream py exampl

0bea515

In this commit, we update the `SendPayment` gRPC server-streaming example to use routerrpc `SendPaymentV2` gRPC in `docs/grpc/python.md`.

docs: update SendPayment server-stream c# exampl

17f71c8

In this commit, we update the `SendPayment` gRPC server-streaming example to use routerrpc `SendPaymentV2` in `docs/grpc/c#.md`.

docs: add release-notes-0-21.0 for rm endpoints

87156eb

mohamedawnallah force-pushed the remove-deprecated-endpoints-sendpayment-and-sendtoroute branch from c4dfad6 to 87156eb Compare May 1, 2025 12:36

mohamedawnallah requested review from ziggie1984 and bitromortac May 1, 2025 14:32

multi: Remove endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync #8348

Are you sure you want to change the base?

multi: Remove endpoints sendpayment, sendtoroute, sendtoroutesync, and sendpaymentsync #8348

Uh oh!

Conversation

mohamedawnallah commented Jan 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Description

Notes

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

Uh oh!

mohamedawnallah commented Jan 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mohamedawnallah commented Jan 12, 2024

Uh oh!

yyforyongyu commented Jan 15, 2024

Uh oh!

coderabbitai bot commented Jan 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

mohamedawnallah commented Jan 3, 2025

Uh oh!

yyforyongyu commented Jan 6, 2025

Uh oh!

saubyk commented Jan 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ziggie1984 commented Jan 21, 2025

Uh oh!

bitromortac left a comment

Choose a reason for hiding this comment

Uh oh!

ziggie1984 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bitromortac commented Jan 23, 2025

Uh oh!

guggero commented Jan 23, 2025

Uh oh!

mohamedawnallah commented Jan 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lightninglabs-deploy commented May 1, 2025

Uh oh!

guggero commented May 1, 2025

Uh oh!

Uh oh!

multi: Remove endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync` #8348

multi: Remove endpoints `sendpayment`, `sendtoroute`, `sendtoroutesync`, and `sendpaymentsync` #8348

mohamedawnallah commented Jan 6, 2024 •

edited

Loading

mohamedawnallah commented Jan 7, 2024 •

edited

Loading

coderabbitai bot commented Jan 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

saubyk commented Jan 6, 2025 •

edited

Loading

mohamedawnallah commented Jan 29, 2025 •

edited

Loading