Add helper function to properly get invoice pubkey

[benthecarman]

The docs for recover_payee_pub_key say (only to be used if none was included in the invoice) however there is no helper to let the user do that. This function will do the logic for them.

[coderabbitai]

Walkthrough

The update introduces a new method get_payee_pub_key to the Bolt11Invoice class within the lightning-invoice library. This method enhances the functionality by allowing the recovery of the payee's public key directly from the invoice, or through the signature if the public key is not explicitly included in the invoice data.

Changes

File(s)	Change Summary
lightning-invoice/src/lib.rs	Added get_payee_pub_key method to recover payee's public key.

🐇
In the code where lightning strikes,
A new path opens, bright and clear.
With keys in hand, we bridge the gaps,
Through digital realms, we leap and cheer.
So hop along, dear friends, let's soar,
With every line, we unlock a new door.
🌟🔑

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between affe557 and 53fc986.

Files selected for processing (1)

• lightning-invoice/src/lib.rs (1 hunks)

Files not reviewed due to errors (1)

• lightning-invoice/src/lib.rs (Error: unable to parse review)

[codecov-commenter]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (d70124c) 89.17% compared to head (53fc986) 89.06%.
Report is 50 commits behind head on main.

Files	Patch %	Lines
lightning-invoice/src/lib.rs	75.00%	1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2909      +/-   ##
==========================================
- Coverage   89.17%   89.06%   -0.11%     
==========================================
  Files         115      117       +2     
  Lines       94105    94461     +356     
  Branches    94105    94461     +356     
==========================================
+ Hits        83914    84130     +216     
- Misses       7722     7843     +121     
- Partials     2469     2488      +19     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[TheBlueMatt]

I mean sure, though I'd be surprised if anyone is creating explicit-key invoices.

[benthecarman]

Found this in bitkey's code 😆

https://github.com/proto-at-block/bitkey/blob/main/app/core/crypto/src/invoice.rs#L38

[TheBlueMatt]

No reason to wait for a second review on a trivial util function.