mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 22:31:48 +01:00
189 lines
5 KiB
JSON
189 lines
5 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"subsystem"
|
|
],
|
|
"properties": {
|
|
"subsystem": {
|
|
"type": "string",
|
|
"enum": [
|
|
"invoices",
|
|
"forwards",
|
|
"sendpays"
|
|
]
|
|
},
|
|
"created": {
|
|
"type": "u64",
|
|
"description": "1-based index indicating order entry was created"
|
|
},
|
|
"updated": {
|
|
"type": "u64",
|
|
"description": "1-based index indicating order entry was updated"
|
|
},
|
|
"deleted": {
|
|
"type": "u64",
|
|
"description": "1-based index indicating order entry was deleted"
|
|
},
|
|
"details": {}
|
|
},
|
|
"allOf": [
|
|
{
|
|
"if": {
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"subsystem": {
|
|
"type": "string",
|
|
"enum": [
|
|
"invoices"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"subsystem": {},
|
|
"created": {},
|
|
"updated": {},
|
|
"deleted": {},
|
|
"details": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"unpaid",
|
|
"paid",
|
|
"expired"
|
|
],
|
|
"description": "Whether it's paid, unpaid or unpayable"
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"description": "unique label supplied at invoice creation"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "description used in the invoice"
|
|
},
|
|
"bolt11": {
|
|
"type": "string",
|
|
"description": "the BOLT11 string"
|
|
},
|
|
"bolt12": {
|
|
"type": "string",
|
|
"description": "the BOLT12 string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"if": {
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"subsystem": {
|
|
"type": "string",
|
|
"enum": [
|
|
"forwards"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"subsystem": {},
|
|
"created": {},
|
|
"updated": {},
|
|
"deleted": {},
|
|
"details": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"offered",
|
|
"settled",
|
|
"failed",
|
|
"local_failed"
|
|
],
|
|
"description": "still ongoing, completed, failed locally, or failed after forwarding"
|
|
},
|
|
"in_channel": {
|
|
"type": "short_channel_id",
|
|
"description": "unique label supplied at invoice creation"
|
|
},
|
|
"in_htlc_id": {
|
|
"type": "u64",
|
|
"description": "the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)"
|
|
},
|
|
"in_msat": {
|
|
"type": "msat",
|
|
"description": "the value of the incoming HTLC"
|
|
},
|
|
"out_channel": {
|
|
"type": "short_channel_id",
|
|
"description": "the channel that the HTLC (trying to) forward to"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"if": {
|
|
"additionalProperties": true,
|
|
"properties": {
|
|
"subsystem": {
|
|
"type": "string",
|
|
"enum": [
|
|
"sendpays"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"then": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"subsystem": {},
|
|
"created": {},
|
|
"updated": {},
|
|
"deleted": {},
|
|
"details": {
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"enum": [
|
|
"pending",
|
|
"failed",
|
|
"complete"
|
|
],
|
|
"description": "status of the payment"
|
|
},
|
|
"partid": {
|
|
"type": "u64",
|
|
"description": "Part number (for multiple parts to a single payment)"
|
|
},
|
|
"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"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|