Use proxy agents for CLNRest over Tor

[ekzyis]

Description

Close #1107 Supersedes #1133

This now uses copied proxy agents from hpagent.

CLNRest should now work with HTTPS over clearnet (as already did) and with HTTP/HTTPS over Tor.

Screenshots

Additional Context

Checklist

Are your changes backwards compatible? Please answer below:

yes

Did you QA this? Could we deploy this straight to production? Please answer below:

I tested that the correct agents are called depending on /\.onion(:[0-9]+)?$/.test(socket) and cert. I didn't e2e test this to save time and because I am confident enough that this works. So I would say let's try this out in production.

For frontend changes: Tested on mobile? Please answer below:

Did you introduce any new environment variables? If so, call them out explicitly here:

[coderabbitai]

Walkthrough

Walkthrough

The update enhances the cln.js module to support creating invoices over Tor by dynamically determining the connection protocol (HTTP or HTTPS) and utilizing appropriate proxy agents. This is facilitated by the new lib/proxy.js, which introduces proxy agent classes for handling HTTP and HTTPS requests via proxies.

Changes

File	Summary of Changes
lib/cln.js	Added support for Tor with dynamic protocol and agent determination; updated imports and variables.
lib/proxy.js	Introduced HttpProxyAgent and HttpsProxyAgent for handling proxy connections.

Assessment against linked issues

Objective	Addressed	Explanation
Connect CLN node using clnrest for withdrawal over Tor (#1107)	✅

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 54bbb0c and eabec81.

Files selected for processing (2)

• lib/cln.js (1 hunks)
• lib/proxy.js (1 hunks)

Additional comments not posted (5)

lib/proxy.js (4)

6-14: Constructor implementation looks good and correctly handles the initialization of proxy settings.

---

16-59: The createConnection method is well-implemented with proper handling of proxy connections, including error management and cleanup of event listeners.

---

63-71: Constructor implementation for HttpsProxyAgent is correct and effectively initializes proxy settings for HTTPS connections.

---

73-118: The createConnection method in HttpsProxyAgent is well-implemented, ensuring secure connections are properly established over a proxy.

lib/cln.js (1)

4-23: The modifications in createInvoice to support Tor using proxy agents are correctly implemented. The dynamic determination of protocol and agent based on the socket address is a robust solution.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.