core-lightning/doc/schemas/getroute.schema.json

59 lines
1.5 KiB
JSON
Raw Normal View History

{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"additionalProperties": false,
"required": [
"route"
],
"properties": {
"route": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"direction",
"channel",
"amount_msat",
"delay",
"style"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "pubkey",
"description": "The node at the end of this hop"
},
"channel": {
"type": "short_channel_id",
"description": "The channel joining these nodes"
},
"direction": {
"type": "u32",
"description": "0 if this channel is traversed from lesser to greater **id**, otherwise 1"
},
"msatoshi": {
"type": "u64",
"deprecated": true
},
"amount_msat": {
"type": "msat",
"description": "The amount expected by the node at the end of this hop"
},
"delay": {
"type": "u32",
"description": "The total CLTV expected by the node at the end of this hop"
},
"style": {
"type": "string",
"description": "The features understood by the destination node",
"enum": [
"tlv"
]
}
}
}
}
}
}