lnd icon indicating copy to clipboard operation
lnd copied to clipboard

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

Open mohamedawnallah opened this issue 1 year ago • 14 comments
trafficstars

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

📝 Please see our Contribution Guidelines for further guidance.

mohamedawnallah avatar Jan 06 '24 18:01 mohamedawnallah

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 avatar Jan 07 '24 17:01 mohamedawnallah

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

mohamedawnallah avatar Jan 12 '24 16:01 mohamedawnallah

@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.

yyforyongyu avatar Jan 15 '24 04:01 yyforyongyu

[!IMPORTANT]

Review skipped

Auto reviews are limited to specific labels.

:label: 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.

coderabbitai[bot] avatar Jan 02 '25 21:01 coderabbitai[bot]

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! 🙏

mohamedawnallah avatar Jan 03 '25 00:01 mohamedawnallah

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.

yyforyongyu avatar Jan 06 '25 03:01 yyforyongyu

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

saubyk avatar Jan 06 '25 15:01 saubyk

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.

ziggie1984 avatar Jan 21 '25 22:01 ziggie1984

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.

bitromortac avatar Jan 23 '25 09:01 bitromortac

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.

guggero avatar Jan 23 '25 09:01 guggero

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.

mohamedawnallah avatar Jan 29 '25 16:01 mohamedawnallah

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

lightninglabs-deploy avatar May 01 '25 00:05 lightninglabs-deploy

!lightninglabs-deploy mute

guggero avatar May 01 '25 06:05 guggero

@saubyk can you update the milestone here or is it planned for 20 ?

ziggie1984 avatar Jun 12 '25 13:06 ziggie1984