mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 01:43:36 +01:00
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
parent
7b2c791dcf
commit
b327bd30c3
File diff suppressed because it is too large
Load Diff
@ -261,6 +261,9 @@
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"additionalProperties": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"required": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
@ -290,6 +293,9 @@
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"additionalProperties": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"required": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "addgossip",
|
||||
"title": "Command for injecting a gossip message (low-level)",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"message"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "hex",
|
||||
@ -25,6 +25,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"author": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.11",
|
||||
"rpc": "addpsbtoutput",
|
||||
"title": "Command to populate PSBT outputs from the wallet",
|
||||
@ -14,6 +13,7 @@
|
||||
"required": [
|
||||
"satoshi"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"satoshi": {
|
||||
"type": "sat",
|
||||
@ -47,6 +47,7 @@
|
||||
"estimated_added_weight",
|
||||
"outnum"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"psbt": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-age",
|
||||
"title": "Command for expiring information in a layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"layer",
|
||||
"cutoff"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -34,6 +34,7 @@
|
||||
"layer",
|
||||
"num_removed"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-create-channel",
|
||||
"title": "Command to add a channel to layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -17,6 +16,7 @@
|
||||
"short_channel_id",
|
||||
"capacity_msat"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -53,6 +53,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-create-layer",
|
||||
"title": "Command to create a new layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"required": [
|
||||
"layer"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -26,6 +26,7 @@
|
||||
"required": [
|
||||
"layers"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layers": {
|
||||
"type": "array",
|
||||
@ -74,6 +75,7 @@
|
||||
"short_channel_id",
|
||||
"capacity_msat"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"source": {
|
||||
"type": "pubkey",
|
||||
@ -109,6 +111,7 @@
|
||||
"required": [
|
||||
"short_channel_id_dir"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"htlc_minimum_msat": {
|
||||
"type": "msat",
|
||||
@ -151,6 +154,7 @@
|
||||
"short_channel_id",
|
||||
"direction"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id": {
|
||||
"type": "short_channel_id",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-disable-node",
|
||||
"title": "Command to disable all channels to/from a node in a layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"layer",
|
||||
"node"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -31,6 +31,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-inform-channel",
|
||||
"title": "Command to add channel capacity restrictions to layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -16,6 +15,7 @@
|
||||
"amount_msat",
|
||||
"inform"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -52,6 +52,7 @@
|
||||
"required": [
|
||||
"constraints"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"constraints": {
|
||||
"type": "array",
|
||||
@ -62,6 +63,7 @@
|
||||
"short_channel_id_dir",
|
||||
"timestamp"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id_dir": {
|
||||
"type": "short_channel_id_dir",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-listlayers",
|
||||
"title": "Command to display information about layers (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -24,6 +24,7 @@
|
||||
"required": [
|
||||
"layers"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layers": {
|
||||
"type": "array",
|
||||
@ -72,6 +73,7 @@
|
||||
"short_channel_id",
|
||||
"capacity_msat"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"source": {
|
||||
"type": "pubkey",
|
||||
@ -107,6 +109,7 @@
|
||||
"required": [
|
||||
"short_channel_id_dir"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id_dir": {
|
||||
"type": "short_channel_id_dir",
|
||||
@ -160,6 +163,7 @@
|
||||
"required": [
|
||||
"short_channel_id_dir"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id_dir": {
|
||||
"type": "short_channel_id_dir",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-listreservations",
|
||||
"title": "Command to display information about reservations (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -11,24 +10,26 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
"required": [
|
||||
"reservations"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"reservations": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"short_channel_id_dir",
|
||||
"amount_msat",
|
||||
"age_in_seconds",
|
||||
"command_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id_dir": {
|
||||
"type": "short_channel_id_dir",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-remove-layer",
|
||||
"title": "Command to destroy a layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"required": [
|
||||
"layer"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -24,6 +24,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-reserve",
|
||||
"title": "Command for informing askrene that you are trying a path (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -15,12 +14,13 @@
|
||||
"required": [
|
||||
"path"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"path": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"short_channel_id_dir",
|
||||
"amount_msat"
|
||||
@ -45,6 +45,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-unreserve",
|
||||
"title": "Command for informing askrene that you are no longer trying a path (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -15,12 +14,13 @@
|
||||
"required": [
|
||||
"path"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"path": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"additionalProperties": true,
|
||||
"additionalProperties": false,
|
||||
"required": [
|
||||
"short_channel_id_dir",
|
||||
"amount_msat"
|
||||
@ -45,6 +45,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "askrene-update-channel",
|
||||
"title": "Command to manipulate channel in a layer (EXPERIMENTAL)",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"layer",
|
||||
"short_channel_id_dir"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"layer": {
|
||||
"type": "string",
|
||||
@ -67,6 +67,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"see_also": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "autoclean-once",
|
||||
"title": "A single deletion of old invoices/payments/forwards",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
"subsystem",
|
||||
"age"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"subsystem": {
|
||||
"type": "string",
|
||||
@ -45,6 +45,7 @@
|
||||
"required": [
|
||||
"autoclean"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"autoclean": {
|
||||
"type": "object",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "autoclean-status",
|
||||
"title": "Examine auto-delete of old invoices/payments/forwards",
|
||||
"description": [
|
||||
@ -9,6 +8,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"subsystem": {
|
||||
"type": "string",
|
||||
@ -36,6 +36,7 @@
|
||||
"required": [
|
||||
"autoclean"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"autoclean": {
|
||||
"type": "object",
|
||||
@ -63,6 +64,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
@ -124,6 +126,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
@ -185,6 +188,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
@ -246,6 +250,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
@ -307,6 +312,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
@ -368,6 +374,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "batching",
|
||||
"title": "Command to allow database batching.",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"enable"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enable": {
|
||||
"type": "boolean",
|
||||
@ -22,6 +22,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"errors": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "bkpr-channelsapy",
|
||||
"title": "Command to list stats on channel earnings",
|
||||
"description": [
|
||||
@ -9,6 +8,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"start_time": {
|
||||
"type": "u64",
|
||||
@ -30,6 +30,7 @@
|
||||
"required": [
|
||||
"channels_apy"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channels_apy": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "bkpr-dumpincomecsv",
|
||||
"title": "Command to emit a CSV of income events",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"csv_format"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"csv_format": {
|
||||
"type": "string",
|
||||
@ -52,6 +52,7 @@
|
||||
"csv_file",
|
||||
"csv_format"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"csv_file": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "bkpr-inspect",
|
||||
"title": "Command to show onchain footprint of a channel",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"account"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {
|
||||
"type": "string",
|
||||
@ -24,6 +24,7 @@
|
||||
"required": [
|
||||
"txs"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"txs": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "bkpr-listaccountevents",
|
||||
"title": "Command for listing recorded bookkeeping events",
|
||||
"description": [
|
||||
@ -17,6 +16,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {
|
||||
"type": "string",
|
||||
@ -37,6 +37,7 @@
|
||||
"required": [
|
||||
"events"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"events": {
|
||||
"type": "array",
|
||||
@ -104,6 +105,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -114,6 +116,7 @@
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {},
|
||||
"type": {},
|
||||
@ -162,12 +165,12 @@
|
||||
"required": [
|
||||
"outpoint",
|
||||
"blockheight"
|
||||
],
|
||||
"additionalProperties": false
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -178,6 +181,7 @@
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {},
|
||||
"type": {},
|
||||
@ -196,12 +200,12 @@
|
||||
},
|
||||
"required": [
|
||||
"txid"
|
||||
],
|
||||
"additionalProperties": false
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -212,6 +216,7 @@
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {},
|
||||
"type": {},
|
||||
@ -245,8 +250,7 @@
|
||||
"Counter for multi-part payments."
|
||||
]
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "bkpr-listbalances",
|
||||
"title": "Command for listing current channel + wallet balances",
|
||||
"description": [
|
||||
@ -11,12 +10,14 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
"required": [
|
||||
"accounts"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"accounts": {
|
||||
"type": "array",
|
||||
@ -112,11 +113,11 @@
|
||||
}
|
||||
},
|
||||
"else": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"account": {},
|
||||
"balances": {}
|
||||
},
|
||||
"additionalProperties": false
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "pre-v0.10.1",
|
||||
"rpc": "bkpr-listincome",
|
||||
"title": "Command for listing all income impacting events",
|
||||
@ -10,6 +9,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"consolidate_fees": {
|
||||
"type": "boolean",
|
||||
@ -38,6 +38,7 @@
|
||||
"required": [
|
||||
"income_events"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"income_events": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.08",
|
||||
"rpc": "blacklistrune",
|
||||
"title": "Command to prevent a rune from working",
|
||||
@ -14,6 +13,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"start": {
|
||||
"type": "u64",
|
||||
@ -38,6 +38,7 @@
|
||||
"required": [
|
||||
"blacklist"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"blacklist": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "check",
|
||||
"title": "Command for verifying parameters",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"command_to_check"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"command_to_check": {
|
||||
"type": "string",
|
||||
@ -25,6 +25,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"command_to_check": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "checkmessage",
|
||||
"title": "Command to check if a signature is from a node",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"message",
|
||||
"zbase"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"message": {
|
||||
"type": "string",
|
||||
@ -40,6 +40,7 @@
|
||||
"verified",
|
||||
"pubkey"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"verified": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.08",
|
||||
"rpc": "checkrune",
|
||||
"title": "Command to Validate Rune",
|
||||
@ -16,6 +15,7 @@
|
||||
"required": [
|
||||
"rune"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
@ -57,6 +57,7 @@
|
||||
"required": [
|
||||
"valid"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"valid": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "close",
|
||||
"title": "Command for closing channels with direct peers",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -75,6 +75,7 @@
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -91,6 +92,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.05",
|
||||
"deprecated": [
|
||||
"v23.08",
|
||||
@ -16,6 +15,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"start": {
|
||||
"type": "u64",
|
||||
@ -40,6 +40,7 @@
|
||||
"required": [
|
||||
"blacklist"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"blacklist": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.05",
|
||||
"deprecated": [
|
||||
"v23.08",
|
||||
@ -16,6 +15,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
@ -29,6 +29,7 @@
|
||||
"required": [
|
||||
"runes"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"runes": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"deprecated": [
|
||||
"v23.08",
|
||||
"v25.02"
|
||||
@ -13,6 +12,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
@ -64,6 +64,7 @@
|
||||
"rune",
|
||||
"unique_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "commando",
|
||||
"title": "Command to Send a Command to a Remote Peer",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
"peer_id",
|
||||
"method"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"peer_id": {
|
||||
"type": "pubkey",
|
||||
@ -57,6 +57,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": true,
|
||||
"properties": {},
|
||||
"pre_return_value_notes": [
|
||||
"On success, the return depends on the *method* invoked."
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "connect",
|
||||
"title": "Command for connecting to another lightning node",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -47,6 +47,7 @@
|
||||
"direction",
|
||||
"address"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -97,6 +98,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -124,6 +126,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "createinvoice",
|
||||
"title": "Low-level invoice creation",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"label",
|
||||
"preimage"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invstring": {
|
||||
"type": "string",
|
||||
@ -50,6 +50,7 @@
|
||||
"description",
|
||||
"expires_at"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"label": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "createonion",
|
||||
"title": "Low-level command to create a custom onion",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
"hops",
|
||||
"assocdata"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"hops": {
|
||||
"type": "array",
|
||||
@ -66,6 +66,7 @@
|
||||
"onion",
|
||||
"shared_secrets"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"onion": {
|
||||
"type": "hex",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.08",
|
||||
"rpc": "createrune",
|
||||
"title": "Command to Create/Update Rune for Authorizing Remote Peer Access",
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
@ -67,6 +67,7 @@
|
||||
"rune",
|
||||
"unique_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"rune": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "datastore",
|
||||
"title": "Command for storing (plugin) data",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"description": [
|
||||
@ -74,6 +74,7 @@
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.11",
|
||||
"rpc": "datastoreusage",
|
||||
"title": "Command for listing datastore usage info",
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"oneOf": [
|
||||
@ -35,6 +35,7 @@
|
||||
"required": [
|
||||
"datastoreusage"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"datastoreusage": {
|
||||
"type": "object",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.05",
|
||||
"rpc": "decode",
|
||||
"title": "Command for decoding an invoice string (low-level)",
|
||||
@ -12,6 +11,7 @@
|
||||
"required": [
|
||||
"string"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"string": {
|
||||
"type": "string",
|
||||
@ -29,6 +29,7 @@
|
||||
"type",
|
||||
"valid"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -54,6 +55,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -394,6 +396,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -479,6 +482,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -965,6 +969,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -1072,6 +1077,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -1758,6 +1764,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -1905,6 +1912,7 @@
|
||||
"version",
|
||||
"hex"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"version": {},
|
||||
"hex": {},
|
||||
@ -1923,6 +1931,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -2161,6 +2170,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -2248,6 +2258,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -2293,6 +2304,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.05",
|
||||
"rpc": "decodepay",
|
||||
"title": "Command for decoding a bolt11 string (low-level)",
|
||||
@ -12,6 +11,7 @@
|
||||
"required": [
|
||||
"bolt11"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"bolt11": {
|
||||
"type": "string",
|
||||
@ -37,6 +37,7 @@
|
||||
"payment_hash",
|
||||
"signature"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"currency": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "deldatastore",
|
||||
"title": "Command for removing (plugin) data",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"oneOf": [
|
||||
@ -42,6 +42,7 @@
|
||||
"required": [
|
||||
"key"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "delforward",
|
||||
"title": "Command for removing a forwarding entry",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"in_htlc_id",
|
||||
"status"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"in_channel": {
|
||||
"type": "short_channel_id",
|
||||
@ -43,6 +43,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"errors": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "delinvoice",
|
||||
"title": "Command for removing an invoice (or just its description)",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
"label",
|
||||
"status"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"label": {
|
||||
"oneOf": [
|
||||
@ -53,6 +53,7 @@
|
||||
"created_index",
|
||||
"expires_at"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"label": {
|
||||
"type": "string",
|
||||
@ -187,6 +188,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "delpay",
|
||||
"title": "Command for removing a completed or failed payment",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
"payment_hash",
|
||||
"status"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"payment_hash": {
|
||||
"type": "hash",
|
||||
@ -53,6 +53,7 @@
|
||||
"required": [
|
||||
"payments"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"payments": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v24.02",
|
||||
"rpc": "deprecations",
|
||||
"title": "Command to enable/disable deprecated APIs",
|
||||
@ -12,6 +11,7 @@
|
||||
"required": [
|
||||
"enable"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enable": {
|
||||
"type": "boolean",
|
||||
@ -22,6 +22,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"errors": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "dev-forget-channel",
|
||||
"title": "Command to remove the DB entries from the database after a close",
|
||||
"warning": "For advanced users only",
|
||||
@ -16,6 +15,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -50,6 +50,7 @@
|
||||
"funding_unspent",
|
||||
"funding_txid"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"forced": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v22.11",
|
||||
"rpc": "disableinvoicerequest",
|
||||
"title": "Command for removing an invoice request",
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"invreq_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invreq_id": {
|
||||
"type": "string",
|
||||
@ -32,6 +32,7 @@
|
||||
"bolt12",
|
||||
"used"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invreq_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "disableoffer",
|
||||
"title": "Command for removing an offer",
|
||||
"warning": "experimental-offers only",
|
||||
@ -14,6 +13,7 @@
|
||||
"required": [
|
||||
"offer_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
@ -31,6 +31,7 @@
|
||||
"bolt12",
|
||||
"used"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "disconnect",
|
||||
"title": "Command for disconnecting from another lightning node",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -27,6 +27,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"errors": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "emergencyrecover",
|
||||
"title": "Command for recovering channels from the emergency.recovery file in the lightning directory",
|
||||
"description": [
|
||||
@ -11,12 +10,14 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
"required": [
|
||||
"stubs"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"stubs": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "disableoffer",
|
||||
"title": "Command for re-enabling an offer",
|
||||
"warning": "experimental-offers only",
|
||||
@ -12,6 +11,7 @@
|
||||
"required": [
|
||||
"offer_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
@ -29,6 +29,7 @@
|
||||
"bolt12",
|
||||
"used"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "feerates",
|
||||
"title": "Command for querying recommended onchain feerates",
|
||||
"description": [
|
||||
@ -23,6 +22,7 @@
|
||||
"required": [
|
||||
"style"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"style": {
|
||||
"type": "string",
|
||||
@ -40,6 +40,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"warning_missing_feerates": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fetchinvoice",
|
||||
"title": "Command for fetch an invoice for an offer",
|
||||
"warning": "experimental-offers only",
|
||||
@ -14,6 +13,7 @@
|
||||
"required": [
|
||||
"offer"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer": {
|
||||
"type": "string",
|
||||
@ -76,6 +76,7 @@
|
||||
"invoice",
|
||||
"changes"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invoice": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fundchannel",
|
||||
"title": "Command for establishing a lightning channel",
|
||||
"description": [
|
||||
@ -18,6 +17,7 @@
|
||||
"id",
|
||||
"amount"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -127,6 +127,7 @@
|
||||
"channel_type",
|
||||
"channel_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"tx": {
|
||||
"type": "hex",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fundchannel_cancel",
|
||||
"title": "Command for completing channel establishment",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -28,6 +28,7 @@
|
||||
"required": [
|
||||
"cancelled"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"cancelled": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fundchannel_complete",
|
||||
"title": "Command for completing channel establishment",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"id",
|
||||
"psbt"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -34,6 +34,7 @@
|
||||
"channel_id",
|
||||
"commitments_secured"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fundchannel_start",
|
||||
"title": "Command for initiating channel establishment for a lightning channel",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
"id",
|
||||
"amount"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -94,6 +94,7 @@
|
||||
"scriptpubkey",
|
||||
"warning_usage"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"funding_address": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "funderupdate",
|
||||
"title": "Command for adjusting node funding v2 channels",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"policy": {
|
||||
"type": "string",
|
||||
@ -152,6 +152,7 @@
|
||||
"fuzz_percent",
|
||||
"fund_probability"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"summary": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "fundpsbt",
|
||||
"title": "Command to populate PSBT inputs from the wallet",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"feerate",
|
||||
"startweight"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"satoshi": {
|
||||
"type": "sat_or_all",
|
||||
@ -88,6 +88,7 @@
|
||||
"estimated_final_weight",
|
||||
"excess_msat"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"psbt": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "getemergencyrecoverdata",
|
||||
"title": "Command to fetch data from the emergency.recover file",
|
||||
"description": [
|
||||
@ -9,12 +8,14 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
"required": [
|
||||
"filedata"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"filedata": {
|
||||
"type": "hex",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "getinfo",
|
||||
"title": "Command to receive all information about the Core Lightning node.",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
@ -30,6 +30,7 @@
|
||||
"lightning-dir",
|
||||
"address"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -179,6 +180,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -233,6 +235,7 @@
|
||||
"required": [
|
||||
"type"
|
||||
],
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -264,6 +267,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
@ -306,6 +310,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "getlog",
|
||||
"title": "Command to show logs.",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"level": {
|
||||
"type": "string",
|
||||
@ -37,6 +37,7 @@
|
||||
"bytes_max",
|
||||
"log"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"created_at": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "getroute",
|
||||
"title": "Command for routing a payment (low-level)",
|
||||
"description": [
|
||||
@ -18,6 +17,7 @@
|
||||
"amount_msat",
|
||||
"riskfactor"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -80,6 +80,7 @@
|
||||
"required": [
|
||||
"route"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"route": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "getroutes",
|
||||
"title": "Command for routing a payment (EXPERIMENTAL)",
|
||||
"added": "v24.08",
|
||||
@ -28,6 +27,7 @@
|
||||
"maxfee_msat",
|
||||
"final_cltv"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"source": {
|
||||
"type": "pubkey",
|
||||
@ -75,6 +75,7 @@
|
||||
"probability_ppm",
|
||||
"routes"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"probability_ppm": {
|
||||
"type": "u64",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "help",
|
||||
"title": "Command to return all information about RPC commands.",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"command": {
|
||||
"type": "string",
|
||||
@ -24,6 +24,7 @@
|
||||
"required": [
|
||||
"help"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"help": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "invoice",
|
||||
"title": "Command for accepting payments",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"label",
|
||||
"description"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"amount_msat": {
|
||||
"type": "msat_or_any",
|
||||
@ -111,6 +111,7 @@
|
||||
"bolt11",
|
||||
"payment_secret"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"bolt11": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v22.11",
|
||||
"rpc": "invoicerequest",
|
||||
"title": "Command for offering payments",
|
||||
@ -14,6 +13,7 @@
|
||||
"amount",
|
||||
"description"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"amount": {
|
||||
"type": "msat",
|
||||
@ -62,6 +62,7 @@
|
||||
"bolt12",
|
||||
"used"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invreq_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "keysend",
|
||||
"title": "Send funds to a node without an invoice",
|
||||
"description": [
|
||||
@ -16,6 +15,7 @@
|
||||
"destination",
|
||||
"amount_msat"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"destination": {
|
||||
"type": "pubkey",
|
||||
@ -123,6 +123,7 @@
|
||||
"amount_sent_msat",
|
||||
"status"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"payment_preimage": {
|
||||
"type": "secret",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listchannels",
|
||||
"title": "Command to query active lightning channels in the entire network",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"short_channel_id": {
|
||||
"type": "short_channel_id",
|
||||
@ -39,6 +39,7 @@
|
||||
"required": [
|
||||
"channels"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channels": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.05",
|
||||
"rpc": "listclosedchannels",
|
||||
"title": "Get data on our closed historical channels",
|
||||
@ -13,6 +12,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -26,6 +26,7 @@
|
||||
"required": [
|
||||
"closedchannels"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"closedchannels": {
|
||||
"type": "array",
|
||||
@ -70,6 +71,7 @@
|
||||
"alias": {
|
||||
"type": "object",
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"local": {
|
||||
"type": "short_channel_id",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listconfigs",
|
||||
"title": "Command to list all configuration options.",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"config": {
|
||||
"type": "string",
|
||||
@ -23,6 +23,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"configs": {
|
||||
"added": "v23.08",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listdatastore",
|
||||
"title": "Command for listing (plugin) data",
|
||||
"description": [
|
||||
@ -9,6 +8,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"key": {
|
||||
"oneOf": [
|
||||
@ -34,6 +34,7 @@
|
||||
"required": [
|
||||
"datastore"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"datastore": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listforwards",
|
||||
"title": "Command showing all htlcs and their information",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -75,6 +75,7 @@
|
||||
"required": [
|
||||
"forwards"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"forwards": {
|
||||
"type": "array",
|
||||
@ -227,6 +228,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -293,6 +295,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listfunds",
|
||||
"title": "Command showing all funds currently managed by the Core Lightning node",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"spent": {
|
||||
"type": "boolean",
|
||||
@ -27,6 +27,7 @@
|
||||
"outputs",
|
||||
"channels"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"outputs": {
|
||||
"type": "array",
|
||||
@ -97,6 +98,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -133,6 +135,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"reserved": {
|
||||
"type": "boolean",
|
||||
@ -254,6 +257,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"state": {
|
||||
"type": "string",
|
||||
@ -290,6 +294,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"state": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listhtlcs",
|
||||
"title": "Command for querying HTLCs",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "string",
|
||||
@ -25,6 +25,7 @@
|
||||
"required": [
|
||||
"htlcs"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"htlcs": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v22.11",
|
||||
"rpc": "listinvoicerequests",
|
||||
"title": "Command for querying invoice_request status",
|
||||
@ -13,6 +12,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invreq_id": {
|
||||
"type": "string",
|
||||
@ -33,6 +33,7 @@
|
||||
"required": [
|
||||
"invoicerequests"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invoicerequests": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listinvoices",
|
||||
"title": "Command for querying invoice status",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"label": {
|
||||
"oneOf": [
|
||||
@ -84,6 +84,7 @@
|
||||
"required": [
|
||||
"invoices"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"invoices": {
|
||||
"type": "array",
|
||||
@ -181,6 +182,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listnodes",
|
||||
"title": "Command to get the list of nodes in the known network.",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -25,6 +25,7 @@
|
||||
"required": [
|
||||
"nodes"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"nodes": {
|
||||
"type": "array",
|
||||
@ -124,6 +125,7 @@
|
||||
}
|
||||
},
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listoffers",
|
||||
"title": "Command for listing offers",
|
||||
"warning": "experimental-offers only",
|
||||
@ -13,6 +12,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
@ -32,6 +32,7 @@
|
||||
"required": [
|
||||
"offers"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offers": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listpays",
|
||||
"title": "Command for querying payment status",
|
||||
"description": [
|
||||
@ -12,6 +11,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"bolt11": {
|
||||
"type": "string",
|
||||
@ -42,6 +42,7 @@
|
||||
"required": [
|
||||
"pays"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"pays": {
|
||||
"type": "array",
|
||||
@ -117,6 +118,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -171,6 +173,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.02",
|
||||
"rpc": "listpeerchannels",
|
||||
"title": "Command returning data on channels of connected lightning nodes",
|
||||
@ -15,6 +14,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -28,6 +28,7 @@
|
||||
"required": [
|
||||
"channels"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channels": {
|
||||
"type": "array",
|
||||
@ -609,6 +610,7 @@
|
||||
"alias": {
|
||||
"type": "object",
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"local": {
|
||||
"type": "short_channel_id",
|
||||
@ -848,6 +850,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"direction": {
|
||||
"enum": [
|
||||
@ -897,6 +900,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"direction": {
|
||||
"enum": [
|
||||
@ -950,6 +954,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"peer_connected": {
|
||||
"type": "boolean",
|
||||
@ -960,6 +965,7 @@
|
||||
}
|
||||
},
|
||||
"then": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"reestablished": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listpeers",
|
||||
"title": "Command returning data on connected lightning nodes",
|
||||
"description": [
|
||||
@ -20,6 +19,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -46,6 +46,7 @@
|
||||
"required": [
|
||||
"peers"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"peers": {
|
||||
"type": "array",
|
||||
@ -106,6 +107,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": [
|
||||
@ -133,6 +135,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": [
|
||||
@ -185,6 +188,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"type": {
|
||||
"enum": [
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listsendpays",
|
||||
"title": "Low-level command for querying sendpay status",
|
||||
"description": [
|
||||
@ -14,6 +13,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"bolt11": {
|
||||
"type": "string",
|
||||
@ -75,6 +75,7 @@
|
||||
"required": [
|
||||
"payments"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"payments": {
|
||||
"type": "array",
|
||||
@ -192,6 +193,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -242,6 +244,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
@ -284,6 +287,7 @@
|
||||
},
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"status": {
|
||||
"type": "string",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"added": "v23.02",
|
||||
"rpc": "listsqlschemas",
|
||||
"title": "Command to example lightning-sql schemas",
|
||||
@ -15,6 +14,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"table": {
|
||||
"type": "string"
|
||||
@ -25,6 +25,7 @@
|
||||
"required": [
|
||||
"schemas"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"schemas": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "listtransactions",
|
||||
"title": "Command to get the list of transactions that was stored in the wallet.",
|
||||
"description": [
|
||||
@ -12,12 +11,14 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {}
|
||||
},
|
||||
"response": {
|
||||
"required": [
|
||||
"transactions"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"transactions": {
|
||||
"type": "array",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "makesecret",
|
||||
"title": "Command for deriving pseudorandom key from HSM",
|
||||
"description": [
|
||||
@ -9,6 +8,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"hex": {
|
||||
"type": "hex",
|
||||
@ -28,6 +28,7 @@
|
||||
"required": [
|
||||
"secret"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"secret": {
|
||||
"type": "secret",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "multifundchannel",
|
||||
"title": "Command for establishing many lightning channels",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"destinations"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"destinations": {
|
||||
"type": "array",
|
||||
@ -131,6 +131,7 @@
|
||||
"txid",
|
||||
"channel_ids"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"tx": {
|
||||
"type": "hex",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "multiwithdraw",
|
||||
"title": "Command for withdrawing to multiple addresses",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"outputs"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"outputs": {
|
||||
"type": "array",
|
||||
@ -51,6 +51,7 @@
|
||||
"tx",
|
||||
"txid"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"tx": {
|
||||
"type": "hex",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "newaddr",
|
||||
"title": "Command for generating a new address to be used by Core Lightning",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
],
|
||||
"request": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"addresstype": {
|
||||
"type": "string",
|
||||
@ -30,6 +30,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"p2tr": {
|
||||
"added": "v23.08",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "notifications",
|
||||
"title": "Command to set up notifications.",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"required": [
|
||||
"enable"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"enable": {
|
||||
"type": "boolean",
|
||||
@ -23,6 +23,7 @@
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"additionalProperties": false,
|
||||
"properties": {},
|
||||
"post_return_value_notes": [
|
||||
"On success, if *enable* was *true*, notifications will be forwarded from then on."
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "offer",
|
||||
"title": "Command for accepting payments",
|
||||
"warning": "experimental-offers only",
|
||||
@ -14,6 +13,7 @@
|
||||
"required": [
|
||||
"amount"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"amount": {
|
||||
"oneOf": [
|
||||
@ -112,6 +112,7 @@
|
||||
"used",
|
||||
"created"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"offer_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "openchannel_abort",
|
||||
"title": "Command to abort a channel to a peer",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"channel_id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
@ -26,6 +26,7 @@
|
||||
"channel_canceled",
|
||||
"reason"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "openchannel_bump",
|
||||
"title": "Command to initiate a channel RBF",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"amount",
|
||||
"initialpsbt"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
@ -51,6 +51,7 @@
|
||||
"commitments_secured",
|
||||
"funding_serial"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "openchannel_init",
|
||||
"title": "Command to initiate a channel to a peer",
|
||||
"description": [
|
||||
@ -13,6 +12,7 @@
|
||||
"amount",
|
||||
"initialpsbt"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -91,6 +91,7 @@
|
||||
"commitments_secured",
|
||||
"funding_serial"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "openchannel_signed",
|
||||
"title": "Command to conclude a channel open",
|
||||
"description": [
|
||||
@ -16,6 +15,7 @@
|
||||
"channel_id",
|
||||
"signed_psbt"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
@ -37,6 +37,7 @@
|
||||
"tx",
|
||||
"txid"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "openchannel_update",
|
||||
"title": "Command to update a collab channel open",
|
||||
"description": [
|
||||
@ -16,6 +15,7 @@
|
||||
"channel_id",
|
||||
"psbt"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
@ -39,6 +39,7 @@
|
||||
"channel_type",
|
||||
"funding_outnum"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"channel_id": {
|
||||
"type": "hash",
|
||||
@ -128,6 +129,7 @@
|
||||
"allOf": [
|
||||
{
|
||||
"if": {
|
||||
"additionalProperties": true,
|
||||
"properties": {
|
||||
"commitments_secured": {
|
||||
"type": "boolean",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "parsefeerate",
|
||||
"title": "Command for parsing a feerate string to a feerate",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"feerate_str"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"feerate_str": {
|
||||
"type": "string",
|
||||
@ -22,6 +22,7 @@
|
||||
},
|
||||
"response": {
|
||||
"required": [],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"perkw": {
|
||||
"type": "u32",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "pay",
|
||||
"title": "Command for sending a payment to a BOLT11 invoice",
|
||||
"description": [
|
||||
@ -15,6 +14,7 @@
|
||||
"required": [
|
||||
"bolt11"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"bolt11": {
|
||||
"type": "string",
|
||||
@ -122,6 +122,7 @@
|
||||
"amount_sent_msat",
|
||||
"status"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"payment_preimage": {
|
||||
"type": "secret",
|
||||
|
||||
@ -1,7 +1,6 @@
|
||||
{
|
||||
"$schema": "../rpc-schema-draft.json",
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"rpc": "ping",
|
||||
"title": "Command to check if a node is up.",
|
||||
"description": [
|
||||
@ -11,6 +10,7 @@
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "pubkey",
|
||||
@ -38,6 +38,7 @@
|
||||
"required": [
|
||||
"totlen"
|
||||
],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"totlen": {
|
||||
"type": "u16",
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user