lnd icon indicating copy to clipboard operation
lnd copied to clipboard

Invoice rpc metadata support

Open sputn1ck opened this issue 2 months ago • 5 comments

Change Description

This PR adds support for adding and fetching invoice metadata via lnrpc.

sputn1ck avatar Oct 23 '25 09:10 sputn1ck

Summary of Changes

Hello @sputn1ck, I'm Gemini Code Assist[^1]! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the lnrpc system by integrating comprehensive support for invoice metadata. This feature allows users to embed arbitrary byte data directly into invoices when they are created, and subsequently retrieve this data when interacting with payment requests or querying invoice details. This provides a flexible and extensible mechanism for associating custom information with Lightning Network invoices, enabling a wider range of application-specific use cases.

Highlights

  • Invoice Metadata Support: Introduced the ability to add and retrieve arbitrary metadata for both regular and hold invoices via the lnrpc interface.
  • API Extensions: Extended AddInvoiceData, AddHoldInvoiceRequest, Invoice, and PayReq structures to include a Metadata field, allowing byte arrays to be attached to invoices.
  • Integration Testing: Added a new integration test (testInvoiceMetadata) to thoroughly verify that metadata can be correctly set during invoice creation and subsequently fetched when decoding payment requests or looking up invoices.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with :thumbsup: and :thumbsdown: on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

[^1]: Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

gemini-code-assist[bot] avatar Oct 23 '25 09:10 gemini-code-assist[bot]

Seems like the most straight-forward way to do it, just wanted to point out that now DB changes are needed because we pack the metadata into the invoice request which is saved as a blob in the SQL case.

ziggie1984 avatar Oct 23 '25 11:10 ziggie1984

Seems like the most straight-forward way to do it, just wanted to point out that now DB changes are needed because we pack the metadata into the invoice request which is saved as a blob in the SQL case.

Do you think db changes are neccessary? The metadata is encoded in the payreq, thus is able to be fetched by the lookupinvoice call (as seen in the itest).

sputn1ck avatar Oct 24 '25 13:10 sputn1ck

Do you think db changes are neccessary? The metadata is encoded in the payreq, thus is able to be fetched by the lookupinvoice call (as seen in the itest).

Sorry for the confusion, I had a typo in my initial comment which should have been "no" instead of "now". You are correct no DB migration is needed. Maybe if we introduce Bolt 12 offers this might change but for now you pack it into the request.

ziggie1984 avatar Oct 27 '25 21:10 ziggie1984

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

lightninglabs-deploy avatar Dec 09 '25 12:12 lightninglabs-deploy