Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Onion messaging + bolt 12 offers #9369

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

gijswijs
Copy link
Collaborator

This branch builds on earlier work by @carlaKC. The branch imports the experimental library boltnd and uses it to add support for bolt12 to LND.

Since the original work is over 2 years old now, I've updated both this branch and the experimental library boltnd to work with the latest versions of lnd, lndclient and lightning-onion. Since route blinding is now supported natively, we don't have to depend on custom forks of those libraries.

CAVEAT

This is by no means production ready.
Also, any changes to the bolt12 spec from the past 2 years have not been implemented. The current branch only "fixes" the original code to work with the current state of lnd and related libraries.

I opened up this draft PR to sollicit early feedback.

Building LND with bolt12 support

This branch introduces the bolt12 build flag, enabling support for bolt12. It introduces two Makefile targets that work with this new flag:

  • itest-b12
  • build-itest-b12

Todos

  • Update to the latest state of bolt12 spec
  • Decide on integrating the boltnd code in lnd or keep it as a external library. Originally, the code is largely implemented in the external boltnd library, to keep a clean separation of experimental code. But when the experimental label isn't applicable anymore, we need to decide on how to go forward.
  • Rate limiting
    • Initial token bucket rate limiting
    • Back propagation

carlaKC and others added 5 commits December 10, 2024 18:15
Co-authored-by: Gijs van Dam <[email protected]>
The `DefaultTimeout` in `lntest` is currently set to 30 seconds. This is
too short for tests where we wait for node restarts. This commit adjusts
the value to 60 seconds.
Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

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.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

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. (Beta)
  • @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.

@gijswijs gijswijs changed the title Onion messaging Onion messaging + bolt 12 offers Dec 17, 2024
@saubyk saubyk added this to the 0.20.0 milestone Dec 17, 2024
@carlaKC
Copy link
Collaborator

carlaKC commented Dec 18, 2024

If this is just a POC to show that we can still use my old code, ignore the below.

If this is actually an approach being considered I have some thoughts.


If the plan it to implement BOLTs externally going forward, I think that the design should be more carefully thought out (eg, importing lndclient is going to be an absolute disaster for dependencies), likely taking an approach similar to lightning-onion.

The ability to run an external daemon with full onion messaging (that has actually been reviewed!!!) and bolt 12 send support already exists in LNDK, so I feel that the most impactful use of time would be to start updating and reviewing the OM code properly (either in a LND pr, or in a lightning-messaging repo).

@saubyk saubyk mentioned this pull request Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants