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>
This commit is contained in:
Rusty Russell 2024-10-30 09:38:42 +10:30
parent 7b2c791dcf
commit b327bd30c3
139 changed files with 730 additions and 298 deletions

File diff suppressed because it is too large Load Diff

View File

@ -261,6 +261,9 @@
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"additionalProperties": {
"type": "boolean"
},
"required": { "required": {
"type": "array", "type": "array",
"items": { "items": {
@ -290,6 +293,9 @@
"type": "object", "type": "object",
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"additionalProperties": {
"type": "boolean"
},
"required": { "required": {
"type": "array", "type": "array",
"items": { "items": {

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "addgossip", "rpc": "addgossip",
"title": "Command for injecting a gossip message (low-level)", "title": "Command for injecting a gossip message (low-level)",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"message" "message"
], ],
"additionalProperties": false,
"properties": { "properties": {
"message": { "message": {
"type": "hex", "type": "hex",
@ -25,6 +25,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"author": [ "author": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.11", "added": "v23.11",
"rpc": "addpsbtoutput", "rpc": "addpsbtoutput",
"title": "Command to populate PSBT outputs from the wallet", "title": "Command to populate PSBT outputs from the wallet",
@ -14,6 +13,7 @@
"required": [ "required": [
"satoshi" "satoshi"
], ],
"additionalProperties": false,
"properties": { "properties": {
"satoshi": { "satoshi": {
"type": "sat", "type": "sat",
@ -47,6 +47,7 @@
"estimated_added_weight", "estimated_added_weight",
"outnum" "outnum"
], ],
"additionalProperties": false,
"properties": { "properties": {
"psbt": { "psbt": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-age", "rpc": "askrene-age",
"title": "Command for expiring information in a layer (EXPERIMENTAL)", "title": "Command for expiring information in a layer (EXPERIMENTAL)",
"description": [ "description": [
@ -14,6 +13,7 @@
"layer", "layer",
"cutoff" "cutoff"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -34,6 +34,7 @@
"layer", "layer",
"num_removed" "num_removed"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-create-channel", "rpc": "askrene-create-channel",
"title": "Command to add a channel to layer (EXPERIMENTAL)", "title": "Command to add a channel to layer (EXPERIMENTAL)",
"description": [ "description": [
@ -17,6 +16,7 @@
"short_channel_id", "short_channel_id",
"capacity_msat" "capacity_msat"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -53,6 +53,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-create-layer", "rpc": "askrene-create-layer",
"title": "Command to create a new layer (EXPERIMENTAL)", "title": "Command to create a new layer (EXPERIMENTAL)",
"description": [ "description": [
@ -13,6 +12,7 @@
"required": [ "required": [
"layer" "layer"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -26,6 +26,7 @@
"required": [ "required": [
"layers" "layers"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layers": { "layers": {
"type": "array", "type": "array",
@ -74,6 +75,7 @@
"short_channel_id", "short_channel_id",
"capacity_msat" "capacity_msat"
], ],
"additionalProperties": false,
"properties": { "properties": {
"source": { "source": {
"type": "pubkey", "type": "pubkey",
@ -109,6 +111,7 @@
"required": [ "required": [
"short_channel_id_dir" "short_channel_id_dir"
], ],
"additionalProperties": false,
"properties": { "properties": {
"htlc_minimum_msat": { "htlc_minimum_msat": {
"type": "msat", "type": "msat",
@ -151,6 +154,7 @@
"short_channel_id", "short_channel_id",
"direction" "direction"
], ],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id": { "short_channel_id": {
"type": "short_channel_id", "type": "short_channel_id",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-disable-node", "rpc": "askrene-disable-node",
"title": "Command to disable all channels to/from a node in a layer (EXPERIMENTAL)", "title": "Command to disable all channels to/from a node in a layer (EXPERIMENTAL)",
"description": [ "description": [
@ -14,6 +13,7 @@
"layer", "layer",
"node" "node"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -31,6 +31,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-inform-channel", "rpc": "askrene-inform-channel",
"title": "Command to add channel capacity restrictions to layer (EXPERIMENTAL)", "title": "Command to add channel capacity restrictions to layer (EXPERIMENTAL)",
"description": [ "description": [
@ -16,6 +15,7 @@
"amount_msat", "amount_msat",
"inform" "inform"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -52,6 +52,7 @@
"required": [ "required": [
"constraints" "constraints"
], ],
"additionalProperties": false,
"properties": { "properties": {
"constraints": { "constraints": {
"type": "array", "type": "array",
@ -62,6 +63,7 @@
"short_channel_id_dir", "short_channel_id_dir",
"timestamp" "timestamp"
], ],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id_dir": { "short_channel_id_dir": {
"type": "short_channel_id_dir", "type": "short_channel_id_dir",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-listlayers", "rpc": "askrene-listlayers",
"title": "Command to display information about layers (EXPERIMENTAL)", "title": "Command to display information about layers (EXPERIMENTAL)",
"description": [ "description": [
@ -11,6 +10,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -24,6 +24,7 @@
"required": [ "required": [
"layers" "layers"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layers": { "layers": {
"type": "array", "type": "array",
@ -72,6 +73,7 @@
"short_channel_id", "short_channel_id",
"capacity_msat" "capacity_msat"
], ],
"additionalProperties": false,
"properties": { "properties": {
"source": { "source": {
"type": "pubkey", "type": "pubkey",
@ -107,6 +109,7 @@
"required": [ "required": [
"short_channel_id_dir" "short_channel_id_dir"
], ],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id_dir": { "short_channel_id_dir": {
"type": "short_channel_id_dir", "type": "short_channel_id_dir",
@ -160,6 +163,7 @@
"required": [ "required": [
"short_channel_id_dir" "short_channel_id_dir"
], ],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id_dir": { "short_channel_id_dir": {
"type": "short_channel_id_dir", "type": "short_channel_id_dir",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-listreservations", "rpc": "askrene-listreservations",
"title": "Command to display information about reservations (EXPERIMENTAL)", "title": "Command to display information about reservations (EXPERIMENTAL)",
"description": [ "description": [
@ -11,24 +10,26 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
"required": [ "required": [
"reservations" "reservations"
], ],
"additionalProperties": false,
"properties": { "properties": {
"reservations": { "reservations": {
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
"additionalProperties": false,
"required": [ "required": [
"short_channel_id_dir", "short_channel_id_dir",
"amount_msat", "amount_msat",
"age_in_seconds", "age_in_seconds",
"command_id" "command_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id_dir": { "short_channel_id_dir": {
"type": "short_channel_id_dir", "type": "short_channel_id_dir",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-remove-layer", "rpc": "askrene-remove-layer",
"title": "Command to destroy a layer (EXPERIMENTAL)", "title": "Command to destroy a layer (EXPERIMENTAL)",
"description": [ "description": [
@ -13,6 +12,7 @@
"required": [ "required": [
"layer" "layer"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -24,6 +24,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-reserve", "rpc": "askrene-reserve",
"title": "Command for informing askrene that you are trying a path (EXPERIMENTAL)", "title": "Command for informing askrene that you are trying a path (EXPERIMENTAL)",
"description": [ "description": [
@ -15,12 +14,13 @@
"required": [ "required": [
"path" "path"
], ],
"additionalProperties": false,
"properties": { "properties": {
"path": { "path": {
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
"additionalProperties": true, "additionalProperties": false,
"required": [ "required": [
"short_channel_id_dir", "short_channel_id_dir",
"amount_msat" "amount_msat"
@ -45,6 +45,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-unreserve", "rpc": "askrene-unreserve",
"title": "Command for informing askrene that you are no longer trying a path (EXPERIMENTAL)", "title": "Command for informing askrene that you are no longer trying a path (EXPERIMENTAL)",
"description": [ "description": [
@ -15,12 +14,13 @@
"required": [ "required": [
"path" "path"
], ],
"additionalProperties": false,
"properties": { "properties": {
"path": { "path": {
"type": "array", "type": "array",
"items": { "items": {
"type": "object", "type": "object",
"additionalProperties": true, "additionalProperties": false,
"required": [ "required": [
"short_channel_id_dir", "short_channel_id_dir",
"amount_msat" "amount_msat"
@ -45,6 +45,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "askrene-update-channel", "rpc": "askrene-update-channel",
"title": "Command to manipulate channel in a layer (EXPERIMENTAL)", "title": "Command to manipulate channel in a layer (EXPERIMENTAL)",
"description": [ "description": [
@ -14,6 +13,7 @@
"layer", "layer",
"short_channel_id_dir" "short_channel_id_dir"
], ],
"additionalProperties": false,
"properties": { "properties": {
"layer": { "layer": {
"type": "string", "type": "string",
@ -67,6 +67,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"see_also": [ "see_also": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "autoclean-once", "rpc": "autoclean-once",
"title": "A single deletion of old invoices/payments/forwards", "title": "A single deletion of old invoices/payments/forwards",
"description": [ "description": [
@ -12,6 +11,7 @@
"subsystem", "subsystem",
"age" "age"
], ],
"additionalProperties": false,
"properties": { "properties": {
"subsystem": { "subsystem": {
"type": "string", "type": "string",
@ -45,6 +45,7 @@
"required": [ "required": [
"autoclean" "autoclean"
], ],
"additionalProperties": false,
"properties": { "properties": {
"autoclean": { "autoclean": {
"type": "object", "type": "object",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "autoclean-status", "rpc": "autoclean-status",
"title": "Examine auto-delete of old invoices/payments/forwards", "title": "Examine auto-delete of old invoices/payments/forwards",
"description": [ "description": [
@ -9,6 +8,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"subsystem": { "subsystem": {
"type": "string", "type": "string",
@ -36,6 +36,7 @@
"required": [ "required": [
"autoclean" "autoclean"
], ],
"additionalProperties": false,
"properties": { "properties": {
"autoclean": { "autoclean": {
"type": "object", "type": "object",
@ -63,6 +64,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",
@ -124,6 +126,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",
@ -185,6 +188,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",
@ -246,6 +250,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",
@ -307,6 +312,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",
@ -368,6 +374,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"enabled": { "enabled": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "batching", "rpc": "batching",
"title": "Command to allow database batching.", "title": "Command to allow database batching.",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"enable" "enable"
], ],
"additionalProperties": false,
"properties": { "properties": {
"enable": { "enable": {
"type": "boolean", "type": "boolean",
@ -22,6 +22,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"errors": [ "errors": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "bkpr-channelsapy", "rpc": "bkpr-channelsapy",
"title": "Command to list stats on channel earnings", "title": "Command to list stats on channel earnings",
"description": [ "description": [
@ -9,6 +8,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"start_time": { "start_time": {
"type": "u64", "type": "u64",
@ -30,6 +30,7 @@
"required": [ "required": [
"channels_apy" "channels_apy"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channels_apy": { "channels_apy": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "bkpr-dumpincomecsv", "rpc": "bkpr-dumpincomecsv",
"title": "Command to emit a CSV of income events", "title": "Command to emit a CSV of income events",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"csv_format" "csv_format"
], ],
"additionalProperties": false,
"properties": { "properties": {
"csv_format": { "csv_format": {
"type": "string", "type": "string",
@ -52,6 +52,7 @@
"csv_file", "csv_file",
"csv_format" "csv_format"
], ],
"additionalProperties": false,
"properties": { "properties": {
"csv_file": { "csv_file": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "bkpr-inspect", "rpc": "bkpr-inspect",
"title": "Command to show onchain footprint of a channel", "title": "Command to show onchain footprint of a channel",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"account" "account"
], ],
"additionalProperties": false,
"properties": { "properties": {
"account": { "account": {
"type": "string", "type": "string",
@ -24,6 +24,7 @@
"required": [ "required": [
"txs" "txs"
], ],
"additionalProperties": false,
"properties": { "properties": {
"txs": { "txs": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "bkpr-listaccountevents", "rpc": "bkpr-listaccountevents",
"title": "Command for listing recorded bookkeeping events", "title": "Command for listing recorded bookkeeping events",
"description": [ "description": [
@ -17,6 +16,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"account": { "account": {
"type": "string", "type": "string",
@ -37,6 +37,7 @@
"required": [ "required": [
"events" "events"
], ],
"additionalProperties": false,
"properties": { "properties": {
"events": { "events": {
"type": "array", "type": "array",
@ -104,6 +105,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -114,6 +116,7 @@
} }
}, },
"then": { "then": {
"additionalProperties": false,
"properties": { "properties": {
"account": {}, "account": {},
"type": {}, "type": {},
@ -162,12 +165,12 @@
"required": [ "required": [
"outpoint", "outpoint",
"blockheight" "blockheight"
], ]
"additionalProperties": false
} }
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -178,6 +181,7 @@
} }
}, },
"then": { "then": {
"additionalProperties": false,
"properties": { "properties": {
"account": {}, "account": {},
"type": {}, "type": {},
@ -196,12 +200,12 @@
}, },
"required": [ "required": [
"txid" "txid"
], ]
"additionalProperties": false
} }
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -212,6 +216,7 @@
} }
}, },
"then": { "then": {
"additionalProperties": false,
"properties": { "properties": {
"account": {}, "account": {},
"type": {}, "type": {},
@ -245,8 +250,7 @@
"Counter for multi-part payments." "Counter for multi-part payments."
] ]
} }
}, }
"additionalProperties": false
} }
} }
] ]

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "bkpr-listbalances", "rpc": "bkpr-listbalances",
"title": "Command for listing current channel + wallet balances", "title": "Command for listing current channel + wallet balances",
"description": [ "description": [
@ -11,12 +10,14 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
"required": [ "required": [
"accounts" "accounts"
], ],
"additionalProperties": false,
"properties": { "properties": {
"accounts": { "accounts": {
"type": "array", "type": "array",
@ -112,11 +113,11 @@
} }
}, },
"else": { "else": {
"additionalProperties": false,
"properties": { "properties": {
"account": {}, "account": {},
"balances": {} "balances": {}
}, }
"additionalProperties": false
} }
} }
} }

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "pre-v0.10.1", "added": "pre-v0.10.1",
"rpc": "bkpr-listincome", "rpc": "bkpr-listincome",
"title": "Command for listing all income impacting events", "title": "Command for listing all income impacting events",
@ -10,6 +9,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"consolidate_fees": { "consolidate_fees": {
"type": "boolean", "type": "boolean",
@ -38,6 +38,7 @@
"required": [ "required": [
"income_events" "income_events"
], ],
"additionalProperties": false,
"properties": { "properties": {
"income_events": { "income_events": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.08", "added": "v23.08",
"rpc": "blacklistrune", "rpc": "blacklistrune",
"title": "Command to prevent a rune from working", "title": "Command to prevent a rune from working",
@ -14,6 +13,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"start": { "start": {
"type": "u64", "type": "u64",
@ -38,6 +38,7 @@
"required": [ "required": [
"blacklist" "blacklist"
], ],
"additionalProperties": false,
"properties": { "properties": {
"blacklist": { "blacklist": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "check", "rpc": "check",
"title": "Command for verifying parameters", "title": "Command for verifying parameters",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"command_to_check" "command_to_check"
], ],
"additionalProperties": true,
"properties": { "properties": {
"command_to_check": { "command_to_check": {
"type": "string", "type": "string",
@ -25,6 +25,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": { "properties": {
"command_to_check": { "command_to_check": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "checkmessage", "rpc": "checkmessage",
"title": "Command to check if a signature is from a node", "title": "Command to check if a signature is from a node",
"description": [ "description": [
@ -14,6 +13,7 @@
"message", "message",
"zbase" "zbase"
], ],
"additionalProperties": false,
"properties": { "properties": {
"message": { "message": {
"type": "string", "type": "string",
@ -40,6 +40,7 @@
"verified", "verified",
"pubkey" "pubkey"
], ],
"additionalProperties": false,
"properties": { "properties": {
"verified": { "verified": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.08", "added": "v23.08",
"rpc": "checkrune", "rpc": "checkrune",
"title": "Command to Validate Rune", "title": "Command to Validate Rune",
@ -16,6 +15,7 @@
"required": [ "required": [
"rune" "rune"
], ],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",
@ -57,6 +57,7 @@
"required": [ "required": [
"valid" "valid"
], ],
"additionalProperties": false,
"properties": { "properties": {
"valid": { "valid": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "close", "rpc": "close",
"title": "Command for closing channels with direct peers", "title": "Command for closing channels with direct peers",
"description": [ "description": [
@ -13,6 +12,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": true,
"properties": { "properties": {
"id": { "id": {
"type": "string", "type": "string",
@ -75,6 +75,7 @@
"required": [ "required": [
"type" "type"
], ],
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -91,6 +92,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.05", "added": "v23.05",
"deprecated": [ "deprecated": [
"v23.08", "v23.08",
@ -16,6 +15,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"start": { "start": {
"type": "u64", "type": "u64",
@ -40,6 +40,7 @@
"required": [ "required": [
"blacklist" "blacklist"
], ],
"additionalProperties": false,
"properties": { "properties": {
"blacklist": { "blacklist": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.05", "added": "v23.05",
"deprecated": [ "deprecated": [
"v23.08", "v23.08",
@ -16,6 +15,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",
@ -29,6 +29,7 @@
"required": [ "required": [
"runes" "runes"
], ],
"additionalProperties": false,
"properties": { "properties": {
"runes": { "runes": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"deprecated": [ "deprecated": [
"v23.08", "v23.08",
"v25.02" "v25.02"
@ -13,6 +12,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",
@ -64,6 +64,7 @@
"rune", "rune",
"unique_id" "unique_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "commando", "rpc": "commando",
"title": "Command to Send a Command to a Remote Peer", "title": "Command to Send a Command to a Remote Peer",
"description": [ "description": [
@ -12,6 +11,7 @@
"peer_id", "peer_id",
"method" "method"
], ],
"additionalProperties": false,
"properties": { "properties": {
"peer_id": { "peer_id": {
"type": "pubkey", "type": "pubkey",
@ -57,6 +57,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": true,
"properties": {}, "properties": {},
"pre_return_value_notes": [ "pre_return_value_notes": [
"On success, the return depends on the *method* invoked." "On success, the return depends on the *method* invoked."

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "connect", "rpc": "connect",
"title": "Command for connecting to another lightning node", "title": "Command for connecting to another lightning node",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "string", "type": "string",
@ -47,6 +47,7 @@
"direction", "direction",
"address" "address"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -97,6 +98,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -124,6 +126,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "createinvoice", "rpc": "createinvoice",
"title": "Low-level invoice creation", "title": "Low-level invoice creation",
"description": [ "description": [
@ -13,6 +12,7 @@
"label", "label",
"preimage" "preimage"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invstring": { "invstring": {
"type": "string", "type": "string",
@ -50,6 +50,7 @@
"description", "description",
"expires_at" "expires_at"
], ],
"additionalProperties": false,
"properties": { "properties": {
"label": { "label": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "createonion", "rpc": "createonion",
"title": "Low-level command to create a custom onion", "title": "Low-level command to create a custom onion",
"description": [ "description": [
@ -12,6 +11,7 @@
"hops", "hops",
"assocdata" "assocdata"
], ],
"additionalProperties": false,
"properties": { "properties": {
"hops": { "hops": {
"type": "array", "type": "array",
@ -66,6 +66,7 @@
"onion", "onion",
"shared_secrets" "shared_secrets"
], ],
"additionalProperties": false,
"properties": { "properties": {
"onion": { "onion": {
"type": "hex", "type": "hex",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.08", "added": "v23.08",
"rpc": "createrune", "rpc": "createrune",
"title": "Command to Create/Update Rune for Authorizing Remote Peer Access", "title": "Command to Create/Update Rune for Authorizing Remote Peer Access",
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",
@ -67,6 +67,7 @@
"rune", "rune",
"unique_id" "unique_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"rune": { "rune": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "datastore", "rpc": "datastore",
"title": "Command for storing (plugin) data", "title": "Command for storing (plugin) data",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"key" "key"
], ],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"description": [ "description": [
@ -74,6 +74,7 @@
"required": [ "required": [
"key" "key"
], ],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.11", "added": "v23.11",
"rpc": "datastoreusage", "rpc": "datastoreusage",
"title": "Command for listing datastore usage info", "title": "Command for listing datastore usage info",
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"oneOf": [ "oneOf": [
@ -35,6 +35,7 @@
"required": [ "required": [
"datastoreusage" "datastoreusage"
], ],
"additionalProperties": false,
"properties": { "properties": {
"datastoreusage": { "datastoreusage": {
"type": "object", "type": "object",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.05", "added": "v23.05",
"rpc": "decode", "rpc": "decode",
"title": "Command for decoding an invoice string (low-level)", "title": "Command for decoding an invoice string (low-level)",
@ -12,6 +11,7 @@
"required": [ "required": [
"string" "string"
], ],
"additionalProperties": false,
"properties": { "properties": {
"string": { "string": {
"type": "string", "type": "string",
@ -29,6 +29,7 @@
"type", "type",
"valid" "valid"
], ],
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -54,6 +55,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -394,6 +396,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -479,6 +482,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -965,6 +969,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -1072,6 +1077,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -1758,6 +1764,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -1905,6 +1912,7 @@
"version", "version",
"hex" "hex"
], ],
"additionalProperties": false,
"properties": { "properties": {
"version": {}, "version": {},
"hex": {}, "hex": {},
@ -1923,6 +1931,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -2161,6 +2170,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -2248,6 +2258,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -2293,6 +2304,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.05", "added": "v23.05",
"rpc": "decodepay", "rpc": "decodepay",
"title": "Command for decoding a bolt11 string (low-level)", "title": "Command for decoding a bolt11 string (low-level)",
@ -12,6 +11,7 @@
"required": [ "required": [
"bolt11" "bolt11"
], ],
"additionalProperties": false,
"properties": { "properties": {
"bolt11": { "bolt11": {
"type": "string", "type": "string",
@ -37,6 +37,7 @@
"payment_hash", "payment_hash",
"signature" "signature"
], ],
"additionalProperties": false,
"properties": { "properties": {
"currency": { "currency": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "deldatastore", "rpc": "deldatastore",
"title": "Command for removing (plugin) data", "title": "Command for removing (plugin) data",
"description": [ "description": [
@ -13,6 +12,7 @@
"required": [ "required": [
"key" "key"
], ],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"oneOf": [ "oneOf": [
@ -42,6 +42,7 @@
"required": [ "required": [
"key" "key"
], ],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "delforward", "rpc": "delforward",
"title": "Command for removing a forwarding entry", "title": "Command for removing a forwarding entry",
"description": [ "description": [
@ -15,6 +14,7 @@
"in_htlc_id", "in_htlc_id",
"status" "status"
], ],
"additionalProperties": false,
"properties": { "properties": {
"in_channel": { "in_channel": {
"type": "short_channel_id", "type": "short_channel_id",
@ -43,6 +43,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"errors": [ "errors": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "delinvoice", "rpc": "delinvoice",
"title": "Command for removing an invoice (or just its description)", "title": "Command for removing an invoice (or just its description)",
"description": [ "description": [
@ -12,6 +11,7 @@
"label", "label",
"status" "status"
], ],
"additionalProperties": true,
"properties": { "properties": {
"label": { "label": {
"oneOf": [ "oneOf": [
@ -53,6 +53,7 @@
"created_index", "created_index",
"expires_at" "expires_at"
], ],
"additionalProperties": true,
"properties": { "properties": {
"label": { "label": {
"type": "string", "type": "string",
@ -187,6 +188,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "delpay", "rpc": "delpay",
"title": "Command for removing a completed or failed payment", "title": "Command for removing a completed or failed payment",
"description": [ "description": [
@ -12,6 +11,7 @@
"payment_hash", "payment_hash",
"status" "status"
], ],
"additionalProperties": false,
"properties": { "properties": {
"payment_hash": { "payment_hash": {
"type": "hash", "type": "hash",
@ -53,6 +53,7 @@
"required": [ "required": [
"payments" "payments"
], ],
"additionalProperties": false,
"properties": { "properties": {
"payments": { "payments": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v24.02", "added": "v24.02",
"rpc": "deprecations", "rpc": "deprecations",
"title": "Command to enable/disable deprecated APIs", "title": "Command to enable/disable deprecated APIs",
@ -12,6 +11,7 @@
"required": [ "required": [
"enable" "enable"
], ],
"additionalProperties": false,
"properties": { "properties": {
"enable": { "enable": {
"type": "boolean", "type": "boolean",
@ -22,6 +22,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"errors": [ "errors": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "dev-forget-channel", "rpc": "dev-forget-channel",
"title": "Command to remove the DB entries from the database after a close", "title": "Command to remove the DB entries from the database after a close",
"warning": "For advanced users only", "warning": "For advanced users only",
@ -16,6 +15,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -50,6 +50,7 @@
"funding_unspent", "funding_unspent",
"funding_txid" "funding_txid"
], ],
"additionalProperties": false,
"properties": { "properties": {
"forced": { "forced": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v22.11", "added": "v22.11",
"rpc": "disableinvoicerequest", "rpc": "disableinvoicerequest",
"title": "Command for removing an invoice request", "title": "Command for removing an invoice request",
@ -15,6 +14,7 @@
"required": [ "required": [
"invreq_id" "invreq_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invreq_id": { "invreq_id": {
"type": "string", "type": "string",
@ -32,6 +32,7 @@
"bolt12", "bolt12",
"used" "used"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invreq_id": { "invreq_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "disableoffer", "rpc": "disableoffer",
"title": "Command for removing an offer", "title": "Command for removing an offer",
"warning": "experimental-offers only", "warning": "experimental-offers only",
@ -14,6 +13,7 @@
"required": [ "required": [
"offer_id" "offer_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",
@ -31,6 +31,7 @@
"bolt12", "bolt12",
"used" "used"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "disconnect", "rpc": "disconnect",
"title": "Command for disconnecting from another lightning node", "title": "Command for disconnecting from another lightning node",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -27,6 +27,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"errors": [ "errors": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "emergencyrecover", "rpc": "emergencyrecover",
"title": "Command for recovering channels from the emergency.recovery file in the lightning directory", "title": "Command for recovering channels from the emergency.recovery file in the lightning directory",
"description": [ "description": [
@ -11,12 +10,14 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
"required": [ "required": [
"stubs" "stubs"
], ],
"additionalProperties": false,
"properties": { "properties": {
"stubs": { "stubs": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "disableoffer", "rpc": "disableoffer",
"title": "Command for re-enabling an offer", "title": "Command for re-enabling an offer",
"warning": "experimental-offers only", "warning": "experimental-offers only",
@ -12,6 +11,7 @@
"required": [ "required": [
"offer_id" "offer_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",
@ -29,6 +29,7 @@
"bolt12", "bolt12",
"used" "used"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "feerates", "rpc": "feerates",
"title": "Command for querying recommended onchain feerates", "title": "Command for querying recommended onchain feerates",
"description": [ "description": [
@ -23,6 +22,7 @@
"required": [ "required": [
"style" "style"
], ],
"additionalProperties": false,
"properties": { "properties": {
"style": { "style": {
"type": "string", "type": "string",
@ -40,6 +40,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"warning_missing_feerates": { "warning_missing_feerates": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fetchinvoice", "rpc": "fetchinvoice",
"title": "Command for fetch an invoice for an offer", "title": "Command for fetch an invoice for an offer",
"warning": "experimental-offers only", "warning": "experimental-offers only",
@ -14,6 +13,7 @@
"required": [ "required": [
"offer" "offer"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer": { "offer": {
"type": "string", "type": "string",
@ -76,6 +76,7 @@
"invoice", "invoice",
"changes" "changes"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invoice": { "invoice": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fundchannel", "rpc": "fundchannel",
"title": "Command for establishing a lightning channel", "title": "Command for establishing a lightning channel",
"description": [ "description": [
@ -18,6 +17,7 @@
"id", "id",
"amount" "amount"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -127,6 +127,7 @@
"channel_type", "channel_type",
"channel_id" "channel_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"tx": { "tx": {
"type": "hex", "type": "hex",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fundchannel_cancel", "rpc": "fundchannel_cancel",
"title": "Command for completing channel establishment", "title": "Command for completing channel establishment",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -28,6 +28,7 @@
"required": [ "required": [
"cancelled" "cancelled"
], ],
"additionalProperties": false,
"properties": { "properties": {
"cancelled": { "cancelled": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fundchannel_complete", "rpc": "fundchannel_complete",
"title": "Command for completing channel establishment", "title": "Command for completing channel establishment",
"description": [ "description": [
@ -14,6 +13,7 @@
"id", "id",
"psbt" "psbt"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -34,6 +34,7 @@
"channel_id", "channel_id",
"commitments_secured" "commitments_secured"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fundchannel_start", "rpc": "fundchannel_start",
"title": "Command for initiating channel establishment for a lightning channel", "title": "Command for initiating channel establishment for a lightning channel",
"description": [ "description": [
@ -14,6 +13,7 @@
"id", "id",
"amount" "amount"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -94,6 +94,7 @@
"scriptpubkey", "scriptpubkey",
"warning_usage" "warning_usage"
], ],
"additionalProperties": false,
"properties": { "properties": {
"funding_address": { "funding_address": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "funderupdate", "rpc": "funderupdate",
"title": "Command for adjusting node funding v2 channels", "title": "Command for adjusting node funding v2 channels",
"description": [ "description": [
@ -15,6 +14,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"policy": { "policy": {
"type": "string", "type": "string",
@ -152,6 +152,7 @@
"fuzz_percent", "fuzz_percent",
"fund_probability" "fund_probability"
], ],
"additionalProperties": false,
"properties": { "properties": {
"summary": { "summary": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "fundpsbt", "rpc": "fundpsbt",
"title": "Command to populate PSBT inputs from the wallet", "title": "Command to populate PSBT inputs from the wallet",
"description": [ "description": [
@ -13,6 +12,7 @@
"feerate", "feerate",
"startweight" "startweight"
], ],
"additionalProperties": false,
"properties": { "properties": {
"satoshi": { "satoshi": {
"type": "sat_or_all", "type": "sat_or_all",
@ -88,6 +88,7 @@
"estimated_final_weight", "estimated_final_weight",
"excess_msat" "excess_msat"
], ],
"additionalProperties": false,
"properties": { "properties": {
"psbt": { "psbt": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "getemergencyrecoverdata", "rpc": "getemergencyrecoverdata",
"title": "Command to fetch data from the emergency.recover file", "title": "Command to fetch data from the emergency.recover file",
"description": [ "description": [
@ -9,12 +8,14 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
"required": [ "required": [
"filedata" "filedata"
], ],
"additionalProperties": false,
"properties": { "properties": {
"filedata": { "filedata": {
"type": "hex", "type": "hex",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "getinfo", "rpc": "getinfo",
"title": "Command to receive all information about the Core Lightning node.", "title": "Command to receive all information about the Core Lightning node.",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
@ -30,6 +30,7 @@
"lightning-dir", "lightning-dir",
"address" "address"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -179,6 +180,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -233,6 +235,7 @@
"required": [ "required": [
"type" "type"
], ],
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -264,6 +267,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",
@ -306,6 +310,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "getlog", "rpc": "getlog",
"title": "Command to show logs.", "title": "Command to show logs.",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"level": { "level": {
"type": "string", "type": "string",
@ -37,6 +37,7 @@
"bytes_max", "bytes_max",
"log" "log"
], ],
"additionalProperties": false,
"properties": { "properties": {
"created_at": { "created_at": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "getroute", "rpc": "getroute",
"title": "Command for routing a payment (low-level)", "title": "Command for routing a payment (low-level)",
"description": [ "description": [
@ -18,6 +17,7 @@
"amount_msat", "amount_msat",
"riskfactor" "riskfactor"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -80,6 +80,7 @@
"required": [ "required": [
"route" "route"
], ],
"additionalProperties": false,
"properties": { "properties": {
"route": { "route": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "getroutes", "rpc": "getroutes",
"title": "Command for routing a payment (EXPERIMENTAL)", "title": "Command for routing a payment (EXPERIMENTAL)",
"added": "v24.08", "added": "v24.08",
@ -28,6 +27,7 @@
"maxfee_msat", "maxfee_msat",
"final_cltv" "final_cltv"
], ],
"additionalProperties": false,
"properties": { "properties": {
"source": { "source": {
"type": "pubkey", "type": "pubkey",
@ -75,6 +75,7 @@
"probability_ppm", "probability_ppm",
"routes" "routes"
], ],
"additionalProperties": false,
"properties": { "properties": {
"probability_ppm": { "probability_ppm": {
"type": "u64", "type": "u64",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "help", "rpc": "help",
"title": "Command to return all information about RPC commands.", "title": "Command to return all information about RPC commands.",
"description": [ "description": [
@ -11,6 +10,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"command": { "command": {
"type": "string", "type": "string",
@ -24,6 +24,7 @@
"required": [ "required": [
"help" "help"
], ],
"additionalProperties": false,
"properties": { "properties": {
"help": { "help": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "invoice", "rpc": "invoice",
"title": "Command for accepting payments", "title": "Command for accepting payments",
"description": [ "description": [
@ -13,6 +12,7 @@
"label", "label",
"description" "description"
], ],
"additionalProperties": false,
"properties": { "properties": {
"amount_msat": { "amount_msat": {
"type": "msat_or_any", "type": "msat_or_any",
@ -111,6 +111,7 @@
"bolt11", "bolt11",
"payment_secret" "payment_secret"
], ],
"additionalProperties": false,
"properties": { "properties": {
"bolt11": { "bolt11": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v22.11", "added": "v22.11",
"rpc": "invoicerequest", "rpc": "invoicerequest",
"title": "Command for offering payments", "title": "Command for offering payments",
@ -14,6 +13,7 @@
"amount", "amount",
"description" "description"
], ],
"additionalProperties": false,
"properties": { "properties": {
"amount": { "amount": {
"type": "msat", "type": "msat",
@ -62,6 +62,7 @@
"bolt12", "bolt12",
"used" "used"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invreq_id": { "invreq_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "keysend", "rpc": "keysend",
"title": "Send funds to a node without an invoice", "title": "Send funds to a node without an invoice",
"description": [ "description": [
@ -16,6 +15,7 @@
"destination", "destination",
"amount_msat" "amount_msat"
], ],
"additionalProperties": false,
"properties": { "properties": {
"destination": { "destination": {
"type": "pubkey", "type": "pubkey",
@ -123,6 +123,7 @@
"amount_sent_msat", "amount_sent_msat",
"status" "status"
], ],
"additionalProperties": false,
"properties": { "properties": {
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listchannels", "rpc": "listchannels",
"title": "Command to query active lightning channels in the entire network", "title": "Command to query active lightning channels in the entire network",
"description": [ "description": [
@ -14,6 +13,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"short_channel_id": { "short_channel_id": {
"type": "short_channel_id", "type": "short_channel_id",
@ -39,6 +39,7 @@
"required": [ "required": [
"channels" "channels"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channels": { "channels": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.05", "added": "v23.05",
"rpc": "listclosedchannels", "rpc": "listclosedchannels",
"title": "Get data on our closed historical channels", "title": "Get data on our closed historical channels",
@ -13,6 +12,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -26,6 +26,7 @@
"required": [ "required": [
"closedchannels" "closedchannels"
], ],
"additionalProperties": false,
"properties": { "properties": {
"closedchannels": { "closedchannels": {
"type": "array", "type": "array",
@ -70,6 +71,7 @@
"alias": { "alias": {
"type": "object", "type": "object",
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"local": { "local": {
"type": "short_channel_id", "type": "short_channel_id",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listconfigs", "rpc": "listconfigs",
"title": "Command to list all configuration options.", "title": "Command to list all configuration options.",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"config": { "config": {
"type": "string", "type": "string",
@ -23,6 +23,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"configs": { "configs": {
"added": "v23.08", "added": "v23.08",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listdatastore", "rpc": "listdatastore",
"title": "Command for listing (plugin) data", "title": "Command for listing (plugin) data",
"description": [ "description": [
@ -9,6 +8,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"key": { "key": {
"oneOf": [ "oneOf": [
@ -34,6 +34,7 @@
"required": [ "required": [
"datastore" "datastore"
], ],
"additionalProperties": false,
"properties": { "properties": {
"datastore": { "datastore": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listforwards", "rpc": "listforwards",
"title": "Command showing all htlcs and their information", "title": "Command showing all htlcs and their information",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -75,6 +75,7 @@
"required": [ "required": [
"forwards" "forwards"
], ],
"additionalProperties": false,
"properties": { "properties": {
"forwards": { "forwards": {
"type": "array", "type": "array",
@ -227,6 +228,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -293,6 +295,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listfunds", "rpc": "listfunds",
"title": "Command showing all funds currently managed by the Core Lightning node", "title": "Command showing all funds currently managed by the Core Lightning node",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"spent": { "spent": {
"type": "boolean", "type": "boolean",
@ -27,6 +27,7 @@
"outputs", "outputs",
"channels" "channels"
], ],
"additionalProperties": false,
"properties": { "properties": {
"outputs": { "outputs": {
"type": "array", "type": "array",
@ -97,6 +98,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -133,6 +135,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"reserved": { "reserved": {
"type": "boolean", "type": "boolean",
@ -254,6 +257,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"state": { "state": {
"type": "string", "type": "string",
@ -290,6 +294,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"state": { "state": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listhtlcs", "rpc": "listhtlcs",
"title": "Command for querying HTLCs", "title": "Command for querying HTLCs",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "string", "type": "string",
@ -25,6 +25,7 @@
"required": [ "required": [
"htlcs" "htlcs"
], ],
"additionalProperties": false,
"properties": { "properties": {
"htlcs": { "htlcs": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v22.11", "added": "v22.11",
"rpc": "listinvoicerequests", "rpc": "listinvoicerequests",
"title": "Command for querying invoice_request status", "title": "Command for querying invoice_request status",
@ -13,6 +12,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"invreq_id": { "invreq_id": {
"type": "string", "type": "string",
@ -33,6 +33,7 @@
"required": [ "required": [
"invoicerequests" "invoicerequests"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invoicerequests": { "invoicerequests": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listinvoices", "rpc": "listinvoices",
"title": "Command for querying invoice status", "title": "Command for querying invoice status",
"description": [ "description": [
@ -14,6 +13,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"label": { "label": {
"oneOf": [ "oneOf": [
@ -84,6 +84,7 @@
"required": [ "required": [
"invoices" "invoices"
], ],
"additionalProperties": false,
"properties": { "properties": {
"invoices": { "invoices": {
"type": "array", "type": "array",
@ -181,6 +182,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listnodes", "rpc": "listnodes",
"title": "Command to get the list of nodes in the known network.", "title": "Command to get the list of nodes in the known network.",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -25,6 +25,7 @@
"required": [ "required": [
"nodes" "nodes"
], ],
"additionalProperties": false,
"properties": { "properties": {
"nodes": { "nodes": {
"type": "array", "type": "array",
@ -124,6 +125,7 @@
} }
}, },
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listoffers", "rpc": "listoffers",
"title": "Command for listing offers", "title": "Command for listing offers",
"warning": "experimental-offers only", "warning": "experimental-offers only",
@ -13,6 +12,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",
@ -32,6 +32,7 @@
"required": [ "required": [
"offers" "offers"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offers": { "offers": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listpays", "rpc": "listpays",
"title": "Command for querying payment status", "title": "Command for querying payment status",
"description": [ "description": [
@ -12,6 +11,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"bolt11": { "bolt11": {
"type": "string", "type": "string",
@ -42,6 +42,7 @@
"required": [ "required": [
"pays" "pays"
], ],
"additionalProperties": false,
"properties": { "properties": {
"pays": { "pays": {
"type": "array", "type": "array",
@ -117,6 +118,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -171,6 +173,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.02", "added": "v23.02",
"rpc": "listpeerchannels", "rpc": "listpeerchannels",
"title": "Command returning data on channels of connected lightning nodes", "title": "Command returning data on channels of connected lightning nodes",
@ -15,6 +14,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -28,6 +28,7 @@
"required": [ "required": [
"channels" "channels"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channels": { "channels": {
"type": "array", "type": "array",
@ -609,6 +610,7 @@
"alias": { "alias": {
"type": "object", "type": "object",
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"local": { "local": {
"type": "short_channel_id", "type": "short_channel_id",
@ -848,6 +850,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"direction": { "direction": {
"enum": [ "enum": [
@ -897,6 +900,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"direction": { "direction": {
"enum": [ "enum": [
@ -950,6 +954,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"peer_connected": { "peer_connected": {
"type": "boolean", "type": "boolean",
@ -960,6 +965,7 @@
} }
}, },
"then": { "then": {
"additionalProperties": true,
"properties": { "properties": {
"reestablished": { "reestablished": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listpeers", "rpc": "listpeers",
"title": "Command returning data on connected lightning nodes", "title": "Command returning data on connected lightning nodes",
"description": [ "description": [
@ -20,6 +19,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -46,6 +46,7 @@
"required": [ "required": [
"peers" "peers"
], ],
"additionalProperties": false,
"properties": { "properties": {
"peers": { "peers": {
"type": "array", "type": "array",
@ -106,6 +107,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"enum": [ "enum": [
@ -133,6 +135,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"enum": [ "enum": [
@ -185,6 +188,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"type": { "type": {
"enum": [ "enum": [

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listsendpays", "rpc": "listsendpays",
"title": "Low-level command for querying sendpay status", "title": "Low-level command for querying sendpay status",
"description": [ "description": [
@ -14,6 +13,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"bolt11": { "bolt11": {
"type": "string", "type": "string",
@ -75,6 +75,7 @@
"required": [ "required": [
"payments" "payments"
], ],
"additionalProperties": false,
"properties": { "properties": {
"payments": { "payments": {
"type": "array", "type": "array",
@ -192,6 +193,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -242,6 +244,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",
@ -284,6 +287,7 @@
}, },
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"status": { "status": {
"type": "string", "type": "string",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"added": "v23.02", "added": "v23.02",
"rpc": "listsqlschemas", "rpc": "listsqlschemas",
"title": "Command to example lightning-sql schemas", "title": "Command to example lightning-sql schemas",
@ -15,6 +14,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"table": { "table": {
"type": "string" "type": "string"
@ -25,6 +25,7 @@
"required": [ "required": [
"schemas" "schemas"
], ],
"additionalProperties": false,
"properties": { "properties": {
"schemas": { "schemas": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "listtransactions", "rpc": "listtransactions",
"title": "Command to get the list of transactions that was stored in the wallet.", "title": "Command to get the list of transactions that was stored in the wallet.",
"description": [ "description": [
@ -12,12 +11,14 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": {} "properties": {}
}, },
"response": { "response": {
"required": [ "required": [
"transactions" "transactions"
], ],
"additionalProperties": false,
"properties": { "properties": {
"transactions": { "transactions": {
"type": "array", "type": "array",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "makesecret", "rpc": "makesecret",
"title": "Command for deriving pseudorandom key from HSM", "title": "Command for deriving pseudorandom key from HSM",
"description": [ "description": [
@ -9,6 +8,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"hex": { "hex": {
"type": "hex", "type": "hex",
@ -28,6 +28,7 @@
"required": [ "required": [
"secret" "secret"
], ],
"additionalProperties": false,
"properties": { "properties": {
"secret": { "secret": {
"type": "secret", "type": "secret",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "multifundchannel", "rpc": "multifundchannel",
"title": "Command for establishing many lightning channels", "title": "Command for establishing many lightning channels",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"destinations" "destinations"
], ],
"additionalProperties": false,
"properties": { "properties": {
"destinations": { "destinations": {
"type": "array", "type": "array",
@ -131,6 +131,7 @@
"txid", "txid",
"channel_ids" "channel_ids"
], ],
"additionalProperties": false,
"properties": { "properties": {
"tx": { "tx": {
"type": "hex", "type": "hex",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "multiwithdraw", "rpc": "multiwithdraw",
"title": "Command for withdrawing to multiple addresses", "title": "Command for withdrawing to multiple addresses",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"outputs" "outputs"
], ],
"additionalProperties": false,
"properties": { "properties": {
"outputs": { "outputs": {
"type": "array", "type": "array",
@ -51,6 +51,7 @@
"tx", "tx",
"txid" "txid"
], ],
"additionalProperties": false,
"properties": { "properties": {
"tx": { "tx": {
"type": "hex", "type": "hex",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "newaddr", "rpc": "newaddr",
"title": "Command for generating a new address to be used by Core Lightning", "title": "Command for generating a new address to be used by Core Lightning",
"description": [ "description": [
@ -13,6 +12,7 @@
], ],
"request": { "request": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"addresstype": { "addresstype": {
"type": "string", "type": "string",
@ -30,6 +30,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"p2tr": { "p2tr": {
"added": "v23.08", "added": "v23.08",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "notifications", "rpc": "notifications",
"title": "Command to set up notifications.", "title": "Command to set up notifications.",
"description": [ "description": [
@ -13,6 +12,7 @@
"required": [ "required": [
"enable" "enable"
], ],
"additionalProperties": false,
"properties": { "properties": {
"enable": { "enable": {
"type": "boolean", "type": "boolean",
@ -23,6 +23,7 @@
} }
}, },
"response": { "response": {
"additionalProperties": false,
"properties": {}, "properties": {},
"post_return_value_notes": [ "post_return_value_notes": [
"On success, if *enable* was *true*, notifications will be forwarded from then on." "On success, if *enable* was *true*, notifications will be forwarded from then on."

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "offer", "rpc": "offer",
"title": "Command for accepting payments", "title": "Command for accepting payments",
"warning": "experimental-offers only", "warning": "experimental-offers only",
@ -14,6 +13,7 @@
"required": [ "required": [
"amount" "amount"
], ],
"additionalProperties": false,
"properties": { "properties": {
"amount": { "amount": {
"oneOf": [ "oneOf": [
@ -112,6 +112,7 @@
"used", "used",
"created" "created"
], ],
"additionalProperties": false,
"properties": { "properties": {
"offer_id": { "offer_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "openchannel_abort", "rpc": "openchannel_abort",
"title": "Command to abort a channel to a peer", "title": "Command to abort a channel to a peer",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"channel_id" "channel_id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
@ -26,6 +26,7 @@
"channel_canceled", "channel_canceled",
"reason" "reason"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "openchannel_bump", "rpc": "openchannel_bump",
"title": "Command to initiate a channel RBF", "title": "Command to initiate a channel RBF",
"description": [ "description": [
@ -15,6 +14,7 @@
"amount", "amount",
"initialpsbt" "initialpsbt"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
@ -51,6 +51,7 @@
"commitments_secured", "commitments_secured",
"funding_serial" "funding_serial"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "openchannel_init", "rpc": "openchannel_init",
"title": "Command to initiate a channel to a peer", "title": "Command to initiate a channel to a peer",
"description": [ "description": [
@ -13,6 +12,7 @@
"amount", "amount",
"initialpsbt" "initialpsbt"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -91,6 +91,7 @@
"commitments_secured", "commitments_secured",
"funding_serial" "funding_serial"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "openchannel_signed", "rpc": "openchannel_signed",
"title": "Command to conclude a channel open", "title": "Command to conclude a channel open",
"description": [ "description": [
@ -16,6 +15,7 @@
"channel_id", "channel_id",
"signed_psbt" "signed_psbt"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
@ -37,6 +37,7 @@
"tx", "tx",
"txid" "txid"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "openchannel_update", "rpc": "openchannel_update",
"title": "Command to update a collab channel open", "title": "Command to update a collab channel open",
"description": [ "description": [
@ -16,6 +15,7 @@
"channel_id", "channel_id",
"psbt" "psbt"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
@ -39,6 +39,7 @@
"channel_type", "channel_type",
"funding_outnum" "funding_outnum"
], ],
"additionalProperties": false,
"properties": { "properties": {
"channel_id": { "channel_id": {
"type": "hash", "type": "hash",
@ -128,6 +129,7 @@
"allOf": [ "allOf": [
{ {
"if": { "if": {
"additionalProperties": true,
"properties": { "properties": {
"commitments_secured": { "commitments_secured": {
"type": "boolean", "type": "boolean",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "parsefeerate", "rpc": "parsefeerate",
"title": "Command for parsing a feerate string to a feerate", "title": "Command for parsing a feerate string to a feerate",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"feerate_str" "feerate_str"
], ],
"additionalProperties": false,
"properties": { "properties": {
"feerate_str": { "feerate_str": {
"type": "string", "type": "string",
@ -22,6 +22,7 @@
}, },
"response": { "response": {
"required": [], "required": [],
"additionalProperties": false,
"properties": { "properties": {
"perkw": { "perkw": {
"type": "u32", "type": "u32",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "pay", "rpc": "pay",
"title": "Command for sending a payment to a BOLT11 invoice", "title": "Command for sending a payment to a BOLT11 invoice",
"description": [ "description": [
@ -15,6 +14,7 @@
"required": [ "required": [
"bolt11" "bolt11"
], ],
"additionalProperties": false,
"properties": { "properties": {
"bolt11": { "bolt11": {
"type": "string", "type": "string",
@ -122,6 +122,7 @@
"amount_sent_msat", "amount_sent_msat",
"status" "status"
], ],
"additionalProperties": false,
"properties": { "properties": {
"payment_preimage": { "payment_preimage": {
"type": "secret", "type": "secret",

View File

@ -1,7 +1,6 @@
{ {
"$schema": "../rpc-schema-draft.json", "$schema": "../rpc-schema-draft.json",
"type": "object", "type": "object",
"additionalProperties": false,
"rpc": "ping", "rpc": "ping",
"title": "Command to check if a node is up.", "title": "Command to check if a node is up.",
"description": [ "description": [
@ -11,6 +10,7 @@
"required": [ "required": [
"id" "id"
], ],
"additionalProperties": false,
"properties": { "properties": {
"id": { "id": {
"type": "pubkey", "type": "pubkey",
@ -38,6 +38,7 @@
"required": [ "required": [
"totlen" "totlen"
], ],
"additionalProperties": false,
"properties": { "properties": {
"totlen": { "totlen": {
"type": "u16", "type": "u16",

Some files were not shown because too many files have changed in this diff Show More