Skip to content

Documentation of listsendpays #6909

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

Jump to bottom
Open
Lagrang3 opened this issue Nov 30, 2023 · 0 comments · May be fixed by #8144
Open

Documentation of listsendpays #6909

Lagrang3 opened this issue Nov 30, 2023 · 0 comments · May be fixed by #8144
Labels
docs good first issue good for onboarding
Milestone
v25.05

Comments

@Lagrang3
Copy link
Collaborator

According to the documentation of listsendpay the field amount_msat is optional:

    amount_msat (msat, optional): The amount delivered to destination (if known)

No further information is provided. Can the documentation be more explicit?
Like explaining, maybe, under which circumstances this field is not present, so that
people (and software) calling listsendpays can deduce what is happening with that
sendpay and act accordingly.
@vincenzopalazzo vincenzopalazzo added this to the v24.02 milestone Dec 2, 2023
@vincenzopalazzo vincenzopalazzo self-assigned this Dec 2, 2023
@cdecker cdecker removed this from the v24.02 milestone Feb 13, 2024
@vincenzopalazzo vincenzopalazzo removed their assignment Mar 26, 2024
@vincenzopalazzo vincenzopalazzo added the good first issue good for onboarding label Mar 26, 2024
shashankxrm added a commit to shashankxrm/lightning that referenced this issue Mar 6, 2025
@shashankxrm
Update listsendpays documentation to explain when amount_msat is not …
53ae1ef 
…present

Fixes ElementsProject#6909

Update the documentation of `listsendpays` to be more explicit about when the `amount_msat` field might not be present.

* Update the description of the `amount_msat` field in `doc/schemas/lightning-listsendpays.json` to explain that it might not be present if the payment is still pending or if the amount delivered to the destination is not known.
* Add a note in the `response` section to indicate that if the `amount_msat` field is not present, it means the payment is still pending or the amount delivered to the destination is not known.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/ElementsProject/lightning/issues/6909?shareId=XXXX-XXXX-XXXX-XXXX).
@shashankxrm shashankxrm linked a pull request Mar 6, 2025 that will close this issue
Open
@ShahanaFarooqui ShahanaFarooqui added this to the v25.05 milestone Apr 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good first issue good for onboarding
Projects
None yet
Milestone
v25.05
Development

Successfully merging a pull request may close this issue.

Update listsendpays documentation to explain when amount_msat is not present shashankxrm/lightning
4 participants
@cdecker @vincenzopalazzo @ShahanaFarooqui @Lagrang3