Skip to content

Update listsendpays documentation to explain when amount_msat is not present #8144

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

Closed
wants to merge 1 commit into from
Closed

Update listsendpays documentation to explain when amount_msat is not present #8144

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions doc/schemas/lightning-listsendpays.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@
"amount_msat": {
"type": "msat",
"description": [
"The amount delivered to destination (if known)."
"The amount delivered to destination (if known). This field might not be present if the payment is still pending or if the amount delivered to the destination is not known."
Copy link
Contributor

@rustyrussell rustyrussell Apr 28, 2025

Choose a reason for hiding this comment

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

No, it means that the caller used "sendonion" so we don't know how much actually got delivered.

]
},
"destination": {
Expand Down Expand Up @@ -326,7 +326,8 @@
}
},
"pre_return_value_notes": [
"Note that the returned array is ordered by increasing *id*."
"Note that the returned array is ordered by increasing *id*.",
"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."
Copy link
Contributor

@rustyrussell rustyrussell Apr 28, 2025

Choose a reason for hiding this comment

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

This one seems redundant?

]
},
"author": [
Expand Down