core-lightning/doc/schemas/renepaystatus.schema.json
Lagrang3 961ad21281 renepay: add help for renepay & renepaystatus
Signed-off-by: Lagrang3 <eduardo.quintana@pm.me>
2023-08-09 11:43:58 +09:30

84 lines
2.3 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"added": "v23.08",
"type": "object",
"additionalProperties": false,
"required": [
"paystatus"
],
"properties": {
"paystatus": {
"type": "array",
"description": "a list of payments attempted by renepay",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"bolt11",
"payment_hash",
"created_at",
"groupid",
"amount_msat",
"status",
"notes"
],
"properties": {
"bolt11": {
"type": "string",
"description": "invoice string BOLT11"
},
"payment_preimage": {
"type": "secret",
"description": "the proof of payment: SHA256 of this **payment_hash** (for completed payments only)"
},
"payment_hash": {
"type": "hash",
"description": "the hash of the *payment_preimage* which will prove payment"
},
"created_at": {
"type": "number",
"description": "the UNIX timestamp showing when this payment was initiated"
},
"groupid": {
"type": "u32",
"description": "the id for this payment attempt"
},
"parts": {
"type": "u32",
"description": "how many attempts this took"
},
"amount_msat": {
"type": "msat",
"description": "amount the recipient received"
},
"amount_sent_msat": {
"type": "msat",
"description": "total amount we sent including fees (for completed payments only)"
},
"status": {
"type": "string",
"enum": [
"complete",
"pending",
"failed"
],
"description": "status of payment"
},
"destination": {
"type": "pubkey",
"description": "the final destination of the payment"
},
"notes": {
"type": "array",
"description": "a list of messages for debugging purposes",
"items": {
"type": "string",
"description": "a message generated by renepay"
}
}
}
}
}
}
}