Skip to content

lightningd: add description field to offer related responces #8782

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.

Sign up for GitHub

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

Open
erdoganishe wants to merge 4 commits into
base: master
Choose a base branch
from
+890 −759
Open

lightningd: add description field to offer related responces #8782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e3b893
lightningd: add description field to offer related responces
erdoganishe Dec 11, 2025
21f53d5
lightningd: Updated offer methods
ShahanaFarooqui Dec 11, 2025
57dfd34
doc: Added doc schemas with description and update proto
ShahanaFarooqui Dec 11, 2025
053694a
test: Add tests to confirm that description is added to RPCs
ShahanaFarooqui Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .msggen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1625,6 +1625,7 @@
"DisableofferResponse": {
"DisableOffer.active": 2,
"DisableOffer.bolt12": 4,
"DisableOffer.description": 7,
"DisableOffer.label": 6,
"DisableOffer.offer_id": 1,
"DisableOffer.single_use": 3,
Expand All @@ -1643,6 +1644,7 @@
"EnableofferResponse": {
"EnableOffer.active": 2,
"EnableOffer.bolt12": 4,
"EnableOffer.description": 7,
"EnableOffer.label": 6,
"EnableOffer.offer_id": 1,
"EnableOffer.single_use": 3,
Expand Down Expand Up @@ -2859,6 +2861,7 @@
"ListoffersOffers": {
"ListOffers.offers[].active": 2,
"ListOffers.offers[].bolt12": 4,
"ListOffers.offers[].description": 7,
"ListOffers.offers[].label": 6,
"ListOffers.offers[].offer_id": 1,
"ListOffers.offers[].single_use": 3,
Expand Down Expand Up @@ -7060,6 +7063,10 @@
"added": "pre-v0.10.1",
"deprecated": null
},
"DisableOffer.description": {
"added": "v26.04",
"deprecated": null
},
"DisableOffer.label": {
"added": "pre-v0.10.1",
"deprecated": null
Expand Down Expand Up @@ -7108,6 +7115,10 @@
"added": "v24.11",
"deprecated": null
},
"EnableOffer.description": {
"added": "v26.04",
"deprecated": null
},
"EnableOffer.label": {
"added": "v24.11",
"deprecated": null
Expand Down Expand Up @@ -10568,6 +10579,10 @@
"added": "pre-v0.10.1",
"deprecated": null
},
"ListOffers.offers[].description": {
"added": "v26.04",
"deprecated": null
},
"ListOffers.offers[].label": {
"added": "pre-v0.10.1",
"deprecated": null
Expand Down
3 changes: 3 additions & 0 deletions cln-grpc/proto/node.proto
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions cln-grpc/src/convert.rs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions cln-rpc/src/model.rs
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 26 additions & 0 deletions contrib/msggen/msggen/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11922,6 +11922,13 @@
"The bolt12 string representing this offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -11964,6 +11971,7 @@
"active": false,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
}
Expand Down Expand Up @@ -12169,6 +12177,13 @@
"The bolt12 string representing this offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -12217,6 +12232,7 @@
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
}
Expand Down Expand Up @@ -23462,6 +23478,13 @@
"The bolt12 encoding of the offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -23505,20 +23528,23 @@
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000",
"description": "Fish sale!",
"used": false
},
{
"offer_id": "offeridl22000002200000220000022000002200000220000022000002200000",
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000",
"description": "Coffee",
"used": false
},
{
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
]
Expand Down
1,516 changes: 758 additions & 758 deletions contrib/pyln-grpc-proto/pyln/grpc/node_pb2.py
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions contrib/pyln-testing/pyln/testing/grpc2py.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1423,6 +1423,7 @@ def disableoffer2py(m):
return remove_default({
"active": m.active, # PrimitiveField in generate_composite
"bolt12": m.bolt12, # PrimitiveField in generate_composite
"description": m.description, # PrimitiveField in generate_composite
"label": m.label, # PrimitiveField in generate_composite
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
"single_use": m.single_use, # PrimitiveField in generate_composite
Expand All @@ -1434,6 +1435,7 @@ def enableoffer2py(m):
return remove_default({
"active": m.active, # PrimitiveField in generate_composite
"bolt12": m.bolt12, # PrimitiveField in generate_composite
"description": m.description, # PrimitiveField in generate_composite
"label": m.label, # PrimitiveField in generate_composite
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
"single_use": m.single_use, # PrimitiveField in generate_composite
Expand Down Expand Up @@ -1712,6 +1714,7 @@ def listoffers_offers2py(m):
return remove_default({
"active": m.active, # PrimitiveField in generate_composite
"bolt12": m.bolt12, # PrimitiveField in generate_composite
"description": m.description, # PrimitiveField in generate_composite
"label": m.label, # PrimitiveField in generate_composite
"offer_id": hexlify(m.offer_id), # PrimitiveField in generate_composite
"single_use": m.single_use, # PrimitiveField in generate_composite
Expand Down
8 changes: 8 additions & 0 deletions doc/schemas/disableoffer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@
"The bolt12 string representing this offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -101,6 +108,7 @@
"active": false,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
}
Expand Down
8 changes: 8 additions & 0 deletions doc/schemas/enableoffer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,13 @@
"The bolt12 string representing this offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -105,6 +112,7 @@
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
}
Expand Down
10 changes: 10 additions & 0 deletions doc/schemas/listoffers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@
"The bolt12 encoding of the offer."
]
},
"description": {
"added": "v26.04",
"type": "string",
"description": [
"The user-specified bolt 12 description."
]
},
"used": {
"type": "boolean",
"description": [
Expand Down Expand Up @@ -113,20 +120,23 @@
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000210002100021000",
"description": "Fish sale!",
"used": false
},
{
"offer_id": "offeridl22000002200000220000022000002200000220000022000002200000",
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000220002200022000",
"description": "Coffee",
"used": false
},
{
"offer_id": "offeridl23000002300000230000023000002300000230000023000002300000",
"active": true,
"single_use": false,
"bolt12": "lno1qgsq000bolt230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000230002300023000",
"description": "Movie ticket",
"used": false
}
]
Expand Down
Loading
Loading