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

NUT-04: Add optional description for PostMintQuoteBolt11Request #144

Merged
merged 3 commits into from
Sep 9, 2024

Conversation

minibits-cash
Copy link
Contributor

This PR extends PostMintQuoteBolt11Request by optional description field. Description is then ought to be passed to the lightning backend by the mint and included in the returned bolt11 invoice.

Considered two options for param name: memo and description, leaning to the latter as it is more generic and decoded bolt11 invoice uses the same term.

@minibits-cash minibits-cash changed the title Add optional description for PostMintQuoteBolt11Request NUT-04: Add optional description for PostMintQuoteBolt11Request Jun 27, 2024
@thesimplekid
Copy link
Collaborator

As mentioned on the dev call since this may not be supported by all backends it would be best to add signalling for it on the MintInfo endpoint. A boolean field could be added to the Mint Settings something like set_description. I also think it would be a good idea for the mint to return an error if a description is included and it is not supported.

@thesimplekid thesimplekid linked an issue Jul 26, 2024 that may be closed by this pull request
Copy link
Contributor

@callebtc callebtc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. We should add Error codes but that doesn't block this PR

@callebtc callebtc merged commit 463cd54 into cashubtc:main Sep 9, 2024
1 check passed
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.

NUT-04: Add optional memo for PostMintQuoteBolt11Request
3 participants