mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-02-22 22:45:27 +01:00
Code Issues Projects Releases Wiki Activity
core-lightning/doc/schemas/lightning-waitsendpay.json
Rusty Russell b327bd30c3 doc: fix all JSON schemas to enforce no additional properties. 
Without this, we have hardly any enforcement.  This is why the schema
mistake fixed in the previous patches weren't spotted immediately.

The hard work was done by:

```
$ for f in lightning-*.json; do grep -v '^  "additionalProperties": false,' $f | bagto $f; done
$ for f in lightning-*.json; do sed 's/"properties": {/"additionalProperties": false, "properties": {/' $f | bagto $f; done
$ make fmt-schemas
```

Then checking where 'additionalProperties: true' had been turned to
false (we deliberately use it in some places where there are if
statements in the schema, or occasionally where there can be arbitrary
fields).

[Including doc/rpc-schema-draft.json update by Shahana]
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-10-30 15:39:12 +10:30

260 lines
8.1 KiB
JSON
Raw Blame History

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"rpc": "waitsendpay",
"title": "Command for sending a payment via a route",
"description": [
"The **waitsendpay** RPC command polls or waits for the status of an outgoing payment that was initiated by a previous **sendpay** invocation.",
"",
"If the payment completed with success, this command returns with success. Otherwise, if the payment completed with failure, this command returns an error."
],
"request": {
"required": [
"payment_hash"
],
"additionalProperties": false,
"properties": {
"payment_hash": {
"type": "hash",
"description": [
"The hash of the *payment_preimage*."
]
},
"timeout": {
"type": "u32",
"description": [
"A timeout in seconds, for this RPC command to return. If the *timeout* is provided and the given amount of time passes without the payment definitely succeeding or definitely failing, this command returns with a 200 error code (payment still in progress). If *timeout* is not provided this call will wait indefinitely. Indicating a *timeout* of 0 effectively makes this call a pollable query of the status of the payment."
]
},
"partid": {
"type": "u64",
"description": [
"Unique ID within this (multi-part) payment. It must match that of the **sendpay** command."
]
},
"groupid": {
"type": "u64",
"description": [
"Grouping key to disambiguate multiple attempts to pay the same payment_hash."
]
}
},
"pairedWith": [
[
"partid",
"groupid"
]
]
},
"response": {
"required": [
"id",
"created_index",
"payment_hash",
"status",
"created_at",
"amount_sent_msat"
],
"additionalProperties": false,
"properties": {
"created_index": {
"added": "v23.11",
"type": "u64",
"description": [
"1-based index indicating order this payment was created in."
]
},
"id": {
"type": "u64",
"description": [
"Old synonym for created_index."
]
},
"groupid": {
"type": "u64",
"description": [
"Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash."
]
},
"payment_hash": {
"type": "hash",
"description": [
"The hash of the *payment_preimage* which will prove payment."
]
},
"status": {
"type": "string",
"enum": [
"complete"
],
"description": [
"Status of the payment."
]
},
"amount_msat": {
"type": "msat",
"description": [
"The amount delivered to destination (if known)."
]
},
"destination": {
"type": "pubkey",
"description": [
"The final destination of the payment if known."
]
},
"created_at": {
"type": "u64",
"description": [
"The UNIX timestamp showing when this payment was initiated."
]
},
"updated_index": {
"added": "v23.11",
"type": "u64",
"description": [
"1-based index indicating order this payment was changed (only present if it has changed since creation)."
]
},
"completed_at": {
"type": "number",
"description": [
"The UNIX timestamp showing when this payment was completed."
]
},
"amount_sent_msat": {
"type": "msat",
"description": [
"The amount sent."
]
},
"label": {
"type": "string",
"description": [
"The label, if given to sendpay."
]
},
"partid": {
"type": "u64",
"description": [
"The *partid*, if given to sendpay."
]
},
"bolt11": {
"type": "string",
"description": [
"The bolt11 string (if pay supplied one)."
]
},
"bolt12": {
"type": "string",
"description": [
"The bolt12 string (if supplied for pay: **experimental-offers** only)."
]
},
"message": {},
"payment_preimage": {}
},
"allOf": [
{
"if": {
"additionalProperties": true,
"properties": {
"status": {
"type": "string",
"enum": [
"complete"
]
}
}
},
"then": {
"additionalProperties": false,
"required": [
"payment_preimage"
],
"properties": {
"id": {},
"created_index": {},
"updated_index": {},
"groupid": {},
"payment_hash": {},
"status": {},
"msatoshi": {},
"amount_msat": {},
"destination": {},
"created_at": {},
"completed_at": {},
"msatoshi_sent": {},
"amount_sent_msat": {},
"label": {},
"partid": {},
"bolt11": {},
"bolt12": {},
"payment_preimage": {
"type": "secret",
"description": [
"The proof of payment: SHA256 of this **payment_hash**."
]
}
}
}
}
]
},
"errors": [
"On error, and even if the error occurred from a node other than the final destination, the route table will no longer be updated. Use the *exclude* parameter of the `getroute` command to ignore the failing route.",
"",
"- -1: Catchall nonspecific error.",
"- 200: Timed out before the payment could complete.",
"- 202: Unparseable onion reply. The *data* field of the error will have an *onionreply* field, a hex string representation of the raw onion reply.",
"- 203: Permanent failure at destination. The *data* field of the error will be routing failure object.",
"- 204: Failure along route; retry a different route. The *data* field of the error will be routing failure object.",
"- 208: A payment for *payment_hash* was never made and there is nothing to wait for.",
"- 209: The payment already failed, but the reason for failure was not stored. This should only occur when querying failed payments on very old databases.",
"",
"A routing failure object has the fields below:",
"",
"*erring_index*: The index of the node along the route that reported the error. 0 for the local node, 1 for the first hop, and so on.",
"*erring_node*: The hex string of the pubkey id of the node that reported the error.",
"*erring_channel*: The short channel ID of the channel that has the error (or the final channel if the destination raised the error).",
"*erring_direction*: The direction of traversing the *erring_channel*:",
"*failcode*: The failure code, as per BOLT #4.",
"*failcodename*: The human-readable name corresponding to *failcode*, if known."
],
"author": [
"ZmnSCPxj <<ZmnSCPxj@protonmail.com>> is mainly responsible."
],
"see_also": [
"lightning-sendpay(7)",
"lightning-pay(7)"
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
],
"examples": [
{
"request": {
"id": "example:waitsendpay#1",
"method": "waitsendpay",
"params": {
"payment_hash": "d598cfc62da16b381b8fb8af9833a24005f730e54cc32c317fecc511ffc6d2a2"
}
},
"response": {
"created_index": 2,
"id": 2,
"payment_hash": "d598cfc62da16b381b8fb8af9833a24005f730e54cc32c317fecc511ffc6d2a2",
"groupid": 1,
"updated_index": 2,
"destination": "035d2b1192dfba134e10e540875d366ebc8bc353d5aa766b80c090b39c3a5d885d",
"amount_msat": 10000,
"amount_sent_msat": 10001,
"created_at": 1722303675,
"completed_at": 1722303677,
"status": "complete",
"payment_preimage": "984a10782218478cd39e1f9a16795d756c337662067023a3b690bffdb1593f76"
}
}
]
}
Reference in a new issue View git blame Copy permalink