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

schemas: "description" field in "wait(any)invoice" is optional since BOLT12 #7667

Conversation

laanwj
Copy link
Contributor

@laanwj laanwj commented Sep 13, 2024

schemas: "description" field in "wait(any)invoice" is optional since BOLT12

Description

For BOLT12 invoices, the "description" is field missing in the invoice responses. This causes a serde parse error when handling BOLT12 invoices in rust code. Update the schemas accordingly:

  • doc/schemas/lightning-waitanyinvoice.json
  • doc/schemas/lightning-waitinvoice.json

Also commit the generated msggen, cln-grpc, cln-rpc and pyln-grpc-proto files.

Related Issues

Continues #7660.

Changes Made

Changelog-Fixed: schemas: Make description in Wait(any)invoiceResponse optional to handle BOLT12

Checklist

Ensure the following tasks are completed before submitting the PR:

  • Changelog has been added in relevant commit/s.
  • N/A Tests have been added or updated to cover the changes.
  • Documentation has been updated as needed.
  • Any relevant comments or TODOs have been addressed or removed.

@laanwj
Copy link
Contributor Author

laanwj commented Sep 13, 2024

It's complaining that the auto-generated files aren't updated, while i really did that. The python output looks way different though.

-# Protobuf Python Version: 5.26.1
+# Protobuf Python Version: 4.25.1

Seems the specific version is needed...

…BOLT12

For BOLT12 invoices, the "description" is field missing in the invoice
responses. Update the schemas accordingly:

- `doc/schemas/lightning-waitanyinvoice.json`
- `doc/schemas/lightning-waitinvoice.json`

Also commit the generated msggen, cln-grpc, cln-rpc and pyln-grpc-proto files.

Changelog-Fixed: schemas: Make description in `Wait(any)invoiceResponse` optional to handle BOLT12
@daywalker90
Copy link
Contributor

Are you using poetry shell -> poetry install before running make?

@laanwj laanwj force-pushed the 2024-09-waitanyinvoice-description-option-2 branch from 308c173 to dda7524 Compare September 13, 2024 11:13
@laanwj
Copy link
Contributor Author

laanwj commented Sep 13, 2024

Didn't even have that installed, i don't think i've ever used poetry in my life 😄 Will try that next time.

Did manually figure it out i think:

pip3 install protobuf==4.25.1
pip3 install grpcio-tools==1.62.2

@daywalker90
Copy link
Contributor

I suggest this goes into 24.08.1 aswell @ShahanaFarooqui

Copy link
Collaborator

@vincenzopalazzo vincenzopalazzo left a comment

Choose a reason for hiding this comment

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

ACK dda7524

@ShahanaFarooqui ShahanaFarooqui added this to the v24.08.1 milestone Sep 13, 2024
@rustyrussell rustyrussell merged commit c8660c8 into ElementsProject:master Sep 16, 2024
38 checks 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.

5 participants