diff --git a/doc/schemas/addgossip.request.json b/doc/schemas/addgossip.request.json deleted file mode 100644 index 31ce283c1f39..000000000000 --- a/doc/schemas/addgossip.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "message" - ], - "properties": { - "message": { - "type": "hex", - "description": "The raw, hex-encoded, gossip message to add to the local gossip view" - } - } -} diff --git a/doc/schemas/addgossip.schema.json b/doc/schemas/addgossip.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/addgossip.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/addpsbtoutput.request.json b/doc/schemas/addpsbtoutput.request.json deleted file mode 100644 index 7f12b858d583..000000000000 --- a/doc/schemas/addpsbtoutput.request.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "satoshi" - ], - "added": "v23.11", - "properties": { - "satoshi": { - "type": "msat", - "description": "the satoshi value of the output. It can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - }, - "initialpsbt": { - "type": "string", - "description": "base 64 encoded PSBT to add the output to. If not specified, one will be generated automatically" - }, - "locktime": { - "type": "u32", - "description": "if not set, it is set to a recent block height (if no initial psbt is specified)" - }, - "destination": { - "type": "string", - "description": "if it is not set, an internal address is generated" - } - } -} diff --git a/doc/schemas/addpsbtoutput.schema.json b/doc/schemas/addpsbtoutput.schema.json deleted file mode 100644 index 7c2a7aaae4c8..000000000000 --- a/doc/schemas/addpsbtoutput.schema.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt", - "estimated_added_weight", - "outnum" - ], - "added": "v23.11", - "properties": { - "psbt": { - "type": "string", - "description": "Unsigned PSBT which fulfills the parameters given" - }, - "estimated_added_weight": { - "type": "u32", - "description": "The estimated weight of the added output" - }, - "outnum": { - "type": "u32", - "description": "The 0-based number where the output was placed" - } - } -} diff --git a/doc/schemas/autoclean-once.request.json b/doc/schemas/autoclean-once.request.json deleted file mode 100644 index b488202590e4..000000000000 --- a/doc/schemas/autoclean-once.request.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "subsystem", - "age" - ], - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "succeededforwards", - "failedforwards", - "succeededpays", - "failedpays", - "paidinvoices", - "expiredinvoices" - ], - "description": "What subsystem to clean. Currently supported subsystems are:\n\t* `failedforwards`: routed payments which did not succeed (`failed` or `local_failed` in listforwards `status`).\n\t* `succeededforwards`: routed payments which succeeded (`settled` in listforwards `status`).\n\t* `failedpays`: payment attempts which did not succeed (`failed` in listpays `status`).\n\t* `succeededpays`: payment attempts which succeeded (`complete` in listpays `status`).\n\t* `expiredinvoices`: invoices which were not paid (and cannot be) (`expired` in listinvoices `status`).\n\t* `paidinvoices`: invoices which were paid (`paid` in listinvoices `status)" - }, - "age": { - "type": "u64", - "description": "non-zero number in seconds. How many seconds old an entry must be to delete it" - } - } -} diff --git a/doc/schemas/autoclean-once.schema.json b/doc/schemas/autoclean-once.schema.json deleted file mode 100644 index 36e4969bff7c..000000000000 --- a/doc/schemas/autoclean-once.schema.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "autoclean" - ], - "properties": { - "autoclean": { - "type": "object", - "additionalProperties": false, - "properties": { - "succeededforwards": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - }, - "failedforwards": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - }, - "succeededpays": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - }, - "failedpays": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - }, - "paidinvoices": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - }, - "expiredinvoices": { - "type": "object", - "additionalProperties": false, - "required": [ - "cleaned", - "uncleaned" - ], - "properties": { - "cleaned": { - "type": "u64", - "description": "total number of deletions done this run" - }, - "uncleaned": { - "type": "u64", - "description": "the total number of entries *not* deleted this run" - } - } - } - } - } - } -} diff --git a/doc/schemas/autoclean-status.request.json b/doc/schemas/autoclean-status.request.json deleted file mode 100644 index 5ecc42397f47..000000000000 --- a/doc/schemas/autoclean-status.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "succeededforwards", - "failedforwards", - "succeededpays", - "failedpays", - "paidinvoices", - "expiredinvoices" - ], - "description": "What subsystem to ask about. Currently supported subsystems are:\n\t* `failedforwards`: routed payments which did not succeed (`failed` or `local_failed` in listforwards `status`).\n\t* `succeededforwards`: routed payments which succeeded (`settled` in listforwards `status`).\n\t* `failedpays`: payment attempts which did not succeed (`failed` in listpays `status`).\n\t* `succeededpays`: payment attempts which succeeded (`complete` in listpays `status`).\n\t* `expiredinvoices`: invoices which were not paid (and cannot be) (`expired` in listinvoices `status`).\n\t* `paidinvoices`: invoices which were paid (`paid` in listinvoices `status)" - } - } -} diff --git a/doc/schemas/autoclean-status.schema.json b/doc/schemas/autoclean-status.schema.json deleted file mode 100644 index bb5234f7b299..000000000000 --- a/doc/schemas/autoclean-status.schema.json +++ /dev/null @@ -1,346 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "autoclean" - ], - "properties": { - "autoclean": { - "type": "object", - "additionalProperties": false, - "properties": { - "succeededforwards": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for successful listforwards" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to delete successful listforwards" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - }, - "failedforwards": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for failed listforwards" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to delete failed listforwards" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - }, - "succeededpays": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for successful listpays/listsendpays" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to delete successful listpays/listsendpays" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - }, - "failedpays": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for failed listpays/listsendpays" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to delete failed listpays/listsendpays" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - }, - "paidinvoices": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for paid listinvoices" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to paid listinvoices" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - }, - "expiredinvoices": { - "type": "object", - "additionalProperties": true, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "whether autocleaning is enabled for expired (unpaid) listinvoices" - }, - "cleaned": { - "type": "u64", - "description": "total number of deletions done (ever)" - } - }, - "if": { - "properties": { - "enabled": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "enabled", - "age", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {}, - "age": { - "type": "u64", - "description": "age (in seconds) to expired listinvoices" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "enabled", - "cleaned" - ], - "properties": { - "enabled": {}, - "cleaned": {} - } - } - } - } - } - } -} diff --git a/doc/schemas/batching.request.json b/doc/schemas/batching.request.json deleted file mode 100644 index d4cd745ad1e7..000000000000 --- a/doc/schemas/batching.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "enable" - ], - "properties": { - "enable": { - "type": "boolean", - "description": "whether to enable or disable transaction batching. Defaults to *False*" - } - } -} diff --git a/doc/schemas/batching.schema.json b/doc/schemas/batching.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/batching.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/bkpr-channelsapy.request.json b/doc/schemas/bkpr-channelsapy.request.json deleted file mode 100644 index 16d696292933..000000000000 --- a/doc/schemas/bkpr-channelsapy.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "start_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) to filter events after the provided timestamp. Defaults to zero" - }, - "end_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) to filter events up to and at the provided timestamp. Defaults to max-int" - } - } -} \ No newline at end of file diff --git a/doc/schemas/bkpr-channelsapy.schema.json b/doc/schemas/bkpr-channelsapy.schema.json deleted file mode 100644 index d66161037d1e..000000000000 --- a/doc/schemas/bkpr-channelsapy.schema.json +++ /dev/null @@ -1,124 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channels_apy" - ], - "properties": { - "channels_apy": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "account", - "routed_out_msat", - "routed_in_msat", - "lease_fee_paid_msat", - "lease_fee_earned_msat", - "pushed_out_msat", - "pushed_in_msat", - "our_start_balance_msat", - "channel_start_balance_msat", - "fees_out_msat", - "utilization_out", - "utilization_in", - "apy_out", - "apy_in", - "apy_total" - ], - "properties": { - "account": { - "type": "string", - "description": "The account name. If the account is a channel, the channel_id. The 'net' entry is the rollup of all channel accounts" - }, - "routed_out_msat": { - "type": "msat", - "description": "Sats routed (outbound)" - }, - "routed_in_msat": { - "type": "msat", - "description": "Sats routed (inbound)" - }, - "lease_fee_paid_msat": { - "type": "msat", - "description": "Sats paid for leasing inbound (liquidity ads)" - }, - "lease_fee_earned_msat": { - "type": "msat", - "description": "Sats earned for leasing outbound (liquidity ads)" - }, - "pushed_out_msat": { - "type": "msat", - "description": "Sats pushed to peer at open" - }, - "pushed_in_msat": { - "type": "msat", - "description": "Sats pushed in from peer at open" - }, - "our_start_balance_msat": { - "type": "msat", - "description": "Starting balance in channel at funding. Note that if our start balance is zero, any _initial field will be omitted (can't divide by zero)" - }, - "channel_start_balance_msat": { - "type": "msat", - "description": "Total starting balance at funding" - }, - "fees_out_msat": { - "type": "msat", - "description": "Fees earned on routed outbound" - }, - "fees_in_msat": { - "type": "msat", - "description": "Fees earned on routed inbound" - }, - "utilization_out": { - "type": "string", - "description": "Sats routed outbound / total start balance" - }, - "utilization_out_initial": { - "type": "string", - "description": "Sats routed outbound / our start balance" - }, - "utilization_in": { - "type": "string", - "description": "Sats routed inbound / total start balance" - }, - "utilization_in_initial": { - "type": "string", - "description": "Sats routed inbound / our start balance" - }, - "apy_out": { - "type": "string", - "description": "Fees earned on outbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_out_initial": { - "type": "string", - "description": "Fees earned on outbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_in": { - "type": "string", - "description": "Fees earned on inbound routed payments / total start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_in_initial": { - "type": "string", - "description": "Fees earned on inbound routed payments / our start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_total": { - "type": "string", - "description": "Total fees earned on routed payments / total start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_total_initial": { - "type": "string", - "description": "Total fees earned on routed payments / our start balance for the length of time this channel has been open amortized to a year (APY)" - }, - "apy_lease": { - "type": "string", - "description": "Lease fees earned over total amount leased for the lease term, amortized to a year (APY). Only appears if channel was leased out by us" - } - } - } - } - } -} diff --git a/doc/schemas/bkpr-dumpincomecsv.request.json b/doc/schemas/bkpr-dumpincomecsv.request.json deleted file mode 100644 index 33f1fcbd74a1..000000000000 --- a/doc/schemas/bkpr-dumpincomecsv.request.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["csv_format"], - "properties": { - "csv_format": { - "type": "string", - "description": "CSV format to use. See RETURN VALUE for options" - }, - "csv_file": { - "type": "string", - "description": "on-disk destination of the generated CSV file" - }, - "consolidate_fees": { - "type": "boolean", - "description": "if true, we emit a single, consolidated event for any onchain-fees for a txid and account. Otherwise, events for every update to the onchain fee calculation for this account and txid will be printed. Defaults to true. Note that this means that the events emitted are non-stable, i.e. calling **dumpincomecsv** twice may result in different onchain fee events being emitted, depending on how much information we've logged for that transaction" - }, - "start_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) that filters events after the provided timestamp. Defaults to zero" - }, - "end_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) that filters events up to and at the provided timestamp. Defaults to max-int" - } - } -} \ No newline at end of file diff --git a/doc/schemas/bkpr-dumpincomecsv.schema.json b/doc/schemas/bkpr-dumpincomecsv.schema.json deleted file mode 100644 index fe3da41d536a..000000000000 --- a/doc/schemas/bkpr-dumpincomecsv.schema.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "unevaluatedProperties": false, - "required": [ - "csv_file", - "csv_format" - ], - "properties": { - "csv_file": { - "type": "string", - "description": "File that the csv was generated to" - }, - "csv_format": { - "type": "string", - "enum": [ - "cointracker", - "koinly", - "harmony", - "quickbooks" - ], - "description": "Format to print csv as" - } - } -} diff --git a/doc/schemas/bkpr-inspect.request.json b/doc/schemas/bkpr-inspect.request.json deleted file mode 100644 index 20e95ddd1868..000000000000 --- a/doc/schemas/bkpr-inspect.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["account"], - "properties": { - "account": { - "type": "string", - "description": "channel account to inspect" - } - } -} \ No newline at end of file diff --git a/doc/schemas/bkpr-inspect.schema.json b/doc/schemas/bkpr-inspect.schema.json deleted file mode 100644 index 24ab7504f200..000000000000 --- a/doc/schemas/bkpr-inspect.schema.json +++ /dev/null @@ -1,150 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "txs" - ], - "properties": { - "txs": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "txid", - "fees_paid_msat", - "outputs" - ], - "properties": { - "txid": { - "type": "txid", - "description": "transaction id" - }, - "blockheight": { - "type": "u32", - "description": "Blockheight of transaction" - }, - "fees_paid_msat": { - "type": "msat", - "description": "Amount paid in sats for this tx" - }, - "outputs": { - "type": "array", - "items": { - "type": "object", - "required": [ - "account", - "outnum", - "output_value_msat", - "currency" - ], - "additionalProperties": false, - "properties": { - "account": { - "type": "string", - "description": "Account this output affected" - }, - "outnum": { - "type": "u32", - "description": "Index of output" - }, - "output_value_msat": { - "type": "msat", - "description": "Value of the output" - }, - "currency": { - "type": "string", - "description": "human-readable bech32 part for this coin type" - }, - "credit_msat": { - "type": "msat", - "description": "Amount credited to account" - }, - "debit_msat": { - "type": "msat", - "description": "Amount debited from account" - }, - "originating_account": { - "type": "string", - "description": "Account this output originated from" - }, - "output_tag": { - "type": "string", - "description": "Description of output creation event" - }, - "spend_tag": { - "type": "string", - "description": "Description of output spend event" - }, - "spending_txid": { - "type": "txid", - "description": "Transaction this output was spent in" - }, - "payment_id": { - "type": "hex", - "description": "lightning payment identifier. For an htlc, this will be the preimage." - } - }, - "allOf": [ - { - "if": { - "required": [ - "credit_msat" - ] - }, - "then": { - "required": [ - "output_tag" - ], - "additionalProperties": false, - "properties": { - "account": {}, - "outnum": {}, - "output_value_msat": {}, - "currency": {}, - "credit_msat": {}, - "originating_account": {}, - "debit_msat": {}, - "output_tag": {}, - "spend_tag": {}, - "spending_txid": {}, - "payment_id": {} - } - } - }, - { - "if": { - "required": [ - "spending_txid" - ] - }, - "then": { - "required": [ - "spend_tag", - "debit_msat" - ], - "additionalProperties": false, - "properties": { - "account": {}, - "outnum": {}, - "output_value_msat": {}, - "currency": {}, - "credit_msat": {}, - "originating_account": {}, - "debit_msat": {}, - "output_tag": {}, - "spend_tag": {}, - "spending_txid": {}, - "payment_id": {} - } - } - } - ] - } - } - } - } - } - } -} diff --git a/doc/schemas/bkpr-listaccountevents.request.json b/doc/schemas/bkpr-listaccountevents.request.json deleted file mode 100644 index 2a70367aa9b8..000000000000 --- a/doc/schemas/bkpr-listaccountevents.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "account": { - "type": "string", - "description": "receive events for the specified account" - } - } -} \ No newline at end of file diff --git a/doc/schemas/bkpr-listaccountevents.schema.json b/doc/schemas/bkpr-listaccountevents.schema.json deleted file mode 100644 index 45c98c0f3f37..000000000000 --- a/doc/schemas/bkpr-listaccountevents.schema.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "events" - ], - "properties": { - "events": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "account", - "type", - "tag", - "credit_msat", - "debit_msat", - "currency", - "timestamp" - ], - "properties": { - "account": { - "type": "string", - "description": "The account name. If the account is a channel, the channel_id" - }, - "type": { - "type": "string", - "enum": [ - "onchain_fee", - "chain", - "channel" - ], - "description": "Coin movement type" - }, - "tag": { - "type": "string", - "description": "Description of movement" - }, - "credit_msat": { - "type": "msat", - "description": "Amount credited" - }, - "debit_msat": { - "type": "msat", - "description": "Amount debited" - }, - "currency": { - "type": "string", - "description": "human-readable bech32 part for this coin type" - }, - "timestamp": { - "type": "u32", - "description": "Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp" - } - }, - "allOf": [ - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "chain" - ] - } - } - }, - "then": { - "properties": { - "account": {}, - "type": {}, - "tag": {}, - "credit_msat": {}, - "debit_msat": {}, - "currency": {}, - "timestamp": {}, - "outpoint": { - "type": "string", - "description": "The txid:outnum for this event" - }, - "blockheight": { - "type": "u32", - "description": "For chain events, blockheight this occured at" - }, - "origin": { - "type": "string", - "description": "The account this movement originated from" - }, - "payment_id": { - "type": "hex", - "description": "lightning payment identifier. For an htlc, this will be the preimage." - }, - "txid": { - "type": "txid", - "description": "The txid of the transaction that created this event" - }, - "description": { - "type": "string", - "description": "The description of this event" - } - }, - "required": [ - "outpoint", - "blockheight" - ], - "additionalProperties": false - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "onchain_fee" - ] - } - } - }, - "then": { - "properties": { - "account": {}, - "type": {}, - "tag": {}, - "credit_msat": {}, - "debit_msat": {}, - "currency": {}, - "timestamp": {}, - "description": {}, - "txid": { - "type": "txid", - "description": "The txid of the transaction that created this event" - } - }, - "required": [ - "txid" - ], - "additionalProperties": false - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "channel" - ] - } - } - }, - "then": { - "properties": { - "account": {}, - "type": {}, - "tag": {}, - "credit_msat": {}, - "debit_msat": {}, - "currency": {}, - "timestamp": {}, - "description": {}, - "fees_msat": { - "type": "msat", - "description": "Amount paid in fees" - }, - "is_rebalance": { - "type": "boolean", - "description": "Is this payment part of a rebalance" - }, - "payment_id": { - "type": "hex", - "description": "lightning payment identifier. For an htlc, this will be the preimage." - }, - "part_id": { - "type": "u32", - "description": "Counter for multi-part payments" - } - }, - "additionalProperties": false - } - } - ] - } - } - } -} diff --git a/doc/schemas/bkpr-listbalances.request.json b/doc/schemas/bkpr-listbalances.request.json deleted file mode 100644 index 79c038cf8221..000000000000 --- a/doc/schemas/bkpr-listbalances.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": {} -} \ No newline at end of file diff --git a/doc/schemas/bkpr-listbalances.schema.json b/doc/schemas/bkpr-listbalances.schema.json deleted file mode 100644 index 85c4395522b7..000000000000 --- a/doc/schemas/bkpr-listbalances.schema.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "accounts" - ], - "properties": { - "accounts": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "account", - "balances" - ], - "properties": { - "account": { - "type": "string", - "description": "The account name. If the account is a channel, the channel_id" - }, - "balances": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "balance_msat", - "coin_type" - ], - "properties": { - "balance_msat": { - "type": "msat", - "description": "Current account balance" - }, - "coin_type": { - "type": "string", - "description": "coin type, same as HRP for bech32" - } - } - } - } - }, - "if": { - "required": [ - "peer_id" - ] - }, - "then": { - "required": [ - "account", - "balances", - "peer_id", - "we_opened", - "account_closed", - "account_resolved" - ], - "additionalProperties": false, - "properties": { - "account": {}, - "balances": {}, - "peer_id": { - "type": "pubkey", - "description": "Node id for the peer this account is with" - }, - "we_opened": { - "type": "boolean", - "description": "Did we initiate this account open (open the channel)" - }, - "account_closed": { - "type": "boolean", - "description": "" - }, - "account_resolved": { - "type": "boolean", - "description": "Has this channel been closed and all outputs resolved?" - }, - "resolved_at_block": { - "type": "u32", - "description": "Blockheight account resolved on chain" - } - } - }, - "else": { - "properties": { - "account": {}, - "balances": {} - }, - "additionalProperties": false - } - } - } - } -} diff --git a/doc/schemas/bkpr-listincome.request.json b/doc/schemas/bkpr-listincome.request.json deleted file mode 100644 index 535233eeb807..000000000000 --- a/doc/schemas/bkpr-listincome.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "consolidate_fees": { - "type": "boolean", - "description": "if true, we emit a single, consolidated event for any onchain-fees for a txid and account. Otherwise, events for every update to the onchain fee calculation for this account and txid will be printed. Defaults to true. Note that this means that the events emitted are non-stable, i.e. calling **listincome** twice may result in different onchain fee events being emitted, depending on how much information we've logged for that transaction" - }, - "start_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) that filters events after the provided timestamp. Defaults to zero" - }, - "end_time": { - "type": "integer", - "description": "UNIX timestamp (in seconds) that filters events up to and at the provided timestamp. Defaults to max-int" - } - } -} \ No newline at end of file diff --git a/doc/schemas/bkpr-listincome.schema.json b/doc/schemas/bkpr-listincome.schema.json deleted file mode 100644 index 147dc484c350..000000000000 --- a/doc/schemas/bkpr-listincome.schema.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "income_events" - ], - "properties": { - "income_events": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "account", - "tag", - "credit_msat", - "debit_msat", - "currency", - "timestamp" - ], - "properties": { - "account": { - "type": "string", - "description": "The account name. If the account is a channel, the channel_id" - }, - "tag": { - "type": "string", - "description": "Type of income event" - }, - "credit_msat": { - "type": "msat", - "description": "Amount earned (income)" - }, - "debit_msat": { - "type": "msat", - "description": "Amount spent (expenses)" - }, - "currency": { - "type": "string", - "description": "human-readable bech32 part for this coin type" - }, - "timestamp": { - "type": "u32", - "description": "Timestamp this event was recorded by the node. For consolidated events such as onchain_fees, the most recent timestamp" - }, - "description": { - "type": "string", - "description": "More information about this event. If a `invoice` type, typically the bolt11/bolt12 description" - }, - "outpoint": { - "type": "string", - "description": "The txid:outnum for this event, if applicable" - }, - "txid": { - "type": "txid", - "description": "The txid of the transaction that created this event, if applicable" - }, - "payment_id": { - "type": "hex", - "description": "lightning payment identifier. For an htlc, this will be the preimage." - } - } - } - } - } -} diff --git a/doc/schemas/blacklistrune.request.json b/doc/schemas/blacklistrune.request.json deleted file mode 100644 index e2d16b2ab3e5..000000000000 --- a/doc/schemas/blacklistrune.request.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.08", - "properties": { - "start": { - "type": "u64", - "description": "first rune unique id to blacklist" - }, - "end": { - "type": "u64", - "description": "final rune unique id to blacklist (defaults to start)" - } - } -} diff --git a/doc/schemas/blacklistrune.schema.json b/doc/schemas/blacklistrune.schema.json deleted file mode 100644 index 86fb093862b4..000000000000 --- a/doc/schemas/blacklistrune.schema.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "blacklist" - ], - "properties": { - "blacklist": { - "type": "array", - "description": "the resulting blacklist ranges after the command", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "start", - "end" - ], - "properties": { - "start": { - "type": "u64", - "description": "Unique id of first rune in this blacklist range" - }, - "end": { - "type": "u64", - "description": "Unique id of last rune in this blacklist range" - } - } - } - } - } -} diff --git a/doc/schemas/check.request.json b/doc/schemas/check.request.json deleted file mode 100644 index 86b132f151db..000000000000 --- a/doc/schemas/check.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["command_to_check"], - "properties": { - "command_to_check": { - "type": "string", - "description": "name of the relevant command" - }, - "parameters": { - "type": "object", - "description": "command parameters" - } - } -} \ No newline at end of file diff --git a/doc/schemas/check.schema.json b/doc/schemas/check.schema.json deleted file mode 100644 index 5b4010afb3ba..000000000000 --- a/doc/schemas/check.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": { - "command_to_check": { - "type": "string", - "description": "the *command_to_check* argument" - } - }, - "required": [ - "command_to_check" - ] -} diff --git a/doc/schemas/checkmessage.request.json b/doc/schemas/checkmessage.request.json deleted file mode 100644 index 1648245f473d..000000000000 --- a/doc/schemas/checkmessage.request.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "message", - "zbase" - ], - "properties": { - "message": { - "type": "string", - "description": "Message to be checked against the signature" - }, - "zbase": { - "type": "string", - "description": "The Zbase32 encoded signature to verify" - }, - "pubkey": { - "type": "pubkey", - "description": "The Zbase32 encoded signature to verify" - } - } -} diff --git a/doc/schemas/checkmessage.schema.json b/doc/schemas/checkmessage.schema.json deleted file mode 100644 index 0bc52e7e667a..000000000000 --- a/doc/schemas/checkmessage.schema.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "verified", - "pubkey" - ], - "additionalProperties": false, - "properties": { - "verified": { - "type": "boolean", - "enum": [ - true - ], - "description": "whether the signature was valid" - }, - "pubkey": { - "type": "pubkey", - "description": "the *pubkey* parameter, or the pubkey found by looking for known nodes" - } - } -} diff --git a/doc/schemas/checkrune.request.json b/doc/schemas/checkrune.request.json deleted file mode 100644 index 83d0fa476027..000000000000 --- a/doc/schemas/checkrune.request.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "rune" - ], - "added": "v23.08", - "properties": { - "rune": { - "type": "string", - "description": "rune to check for authorization" - }, - "nodeid": { - "type": "string", - "description": "node id of requesting node *(required until v23.11)*" - }, - "method": { - "type": "string", - "description": "method for which rune needs to be validated *(required until v23.11)*" - }, - "params": { - "oneOf": [ - { - "type": "array", - "description": "array of positional parameters" - }, - { - "type": "object", - "description": "parameters for method" - } - ] - } - } -} diff --git a/doc/schemas/checkrune.schema.json b/doc/schemas/checkrune.schema.json deleted file mode 100644 index 3262c3bd3e0a..000000000000 --- a/doc/schemas/checkrune.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "valid" - ], - "properties": { - "valid": { - "type": "boolean", - "description": "true if the rune is valid" - } - } -} diff --git a/doc/schemas/close.request.json b/doc/schemas/close.request.json deleted file mode 100644 index 9386d1d644ba..000000000000 --- a/doc/schemas/close.request.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "peer id, channel id or short_channel_id. If the given *id* is a peer ID (66 hex digits as a string), then it applies to the active channel of the direct peer corresponding to the given peer ID. If the given *id* is a channel ID (64 hex digits as a string, or the short channel ID *blockheight:txindex:outindex* form), then it applies to that channel" - }, - "unilateraltimeout": { - "type": "u32", - "description": "if it is not zero, the command will unilaterally close the channel when that number of seconds is reached. If *unilateraltimeout* is zero, then the command will wait indefinitely until the peer is online and can negotiate a mutual close. The default is 2 days (172800 seconds)" - }, - "destination": { - "type": "string", - "description": "any Bitcoin bech32 type. If it isn't specified, the default is a Core Lightning wallet address. If the peer hasn't offered the option_shutdown_anysegwit` feature, then taproot addresses (or other v1+ segwit) are not allowed. Tell your friends to upgrade!" - }, - "fee_negotiation_step": { - "type": "string", - "description": "it controls how closing fee negotiation is performed assuming the peer proposes a fee that is different than our estimate. (Note that modern peers use the quick-close protocol which does not allow negotiation: see *feerange* instead)\n\n\tOn every negotiation step we must give up some amount from our proposal towards the peer's proposal. This parameter can be an integer in which case it is interpreted as number of satoshis to step at a time. Or it can be an integer followed by `%` to designate a percentage of the interval to give up. A few examples, assuming the peer proposes a closing fee of 3000 satoshi and our estimate shows it must be 4000:\n\n\t- `10`: our next proposal will be 4000-10=3990.\n\t- `10%`: our next proposal will be 4000-(10% of (4000-3000))=3900.\n\t- '1': our next proposal will be 3999. This is the most extreme case when we insist on our fee as much as possible.\n\t- `100%`: our next proposal will be 3000. This is the most relaxed case when we quickly accept the peer's proposal.\n\tThe default is `50%`" - }, - "wrong_funding": { - "type": "outpoint", - "description": "it can only be specified if both sides have offered the `shutdown_wrong_funding` feature (enabled by the **experimental-shutdown-wrong-funding** option): it must be a transaction id followed by a colon then the output number. Instead of negotiating a shutdown to spend the expected funding transaction, the shutdown transaction will spend this output instead. This is only allowed if this peer opened the channel and the channel is unused: it can rescue openings which have been manually miscreated" - }, - "force_lease_closed": { - "type": "boolean", - "description": "if the channel has funds leased to the peer (option_will_fund), we prevent initiation of a mutual close unless this flag is passed in. Defaults to false" - }, - "feerange": { - "type": "array", - "items": { - "type": "feerate" - }, - "description": "an optional array [ *min*, *max* ], indicating the minimum and maximum feerates to offer: the peer will obey these if it supports the quick-close protocol. *slow* and *unilateral_close* are the defaults.\n\tNote that the maximum fee will be capped at the final commitment transaction fee (unless the experimental anchor-outputs option is negotiated)" - } - } -} diff --git a/doc/schemas/close.schema.json b/doc/schemas/close.schema.json deleted file mode 100644 index 8e547dae3dfb..000000000000 --- a/doc/schemas/close.schema.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "mutual", - "unilateral", - "unopened" - ], - "description": "Whether we successfully negotiated a mutual close, closed without them, or discarded not-yet-opened channel" - } - }, - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "mutual", - "unilateral" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "tx", - "txid" - ], - "properties": { - "type": {}, - "tx": { - "type": "hex", - "description": "the raw bitcoin transaction used to close the channel (if it was open)" - }, - "txid": { - "type": "txid", - "description": "the transaction id of the *tx* field" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "type": {} - } - } -} diff --git a/doc/schemas/commando-blacklist.request.json b/doc/schemas/commando-blacklist.request.json deleted file mode 100644 index 72e3d9c2ec3a..000000000000 --- a/doc/schemas/commando-blacklist.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.05", - "deprecated": "v23.08", - "properties": { - "start": { - "type": "u64", - "description": "first rune unique id to blacklist" - }, - "end": { - "type": "u64", - "description": "final rune unique id to blacklist (defaults to start)" - } - } -} diff --git a/doc/schemas/commando-blacklist.schema.json b/doc/schemas/commando-blacklist.schema.json deleted file mode 100644 index 86fb093862b4..000000000000 --- a/doc/schemas/commando-blacklist.schema.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "blacklist" - ], - "properties": { - "blacklist": { - "type": "array", - "description": "the resulting blacklist ranges after the command", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "start", - "end" - ], - "properties": { - "start": { - "type": "u64", - "description": "Unique id of first rune in this blacklist range" - }, - "end": { - "type": "u64", - "description": "Unique id of last rune in this blacklist range" - } - } - } - } - } -} diff --git a/doc/schemas/commando-listrunes.request.json b/doc/schemas/commando-listrunes.request.json deleted file mode 100644 index eb65629ea725..000000000000 --- a/doc/schemas/commando-listrunes.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.05", - "deprecated": "v23.08", - "properties": { - "rune": { - "type": "string", - "description": "optional rune to list" - } - } -} diff --git a/doc/schemas/commando-listrunes.schema.json b/doc/schemas/commando-listrunes.schema.json deleted file mode 100644 index 0fa759100f1f..000000000000 --- a/doc/schemas/commando-listrunes.schema.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "runes" - ], - "properties": { - "runes": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "rune", - "unique_id", - "restrictions", - "restrictions_as_english" - ], - "properties": { - "rune": { - "type": "string", - "description": "Base64 encoded rune" - }, - "unique_id": { - "type": "string", - "description": "Unique id assigned when the rune was generated; this is always a u64 for commando runes" - }, - "restrictions": { - "type": "array", - "description": "The restrictions on what commands this rune can authorize", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "alternatives", - "english" - ], - "properties": { - "alternatives": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "fieldname", - "value", - "condition", - "english" - ], - "properties": { - "fieldname": { - "type": "string", - "description": "The field this restriction applies to; see commando-rune(7)" - }, - "value": { - "type": "string", - "description": "The value accepted for this field" - }, - "condition": { - "type": "string", - "description": "The way to compare fieldname and value" - }, - "english": { - "type": "string", - "description": "English readable description of this alternative" - } - } - } - }, - "english": { - "type": "string", - "description": "English readable summary of alternatives above" - } - } - } - }, - "restrictions_as_english": { - "type": "string", - "description": "English readable description of the restrictions array above" - }, - "stored": { - "type": "boolean", - "enum": [ - false - ], - "description": "This is false if the rune does not appear in our datastore (only possible when `rune` is specified)" - }, - "blacklisted": { - "type": "boolean", - "enum": [ - true - ], - "description": "The rune has been blacklisted; see commando-blacklist(7)" - }, - "last_used": { - "type": "number", - "description": "The last time this rune was successfully used", - "added": "23.11" - }, - "our_rune": { - "type": "boolean", - "enum": [ - false - ], - "description": "This is not a rune for this node (only possible when `rune` is specified)" - } - } - } - } - } -} diff --git a/doc/schemas/commando-rune.request.json b/doc/schemas/commando-rune.request.json deleted file mode 100644 index b5007b16af40..000000000000 --- a/doc/schemas/commando-rune.request.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "deprecated": "v23.08", - "properties": { - "rune": { - "type": "string", - "description": "optional rune to add to" - }, - "restrictions": { - "oneOf": [ - { - "type": "array", - "description": "array of restrictions to add to rune", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "type": "string", - "enum": [ - "readonly" - ], - "description": "readonly string to indicate standard readonly restrictions" - } - ] - } - } -} diff --git a/doc/schemas/commando-rune.schema.json b/doc/schemas/commando-rune.schema.json deleted file mode 100644 index 2bb8483aa21e..000000000000 --- a/doc/schemas/commando-rune.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "rune", - "unique_id" - ], - "properties": { - "rune": { - "type": "string", - "description": "the resulting rune" - }, - "unique_id": { - "type": "string", - "description": "the id of this rune: this is set at creation and cannot be changed (even as restrictions are added)" - }, - "warning_unrestricted_rune": { - "type": "string", - "description": "A warning shown when runes are created with powers that could drain your node" - } - } -} diff --git a/doc/schemas/commando.request.json b/doc/schemas/commando.request.json deleted file mode 100644 index 80da4b98a555..000000000000 --- a/doc/schemas/commando.request.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "peer_id", - "method" - ], - "properties": { - "peer_id": { - "type": "pubkey", - "description": "peer to command" - }, - "method": { - "type": "string", - "description": "method to invoke on peer" - }, - "params": { - "oneOf": [ - { - "type": "array", - "description": "array of positional parameters" - }, - { - "type": "object", - "description": "parameters for method" - } - ] - }, - "rune": { - "type": "string", - "description": "rune to authorize the command" - }, - "filter": { - "type": "object", - "additionalProperties": true, - "description": "filter to peer to apply to any successful result" - } - } -} diff --git a/doc/schemas/commando.schema.json b/doc/schemas/commando.schema.json deleted file mode 100644 index dd8cbd873345..000000000000 --- a/doc/schemas/commando.schema.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "any": { - "type": "object", - "description": "the return depends on the *method* invoked" - } - } -} diff --git a/doc/schemas/connect.request.json b/doc/schemas/connect.request.json deleted file mode 100644 index 2e7462d9c84b..000000000000 --- a/doc/schemas/connect.request.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "the target node's public key. As a convenience, *id* may be of the form *id@host* or *id@host:port*. In this case, the *host* and *port* parameters must be omitted. This can fail if your C-lightning node is a fresh install that has not connected to any peers yet (your node has no gossip yet), or if the target *id* is a fresh install that has no channels yet (nobody will gossip about a node until it has one published channel)" - }, - "host": { - "type": "string", - "description": "the peer's hostname or IP address.\n\tIf *host* is not specified (or doesn't work), the connection will be attempted to an IP belonging to *id* obtained through gossip with other already connected peers.\n\tIf *host* begins with a `/` it is interpreted as a local path and the connection will be made to that local socket (see **bind-addr** in lightningd-config(5))" - }, - "port": { - "type": "u16", - "description": "the peer's port number. If not specified, the *port* depends on the current network:\n\t- bitcoin **mainnet**: 9735.\n\t- bitcoin **testnet**: 19735.\n\t- bitcoin **signet**: 39735.\n\t- bitcoin **regtest**: 19846" - } - } -} diff --git a/doc/schemas/connect.schema.json b/doc/schemas/connect.schema.json deleted file mode 100644 index 557292b652c5..000000000000 --- a/doc/schemas/connect.schema.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "features", - "direction", - "address" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "the peer we connected to" - }, - "features": { - "type": "hex", - "description": "BOLT 9 features bitmap offered by peer" - }, - "direction": { - "type": "string", - "enum": [ - "in", - "out" - ], - "description": "Whether they initiated connection or we did" - }, - "address": { - "type": "object", - "description": "Address information (mainly useful if **direction** is *out*)", - "additionalProperties": true, - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "local socket", - "ipv4", - "ipv6", - "torv2", - "torv3" - ], - "description": "Type of connection (*torv2*/*torv3* only if **direction** is *out*)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "local socket" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "socket" - ], - "properties": { - "type": {}, - "socket": { - "type": "string", - "description": "socket filename" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "ipv4", - "ipv6", - "torv2", - "torv3" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "address", - "port" - ], - "properties": { - "type": {}, - "address": { - "type": "string", - "description": "address in expected format for **type**" - }, - "port": { - "type": "u16", - "description": "port number" - } - } - } - } - ] - } - } -} diff --git a/doc/schemas/createinvoice.request.json b/doc/schemas/createinvoice.request.json deleted file mode 100644 index a931aa81cadf..000000000000 --- a/doc/schemas/createinvoice.request.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invstring", - "label", - "preimage" - ], - "properties": { - "invstring": { - "type": "string", - "description": "the bolt11 form, but the final signature is ignored. Minimal sanity checks are done. (Note: if **experimental-offers** is enabled, *invstring* can actually be an unsigned bolt12 invoice)" - }, - "label": { - "type": "string", - "description": "a unique string or number (which is treated as a string, so `01` is different from `1`); it is never revealed to other nodes on the lightning network, but it can be used to query the status of this invoice" - }, - "preimage": { - "type": "hex", - "description": "the preimage to supply upon successful payment of the invoice" - } - } -} diff --git a/doc/schemas/createinvoice.schema.json b/doc/schemas/createinvoice.schema.json deleted file mode 100644 index d01e8a39315f..000000000000 --- a/doc/schemas/createinvoice.schema.json +++ /dev/null @@ -1,105 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "label", - "created_index", - "payment_hash", - "status", - "description", - "expires_at" - ], - "properties": { - "label": { - "type": "string", - "description": "the label for the invoice" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (always present unless **bolt12** is)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string instead of **bolt11** (**experimental-offers** only)" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "amount_msat": { - "type": "msat", - "description": "The amount of the invoice (if it has one)" - }, - "status": { - "type": "string", - "enum": [ - "paid", - "expired", - "unpaid" - ], - "description": "Whether it has been paid, or can no longer be paid" - }, - "description": { - "type": "string", - "description": "Description extracted from **bolt11** or **bolt12**" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when invoice expires (or expired)" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "pay_index": { - "type": "u64", - "description": "Incrementing id for when this was paid (**status** *paid* only)" - }, - "amount_received_msat": { - "type": "msat", - "description": "Amount actually received (**status** *paid* only)" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when invoice was paid (**status** *paid* only)" - }, - "paid_outpoint": { - "type": "object", - "description": "Outpoint this invoice was paid with (**status** *paid* only)", - "added": "v23.11", - "additionalProperties": false, - "required": [ - "txid", - "outnum" - ], - "properties": { - "txid": { - "added": "v23.11", - "type": "txid", - "description": "ID of the transaction that paid the invoice (**status** *paid* only)" - }, - "outnum": { - "added": "v23.11", - "type": "u32", - "description": "The 0-based output number of the transaction that paid the invoice (**status** *paid* only)" - } - } - }, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - }, - "local_offer_id": { - "type": "hex", - "description": "the *id* of our offer which created this invoice (**experimental-offers** only).", - "maxLength": 64, - "minLength": 64 - }, - "invreq_payer_note": { - "type": "string", - "description": "the optional *invreq_payer_note* from invoice_request which created this invoice (**experimental-offers** only)." - } - } -} diff --git a/doc/schemas/createonion.request.json b/doc/schemas/createonion.request.json deleted file mode 100644 index 1cf74cf0fa48..000000000000 --- a/doc/schemas/createonion.request.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "hops", - "assocdata" - ], - "properties": { - "hops": { - "type": "array", - "description": "a JSON list of dicts, each specifying a node and the payload destined for that node", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "pubkey", - "payload" - ], - "properties": { - "pubkey": { - "type": "pubkey", - "description": "node pubkey" - }, - "payload": { - "type": "hex", - "description": "payload to be sent to the node" - } - } - } - }, - "assocdata": { - "type": "hex", - "description": "the associated data that the onion should commit to. If the onion is to be used to send a payment later it MUST match the `payment_hash` of the payment in order to be valid" - }, - "session_key": { - "type": "secret", - "description": "can be used to specify a secret that is used to generate the shared secrets used to encrypt the onion for each hop. It should only be used for testing or if a specific shared secret is important. If not specified it will be securely generated internally, and the shared secrets will be returned" - }, - "onion_size": { - "type": "u16", - "description": "a size different from the default payment onion (1300 bytes). May be used for custom protocols like trampoline routing" - } - } -} diff --git a/doc/schemas/createonion.schema.json b/doc/schemas/createonion.schema.json deleted file mode 100644 index 852e83e36a88..000000000000 --- a/doc/schemas/createonion.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "onion", - "shared_secrets" - ], - "properties": { - "onion": { - "type": "hex", - "description": "the onion packet (*onion_size* bytes)" - }, - "shared_secrets": { - "type": "array", - "description": "one shared secret for each node in the *hops* parameter", - "items": { - "type": "secret", - "description": "the shared secret with this hop" - } - } - } -} diff --git a/doc/schemas/createrune.request.json b/doc/schemas/createrune.request.json deleted file mode 100644 index 22057e8b8ea7..000000000000 --- a/doc/schemas/createrune.request.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.08", - "properties": { - "rune": { - "type": "string", - "description": "optional rune to add to" - }, - "restrictions": { - "oneOf": [ - { - "type": "array", - "description": "array of restrictions to add to rune", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "type": "string", - "enum": [ - "readonly" - ], - "description": "readonly string to indicate standard readonly restrictions" - } - ] - } - } -} diff --git a/doc/schemas/createrune.schema.json b/doc/schemas/createrune.schema.json deleted file mode 100644 index 2bb8483aa21e..000000000000 --- a/doc/schemas/createrune.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "rune", - "unique_id" - ], - "properties": { - "rune": { - "type": "string", - "description": "the resulting rune" - }, - "unique_id": { - "type": "string", - "description": "the id of this rune: this is set at creation and cannot be changed (even as restrictions are added)" - }, - "warning_unrestricted_rune": { - "type": "string", - "description": "A warning shown when runes are created with powers that could drain your node" - } - } -} diff --git a/doc/schemas/datastore.request.json b/doc/schemas/datastore.request.json deleted file mode 100644 index 1ef88f4546b2..000000000000 --- a/doc/schemas/datastore.request.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "description": "a key can either have children or a value, never both: parents are created and removed automatically", - "oneOf": [ - { - "type": "array", - "description": "an array of values to form a hierarchy (though a single value is treated as a one-element array). Using the first element of the key as the plugin name (e.g. `[ 'summary' ]`) is recommended", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "string": { - "type": "string", - "description": "data to be saved in string format" - }, - "hex": { - "type": "hex", - "description": "data to be saved in hex format" - }, - "mode": { - "type": "string", - "description": "\n\t- `must-create`: fails if it already exists.\n\t- `must-replace`: fails if it doesn't already exist.\n\t- `create-or-replace`: never fails.\n\t- `must-append`: must already exist, append this to what's already there.\n\t- `create-or-append`: append if anything is there, otherwise create.\n\tDefault is `must-create`", - "enum": [ - "must-create", - "must-replace", - "create-or-replace", - "must-append", - "create-or-append" - ] - }, - "generation": { - "type": "u64", - "description": "if specified, means that the update will fail if the previously-existing data is not exactly that generation. This allows for simple atomicity. This is only legal with *mode* `must-replace` or `must-append`" - } - } -} diff --git a/doc/schemas/datastore.schema.json b/doc/schemas/datastore.schema.json deleted file mode 100644 index 92aa077041ab..000000000000 --- a/doc/schemas/datastore.schema.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "type": "array", - "items": { - "type": "string", - "description": "Part of the key added to the datastore" - } - }, - "generation": { - "type": "u64", - "description": "The number of times this has been updated" - }, - "hex": { - "type": "hex", - "description": "The hex data which has been added to the datastore" - }, - "string": { - "type": "string", - "description": "The data as a string, if it's valid utf-8" - } - } -} diff --git a/doc/schemas/datastoreusage.request.json b/doc/schemas/datastoreusage.request.json deleted file mode 100644 index b634bbfadad8..000000000000 --- a/doc/schemas/datastoreusage.request.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.11", - "properties": { - "key": { - "oneOf": [ - { - "type": "array", - "description": "key is an array of values (though a single value is treated as a one-element array). Used as the starting point to traverse the datastore", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - } - } -} diff --git a/doc/schemas/datastoreusage.schema.json b/doc/schemas/datastoreusage.schema.json deleted file mode 100644 index 19bcd3165a68..000000000000 --- a/doc/schemas/datastoreusage.schema.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "datastoreusage" - ], - "properties": { - "datastoreusage": { - "type": "object", - "additionalProperties": false, - "required": [ - "key", - "total_bytes" - ], - "properties": { - "key": { - "type": "string", - "description": "The key from which the database was traversed." - }, - "total_bytes": { - "type": "u64", - "description": "The total bytes that are stored under the *key*, including the all descendants data and the size of the keys themselves." - } - } - } - } -} diff --git a/doc/schemas/decode.request.json b/doc/schemas/decode.request.json deleted file mode 100644 index ed4dec827c79..000000000000 --- a/doc/schemas/decode.request.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.05", - "required": [ - "string" - ], - "properties": { - "string": { - "type": "string", - "description": "value to be decoded\n\t- a *bolt11* or *bolt12* string (optionally prefixed by `lightning:` or `LIGHTNING:`) as specified by the BOLT 11 and BOLT 12 specifications.\n\t- a *rune* as created by lightning-commando-rune(7).\n\t- an *emergency_recover* string generated by hsmtool like `lightning-hsmtool getemergencyrecover `. It holds `emergency.recover` contents and starts with `clnemerg1`" - } - } -} diff --git a/doc/schemas/decode.schema.json b/doc/schemas/decode.schema.json deleted file mode 100644 index a7c044e0cadd..000000000000 --- a/doc/schemas/decode.schema.json +++ /dev/null @@ -1,1548 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "type", - "valid" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 offer", - "bolt12 invoice", - "bolt12 invoice_request", - "bolt11 invoice", - "rune", - "emergency recover" - ], - "description": "what kind of object it decoded to" - }, - "valid": { - "type": "boolean", - "description": "if this is false, you *MUST* not use the result except for diagnostics!" - } - }, - "allOf": [ - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 offer" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "offer_id", - "offer_node_id", - "offer_description" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": { - "type": "hex", - "description": "the id we use to identify this offer", - "maxLength": 64, - "minLength": 64 - }, - "offer_chains": { - "type": "array", - "description": "which blockchains this offer is for (missing implies bitcoin mainnet only)", - "items": { - "type": "hash", - "description": "the genesis blockhash" - } - }, - "offer_metadata": { - "type": "hex", - "description": "any metadata the creater of the offer includes" - }, - "offer_currency": { - "type": "string", - "description": "ISO 4217 code of the currency (missing implies Bitcoin)", - "maxLength": 3, - "minLength": 3 - }, - "warning_unknown_offer_currency": { - "type": "string", - "description": "The currency code is unknown (so no `currency_minor_unit`)" - }, - "currency_minor_unit": { - "type": "u32", - "description": "the number of decimal places to apply to amount (if currency known)" - }, - "offer_amount": { - "type": "u64", - "description": "the amount in the `offer_currency` adjusted by `currency_minor_unit`, if any" - }, - "offer_amount_msat": { - "type": "msat", - "description": "the amount in bitcoin (if specified, and no `offer_currency`)" - }, - "offer_description": { - "type": "string", - "description": "the description of the purpose of the offer" - }, - "offer_issuer": { - "type": "string", - "description": "the description of the creator of the offer" - }, - "offer_features": { - "type": "hex", - "description": "the feature bits of the offer" - }, - "offer_absolute_expiry": { - "type": "u64", - "description": "UNIX timestamp of when this offer expires" - }, - "offer_quantity_max": { - "type": "u64", - "description": "the maximum quantity (or, if 0, means any quantity)" - }, - "offer_paths": { - "type": "array", - "description": "Paths to the destination", - "items": { - "type": "object", - "required": [ - "first_node_id", - "blinding", - "path" - ], - "additionalProperties": false, - "properties": { - "first_node_id": { - "type": "pubkey", - "description": "the (presumably well-known) public key of the start of the path" - }, - "blinding": { - "type": "pubkey", - "description": "blinding factor for this path" - }, - "path": { - "type": "array", - "description": "an individual path", - "items": { - "type": "object", - "required": [ - "blinded_node_id", - "encrypted_recipient_data" - ], - "additionalProperties": false, - "properties": { - "blinded_node_id": { - "type": "pubkey", - "description": "node_id of the hop" - }, - "encrypted_recipient_data": { - "type": "hex", - "description": "encrypted TLV entry for this hop" - } - } - } - } - } - } - }, - "offer_node_id": { - "type": "pubkey", - "description": "public key of the offering node" - }, - "offer_recurrence": { - "type": "object", - "description": "how often to this offer should be used", - "required": [ - "period", - "time_unit" - ], - "additionalProperties": false, - "properties": { - "time_unit": { - "type": "u32", - "description": "the BOLT12 time unit" - }, - "time_unit_name": { - "type": "string", - "description": "the name of `time_unit` (if valid)" - }, - "period": { - "type": "u32", - "description": "how many `time_unit` per payment period" - }, - "basetime": { - "type": "u64", - "description": "period starts at this UNIX timestamp" - }, - "start_any_period": { - "type": "u64", - "description": "you can start at any period (only if `basetime` present)" - }, - "limit": { - "type": "u32", - "description": "maximum period number for recurrence" - }, - "paywindow": { - "type": "object", - "description": "when within a period will payment be accepted (default is prior and during the period)", - "required": [ - "seconds_before", - "seconds_after" - ], - "additionalProperties": false, - "properties": { - "seconds_before": { - "type": "u32", - "description": "seconds prior to period start" - }, - "seconds_after": { - "type": "u32", - "description": "seconds after to period start" - }, - "proportional_amount": { - "type": "boolean", - "enum": [ - true - ], - "description": "amount should be scaled if payed after period start" - } - } - } - } - }, - "unknown_offer_tlvs": { - "type": "array", - "description": "Any extra fields we didn't know how to parse", - "items": { - "type": "object", - "required": [ - "type", - "length", - "value" - ], - "additionalProperties": false, - "properties": { - "type": { - "type": "u64", - "description": "The type" - }, - "length": { - "type": "u64", - "description": "The length" - }, - "value": { - "type": "hex", - "description": "The value" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 offer" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - false - ] - } - } - }, - "then": { - "required": [], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": {}, - "node_id": {}, - "signature": {}, - "chains": {}, - "currency": {}, - "minor_unit": {}, - "warning_unknown_offer_currency": {}, - "amount": {}, - "amount_msat": {}, - "send_invoice": {}, - "description": {}, - "vendor": {}, - "features": {}, - "absolute_expiry": {}, - "paths": {}, - "quantity_max": {}, - "unknown_offer_tlvs": {}, - "recurrence": {}, - "warning_missing_offer_node_id": { - "type": "string", - "description": "`offer_node_id` is not present" - }, - "warning_invalid_offer_description": { - "type": "string", - "description": "`offer_description` is not valid UTF8" - }, - "warning_missing_offer_description": { - "type": "string", - "description": "`offer_description` is not present" - }, - "warning_invalid_offer_currency": { - "type": "string", - "description": "`offer_currency_code` is not valid UTF8" - }, - "warning_invalid_offer_issuer": { - "type": "string", - "description": "`offer_issuer` is not valid UTF8" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 invoice_request" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "offer_node_id", - "offer_description", - "invreq_metadata", - "invreq_payer_id", - "signature" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": { - "type": "hex", - "description": "the id we use to identify this offer", - "maxLength": 64, - "minLength": 64 - }, - "offer_chains": { - "type": "array", - "description": "which blockchains this offer is for (missing implies bitcoin mainnet only)", - "items": { - "type": "hex", - "description": "the genesis blockhash", - "maxLength": 64, - "minLength": 64 - } - }, - "offer_metadata": { - "type": "hex", - "description": "any metadata the creator of the offer includes" - }, - "offer_currency": { - "type": "string", - "description": "ISO 4217 code of the currency (missing implies Bitcoin)", - "maxLength": 3, - "minLength": 3 - }, - "warning_unknown_offer_currency": { - "type": "string", - "description": "The currency code is unknown (so no `currency_minor_unit`)" - }, - "currency_minor_unit": { - "type": "u32", - "description": "the number of decimal places to apply to amount (if currency known)" - }, - "offer_amount": { - "type": "u64", - "description": "the amount in the `offer_currency` adjusted by `currency_minor_unit`, if any" - }, - "offer_amount_msat": { - "type": "msat", - "description": "the amount in bitcoin (if specified, and no `offer_currency`)" - }, - "offer_description": { - "type": "string", - "description": "the description of the purpose of the offer" - }, - "offer_issuer": { - "type": "string", - "description": "the description of the creator of the offer" - }, - "offer_features": { - "type": "hex", - "description": "the feature bits of the offer" - }, - "offer_absolute_expiry": { - "type": "u64", - "description": "UNIX timestamp of when this offer expires" - }, - "offer_quantity_max": { - "type": "u64", - "description": "the maximum quantity (or, if 0, means any quantity)" - }, - "offer_paths": { - "type": "array", - "description": "Paths to the destination", - "items": { - "type": "object", - "required": [ - "first_node_id", - "blinding", - "path" - ], - "additionalProperties": false, - "properties": { - "first_node_id": { - "type": "pubkey", - "description": "the (presumably well-known) public key of the start of the path" - }, - "blinding": { - "type": "pubkey", - "description": "blinding factor for this path" - }, - "path": { - "type": "array", - "description": "an individual path", - "items": { - "type": "object", - "required": [ - "blinded_node_id", - "encrypted_recipient_data" - ], - "additionalProperties": false, - "properties": { - "blinded_node_id": { - "type": "pubkey", - "description": "node_id of the hop" - }, - "encrypted_recipient_data": { - "type": "hex", - "description": "encrypted TLV entry for this hop" - } - } - } - } - } - } - }, - "offer_node_id": { - "type": "pubkey", - "description": "public key of the offering node" - }, - "offer_recurrence": { - "type": "object", - "description": "how often to this offer should be used", - "required": [ - "period", - "time_unit" - ], - "additionalProperties": false, - "properties": { - "time_unit": { - "type": "u32", - "description": "the BOLT12 time unit" - }, - "time_unit_name": { - "type": "string", - "description": "the name of `time_unit` (if valid)" - }, - "period": { - "type": "u32", - "description": "how many `time_unit` per payment period" - }, - "basetime": { - "type": "u64", - "description": "period starts at this UNIX timestamp" - }, - "start_any_period": { - "type": "u64", - "description": "you can start at any period (only if `basetime` present)" - }, - "limit": { - "type": "u32", - "description": "maximum period number for recurrence" - }, - "paywindow": { - "type": "object", - "description": "when within a period will payment be accepted (default is prior and during the period)", - "required": [ - "seconds_before", - "seconds_after" - ], - "additionalProperties": false, - "properties": { - "seconds_before": { - "type": "u32", - "description": "seconds prior to period start" - }, - "seconds_after": { - "type": "u32", - "description": "seconds after to period start" - }, - "proportional_amount": { - "type": "boolean", - "enum": [ - true - ], - "description": "amount should be scaled if payed after period start" - } - } - } - } - }, - "invreq_metadata": { - "type": "hex", - "description": "the payer-provided blob to derive invreq_payer_id" - }, - "invreq_payer_id": { - "type": "hex", - "description": "the payer-provided key" - }, - "invreq_chain": { - "type": "hex", - "description": "which blockchain this offer is for (missing implies bitcoin mainnet only)", - "maxLength": 64, - "minLength": 64 - }, - "invreq_amount_msat": { - "type": "msat", - "description": "the amount the invoice should be for" - }, - "invreq_features": { - "type": "hex", - "description": "the feature bits of the invoice_request" - }, - "invreq_quantity": { - "type": "u64", - "description": "the number of items to invoice for" - }, - "invreq_payer_note": { - "type": "string", - "description": "a note attached by the payer" - }, - "invreq_recurrence_counter": { - "type": "u32", - "description": "which number request this is for the same invoice" - }, - "invreq_recurrence_start": { - "type": "u32", - "description": "when we're requesting to start an invoice at a non-zero period" - }, - "signature": { - "type": "bip340sig", - "description": "BIP-340 signature of the `invreq_payer_id` on this invoice_request" - }, - "unknown_invoice_request_tlvs": { - "type": "array", - "description": "Any extra fields we didn't know how to parse", - "items": { - "type": "object", - "required": [ - "type", - "length", - "value" - ], - "additionalProperties": false, - "properties": { - "type": { - "type": "u64", - "description": "The type" - }, - "length": { - "type": "u64", - "description": "The length" - }, - "value": { - "type": "hex", - "description": "The value" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 invoice_request" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - false - ] - } - } - }, - "then": { - "required": [], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": {}, - "offer_chains": {}, - "offer_metadata": {}, - "offer_currency": {}, - "warning_unknown_offer_currency": {}, - "currency_minor_unit": {}, - "offer_amount": {}, - "offer_amount_msat": {}, - "offer_description": {}, - "offer_issuer": {}, - "offer_features": {}, - "offer_absolute_expiry": {}, - "offer_quantity_max": {}, - "offer_paths": {}, - "offer_node_id": {}, - "offer_recurrence": {}, - "invreq_metadata": {}, - "invreq_payer_id": {}, - "invreq_chain": {}, - "invreq_amount_msat": {}, - "invreq_features": {}, - "invreq_quantity": {}, - "invreq_payer_note": {}, - "invreq_recurrence_counter": {}, - "invreq_recurrence_start": {}, - "warning_invalid_offer_description": { - "type": "string", - "description": "`offer_description` is not valid UTF8" - }, - "warning_missing_offer_description": { - "type": "string", - "description": "`offer_description` is not present" - }, - "warning_invalid_offer_currency": { - "type": "string", - "description": "`offer_currency_code` is not valid UTF8" - }, - "warning_invalid_offer_issuer": { - "type": "string", - "description": "`offer_issuer` is not valid UTF8" - }, - "warning_missing_invreq_metadata": { - "type": "string", - "description": "`invreq_metadata` is not present" - }, - "warning_missing_invreq_payer_id": { - "type": "string", - "description": "`invreq_payer_id` is not present" - }, - "warning_invalid_invreq_payer_note": { - "type": "string", - "description": "`invreq_payer_note` is not valid UTF8" - }, - "warning_missing_invoice_request_signature": { - "type": "string", - "description": "`signature` is not present" - }, - "warning_invalid_invoice_request_signature": { - "type": "string", - "description": "Incorrect `signature`" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 invoice" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "offer_node_id", - "offer_description", - "invreq_metadata", - "invreq_payer_id", - "invoice_paths", - "invoice_created_at", - "invoice_payment_hash", - "invoice_amount_msat", - "signature" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": { - "type": "hex", - "description": "the id we use to identify this offer", - "maxLength": 64, - "minLength": 64 - }, - "offer_chains": { - "type": "array", - "description": "which blockchains this offer is for (missing implies bitcoin mainnet only)", - "items": { - "type": "hex", - "description": "the genesis blockhash", - "maxLength": 64, - "minLength": 64 - } - }, - "offer_metadata": { - "type": "hex", - "description": "any metadata the creator of the offer includes" - }, - "offer_currency": { - "type": "string", - "description": "ISO 4217 code of the currency (missing implies Bitcoin)", - "maxLength": 3, - "minLength": 3 - }, - "warning_unknown_offer_currency": { - "type": "string", - "description": "The currency code is unknown (so no `currency_minor_unit`)" - }, - "currency_minor_unit": { - "type": "u32", - "description": "the number of decimal places to apply to amount (if currency known)" - }, - "offer_amount": { - "type": "u64", - "description": "the amount in the `offer_currency` adjusted by `currency_minor_unit`, if any" - }, - "offer_amount_msat": { - "type": "msat", - "description": "the amount in bitcoin (if specified, and no `offer_currency`)" - }, - "offer_description": { - "type": "string", - "description": "the description of the purpose of the offer" - }, - "offer_issuer": { - "type": "string", - "description": "the description of the creator of the offer" - }, - "offer_features": { - "type": "hex", - "description": "the feature bits of the offer" - }, - "offer_absolute_expiry": { - "type": "u64", - "description": "UNIX timestamp of when this offer expires" - }, - "offer_quantity_max": { - "type": "u64", - "description": "the maximum quantity (or, if 0, means any quantity)" - }, - "offer_paths": { - "type": "array", - "description": "Paths to the destination", - "items": { - "type": "object", - "required": [ - "first_node_id", - "blinding", - "path" - ], - "additionalProperties": false, - "properties": { - "first_node_id": { - "type": "pubkey", - "description": "the (presumably well-known) public key of the start of the path" - }, - "blinding": { - "type": "pubkey", - "description": "blinding factor for this path" - }, - "path": { - "type": "array", - "description": "an individual path", - "items": { - "type": "object", - "required": [ - "blinded_node_id", - "encrypted_recipient_data" - ], - "additionalProperties": false, - "properties": { - "blinded_node_id": { - "type": "pubkey", - "description": "node_id of the hop" - }, - "encrypted_recipient_data": { - "type": "hex", - "description": "encrypted TLV entry for this hop" - } - } - } - } - } - } - }, - "offer_node_id": { - "type": "pubkey", - "description": "public key of the offering node" - }, - "offer_recurrence": { - "type": "object", - "description": "how often to this offer should be used", - "required": [ - "period", - "time_unit" - ], - "additionalProperties": false, - "properties": { - "time_unit": { - "type": "u32", - "description": "the BOLT12 time unit" - }, - "time_unit_name": { - "type": "string", - "description": "the name of `time_unit` (if valid)" - }, - "period": { - "type": "u32", - "description": "how many `time_unit` per payment period" - }, - "basetime": { - "type": "u64", - "description": "period starts at this UNIX timestamp" - }, - "start_any_period": { - "type": "u64", - "description": "you can start at any period (only if `basetime` present)" - }, - "limit": { - "type": "u32", - "description": "maximum period number for recurrence" - }, - "paywindow": { - "type": "object", - "description": "when within a period will payment be accepted (default is prior and during the period)", - "required": [ - "seconds_before", - "seconds_after" - ], - "additionalProperties": false, - "properties": { - "seconds_before": { - "type": "u32", - "description": "seconds prior to period start" - }, - "seconds_after": { - "type": "u32", - "description": "seconds after to period start" - }, - "proportional_amount": { - "type": "boolean", - "enum": [ - true - ], - "description": "amount should be scaled if payed after period start" - } - } - } - } - }, - "invreq_metadata": { - "type": "hex", - "description": "the payer-provided blob to derive invreq_payer_id" - }, - "invreq_payer_id": { - "type": "hex", - "description": "the payer-provided key" - }, - "invreq_chain": { - "type": "hex", - "description": "which blockchain this offer is for (missing implies bitcoin mainnet only)", - "maxLength": 64, - "minLength": 64 - }, - "invreq_amount_msat": { - "type": "msat", - "description": "the amount the invoice should be for" - }, - "invreq_features": { - "type": "hex", - "description": "the feature bits of the invoice_request" - }, - "invreq_quantity": { - "type": "u64", - "description": "the number of items to invoice for" - }, - "invreq_payer_note": { - "type": "string", - "description": "a note attached by the payer" - }, - "invreq_recurrence_counter": { - "type": "u32", - "description": "which number request this is for the same invoice" - }, - "invreq_recurrence_start": { - "type": "u32", - "description": "when we're requesting to start an invoice at a non-zero period" - }, - "invoice_paths": { - "type": "array", - "description": "Paths to pay the destination", - "items": { - "type": "object", - "required": [ - "first_node_id", - "blinding", - "payinfo", - "path" - ], - "additionalProperties": false, - "properties": { - "first_node_id": { - "type": "pubkey", - "description": "the (presumably well-known) public key of the start of the path" - }, - "blinding": { - "type": "pubkey", - "description": "blinding factor for this path" - }, - "payinfo": { - "type": "object", - "required": [ - "fee_base_msat", - "fee_proportional_millionths", - "cltv_expiry_delta", - "features" - ], - "additionalProperties": false, - "properties": { - "fee_base_msat": { - "type": "msat", - "description": "basefee for path" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "proportional fee for path" - }, - "cltv_expiry_delta": { - "type": "u32", - "description": "CLTV delta for path" - }, - "features": { - "type": "hex", - "description": "features allowed for path" - } - } - }, - "path": { - "type": "array", - "description": "an individual path", - "items": { - "type": "object", - "required": [ - "blinded_node_id", - "encrypted_recipient_data" - ], - "additionalProperties": false, - "properties": { - "blinded_node_id": { - "type": "pubkey", - "description": "node_id of the hop" - }, - "encrypted_recipient_data": { - "type": "hex", - "description": "encrypted TLV entry for this hop" - } - } - } - } - } - } - }, - "invoice_created_at": { - "type": "u64", - "description": "the UNIX timestamp of invoice creation" - }, - "invoice_relative_expiry": { - "type": "u32", - "description": "the number of seconds after *invoice_created_at* when this expires" - }, - "invoice_payment_hash": { - "type": "hex", - "description": "the hash of the *payment_preimage*", - "maxLength": 64, - "minLength": 64 - }, - "invoice_amount_msat": { - "type": "msat", - "description": "the amount required to fulfill invoice" - }, - "invoice_fallbacks": { - "type": "array", - "description": "onchain addresses", - "items": { - "type": "object", - "required": [ - "version", - "hex" - ], - "additionalProperties": false, - "properties": { - "version": { - "type": "u8", - "description": "Segwit address version" - }, - "hex": { - "type": "hex", - "description": "Raw encoded segwit address" - }, - "address": { - "type": "string", - "description": "bech32 segwit address" - } - } - } - }, - "invoice_features": { - "type": "hex", - "description": "the feature bits of the invoice" - }, - "invoice_node_id": { - "type": "pubkey", - "description": "the id to pay (usually the same as offer_node_id)" - }, - "invoice_recurrence_basetime": { - "type": "u64", - "description": "the UNIX timestamp to base the invoice periods on" - }, - "signature": { - "type": "bip340sig", - "description": "BIP-340 signature of the `offer_node_id` on this invoice" - }, - "unknown_invoice_tlvs": { - "type": "array", - "description": "Any extra fields we didn't know how to parse", - "items": { - "type": "object", - "required": [ - "type", - "length", - "value" - ], - "additionalProperties": false, - "properties": { - "type": { - "type": "u64", - "description": "The type" - }, - "length": { - "type": "u64", - "description": "The length" - }, - "value": { - "type": "hex", - "description": "The value" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt12 invoice" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - false - ] - } - } - }, - "then": { - "required": [], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "offer_id": {}, - "offer_chains": {}, - "offer_metadata": {}, - "offer_currency": {}, - "warning_unknown_offer_currency": {}, - "currency_minor_unit": {}, - "offer_amount": {}, - "offer_amount_msat": {}, - "offer_description": {}, - "offer_issuer": {}, - "offer_features": {}, - "offer_absolute_expiry": {}, - "offer_quantity_max": {}, - "offer_paths": {}, - "offer_node_id": {}, - "offer_recurrence": {}, - "invreq_metadata": {}, - "invreq_payer_id": {}, - "invreq_chain": {}, - "invreq_amount_msat": {}, - "invreq_features": {}, - "invreq_quantity": {}, - "invreq_payer_note": {}, - "invreq_node_id": {}, - "invreq_recurrence_counter": {}, - "invreq_recurrence_start": {}, - "warning_invalid_offer_description": { - "type": "string", - "description": "`offer_description` is not valid UTF8" - }, - "warning_missing_offer_description": { - "type": "string", - "description": "`offer_description` is not present" - }, - "warning_invalid_offer_currency": { - "type": "string", - "description": "`offer_currency_code` is not valid UTF8" - }, - "warning_invalid_offer_issuer": { - "type": "string", - "description": "`offer_issuer` is not valid UTF8" - }, - "warning_missing_invreq_metadata": { - "type": "string", - "description": "`invreq_metadata` is not present" - }, - "warning_invalid_invreq_payer_note": { - "type": "string", - "description": "`invreq_payer_note` is not valid UTF8" - }, - "warning_missing_invoice_paths": { - "type": "string", - "description": "`invoice_paths` is not present" - }, - "warning_missing_invoice_blindedpay": { - "type": "string", - "description": "`invoice_blindedpay` is not present" - }, - "warning_missing_invoice_created_at": { - "type": "string", - "description": "`invoice_created_at` is not present" - }, - "warning_missing_invoice_payment_hash": { - "type": "string", - "description": "`invoice_payment_hash` is not present" - }, - "warning_missing_invoice_amount": { - "type": "string", - "description": "`invoice_amount` is not present" - }, - "warning_missing_invoice_recurrence_basetime": { - "type": "string", - "description": "`invoice_recurrence_basetime` is not present" - }, - "warning_missing_invoice_node_id": { - "type": "string", - "description": "`invoice_node_id` is not present" - }, - "warning_missing_invoice_signature": { - "type": "string", - "description": "`signature` is not present" - }, - "warning_invalid_invoice_signature": { - "type": "string", - "description": "Incorrect `signature`" - }, - "fallbacks": { - "type": "array", - "items": { - "type": "object", - "required": [ - "version", - "hex" - ], - "properties": { - "version": {}, - "hex": {}, - "address": {}, - "warning_invoice_fallbacks_version_invalid": { - "type": "string", - "description": "`version` is > 16" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "bolt11 invoice" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "currency", - "created_at", - "expiry", - "payee", - "min_final_cltv_expiry", - "payment_hash", - "signature" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "currency": { - "type": "string", - "description": "the BIP173 name for the currency" - }, - "created_at": { - "type": "u64", - "description": "the UNIX-style timestamp of the invoice" - }, - "expiry": { - "type": "u64", - "description": "the number of seconds this is valid after `created_at`" - }, - "payee": { - "type": "pubkey", - "description": "the public key of the recipient" - }, - "amount_msat": { - "type": "msat", - "description": "Amount the invoice asked for" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage*" - }, - "signature": { - "type": "signature", - "description": "signature of the *payee* on this invoice" - }, - "description": { - "type": "string", - "description": "the description of the purpose of the purchase" - }, - "description_hash": { - "type": "hash", - "description": "the hash of the description, in place of *description*" - }, - "min_final_cltv_expiry": { - "type": "u32", - "description": "the minimum CLTV delay for the final node" - }, - "payment_secret": { - "type": "secret", - "description": "the secret to hand to the payee node" - }, - "features": { - "type": "hex", - "description": "the features bitmap for this invoice" - }, - "payment_metadata": { - "type": "hex", - "description": "the payment_metadata to put in the payment" - }, - "fallbacks": { - "type": "array", - "description": "onchain addresses", - "items": { - "type": "object", - "required": [ - "type", - "hex" - ], - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "description": "the address type (if known)", - "enum": [ - "P2PKH", - "P2SH", - "P2WPKH", - "P2WSH", - "P2TR" - ] - }, - "addr": { - "type": "string", - "description": "the address in appropriate format for *type*" - }, - "hex": { - "type": "hex", - "description": "Raw encoded address" - } - } - } - }, - "routes": { - "type": "array", - "description": "Route hints to the *payee*", - "items": { - "type": "array", - "description": "hops in the route", - "items": { - "type": "object", - "required": [ - "pubkey", - "short_channel_id", - "fee_base_msat", - "fee_proportional_millionths", - "cltv_expiry_delta" - ], - "additionalProperties": false, - "properties": { - "pubkey": { - "type": "pubkey", - "description": "the public key of the node" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "a channel to the next peer" - }, - "fee_base_msat": { - "type": "msat", - "description": "the base fee for payments" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "the parts-per-million fee for payments" - }, - "cltv_expiry_delta": { - "type": "u32", - "description": "the CLTV delta across this hop" - } - } - } - } - }, - "extra": { - "type": "array", - "description": "Any extra fields we didn't know how to parse", - "items": { - "type": "object", - "required": [ - "tag", - "data" - ], - "additionalProperties": false, - "properties": { - "tag": { - "type": "string", - "description": "The bech32 letter which identifies this field", - "maxLength": 1, - "minLength": 1 - }, - "data": { - "type": "string", - "description": "The bech32 data for this field" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "rune" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "string", - "restrictions", - "valid" - ], - "additionalProperties": false, - "properties": { - "unique_id": { - "type": "string", - "description": "unique id (always a numeric id on runes we create)" - }, - "version": { - "type": "string", - "description": "rune version, not currently set on runes we create" - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - }, - "type": {}, - "string": { - "type": "string", - "description": "the string encoding of the rune" - }, - "restrictions": { - "type": "array", - "description": "restrictions built into the rune: all must pass", - "items": { - "type": "object", - "required": [ - "alternatives", - "summary" - ], - "additionalProperties": false, - "properties": { - "alternatives": { - "type": "array", - "description": "each way restriction can be met: any can pass", - "items": { - "type": "string", - "description": "the alternative of form fieldname condition fieldname" - } - }, - "summary": { - "type": "string", - "description": "human-readable summary of this restriction" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "rune" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - false - ] - } - } - }, - "then": { - "required": [ - "valid" - ], - "additionalProperties": false, - "properties": { - "valid": { - "type": "boolean", - "enum": [ - false - ] - }, - "type": {}, - "warning_rune_invalid_utf8": { - "type": "string", - "description": "the rune contains invalid UTF-8 strings" - }, - "hex": { - "type": "hex", - "description": "the raw rune in hex" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "emergency recover" - ] - }, - "valid": { - "type": "boolean", - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "decrypted" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "valid": {}, - "decrypted": { - "type": "hex", - "description": "The decrypted value of the provided bech32 of emergency.recover", - "added": "v23.11" - } - } - } - } - ] -} diff --git a/doc/schemas/decodepay.request.json b/doc/schemas/decodepay.request.json deleted file mode 100644 index d89d88afe009..000000000000 --- a/doc/schemas/decodepay.request.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.05", - "required": [ - "bolt11" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "bolt11 invoice to decode" - }, - "description": { - "type": "string", - "description": "description of the invoice to decode" - } - } -} diff --git a/doc/schemas/decodepay.schema.json b/doc/schemas/decodepay.schema.json deleted file mode 100644 index 170f694200fd..000000000000 --- a/doc/schemas/decodepay.schema.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "currency", - "created_at", - "expiry", - "payee", - "min_final_cltv_expiry", - "payment_hash", - "signature" - ], - "additionalProperties": false, - "properties": { - "currency": { - "type": "string", - "description": "the BIP173 name for the currency" - }, - "created_at": { - "type": "u64", - "description": "the UNIX-style timestamp of the invoice" - }, - "expiry": { - "type": "u64", - "description": "the number of seconds this is valid after *timestamp*" - }, - "payee": { - "type": "pubkey", - "description": "the public key of the recipient" - }, - "amount_msat": { - "type": "msat", - "description": "Amount the invoice asked for" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage*" - }, - "signature": { - "type": "signature", - "description": "signature of the *payee* on this invoice" - }, - "description": { - "type": "string", - "description": "the description of the purpose of the purchase" - }, - "description_hash": { - "type": "hash", - "description": "the hash of the description, in place of *description*" - }, - "min_final_cltv_expiry": { - "type": "u32", - "description": "the minimum CLTV delay for the final node" - }, - "payment_secret": { - "type": "hash", - "description": "the secret to hand to the payee node" - }, - "features": { - "type": "hex", - "description": "the features bitmap for this invoice" - }, - "payment_metadata": { - "type": "hex", - "description": "the payment_metadata to put in the payment" - }, - "fallbacks": { - "type": "array", - "description": "onchain addresses", - "items": { - "type": "object", - "required": [ - "type", - "hex" - ], - "additionalProperties": false, - "properties": { - "type": { - "type": "string", - "description": "the address type (if known)", - "enum": [ - "P2PKH", - "P2SH", - "P2WPKH", - "P2WSH", - "P2TR" - ] - }, - "addr": { - "type": "string", - "description": "the address in appropriate format for *type*" - }, - "hex": { - "type": "hex", - "description": "Raw encoded address" - } - } - } - }, - "routes": { - "type": "array", - "description": "Route hints to the *payee*", - "items": { - "type": "array", - "description": "hops in the route", - "items": { - "type": "object", - "required": [ - "pubkey", - "short_channel_id", - "fee_base_msat", - "fee_proportional_millionths", - "cltv_expiry_delta" - ], - "additionalProperties": false, - "properties": { - "pubkey": { - "type": "pubkey", - "description": "the public key of the node" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "a channel to the next peer" - }, - "fee_base_msat": { - "type": "msat", - "description": "the base fee for payments" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "the parts-per-million fee for payments" - }, - "cltv_expiry_delta": { - "type": "u32", - "description": "the CLTV delta across this hop" - } - } - } - } - }, - "extra": { - "type": "array", - "description": "Any extra fields we didn't know how to parse", - "items": { - "type": "object", - "required": [ - "tag", - "data" - ], - "additionalProperties": false, - "properties": { - "tag": { - "type": "string", - "description": "The bech32 letter which identifies this field", - "maxLength": 1, - "minLength": 1 - }, - "data": { - "type": "string", - "description": "The bech32 data for this field" - } - } - } - } - } -} diff --git a/doc/schemas/deldatastore.request.json b/doc/schemas/deldatastore.request.json deleted file mode 100644 index cff49d001d2d..000000000000 --- a/doc/schemas/deldatastore.request.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "oneOf": [ - { - "type": "array", - "description": "key is an array of values (though a single value is treated as a one-element array), to form a heirarchy. Using the first element of the key as the plugin name (e.g. [ 'summary' ]) is recommended. A key can either have children or a value, never both: parents are created and removed automatically", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - }, - "generation": { - "type": "u64", - "description": "If specified, means that the update will fail if the previously-existing data is not exactly that generation. This allows for simple atomicity. This is only legal with mode “must-replace” or “must-append”" - } - } -} diff --git a/doc/schemas/deldatastore.schema.json b/doc/schemas/deldatastore.schema.json deleted file mode 100644 index c5a2875b6a44..000000000000 --- a/doc/schemas/deldatastore.schema.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "type": "array", - "items": { - "type": "string", - "description": "Part of the key added to the datastore" - } - }, - "generation": { - "type": "u64", - "description": "The number of times this has been updated" - }, - "hex": { - "type": "hex", - "description": "The hex data which has removed from the datastore" - }, - "string": { - "type": "string", - "description": "The data as a string, if it's valid utf-8" - } - } -} diff --git a/doc/schemas/delexpiredinvoice.request.json b/doc/schemas/delexpiredinvoice.request.json deleted file mode 100644 index ba9e9ec16bb0..000000000000 --- a/doc/schemas/delexpiredinvoice.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "maxexpirytime": { - "type": "u64", - "description": "invoice expiry time in seconds. If not specified then all expired invoices are deleted" - } - } -} diff --git a/doc/schemas/delexpiredinvoice.schema.json b/doc/schemas/delexpiredinvoice.schema.json deleted file mode 100644 index f99496c5ac84..000000000000 --- a/doc/schemas/delexpiredinvoice.schema.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/delforward.request.json b/doc/schemas/delforward.request.json deleted file mode 100644 index 1facb6d8b425..000000000000 --- a/doc/schemas/delforward.request.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": ["in_channel", "in_htlc_id", "status"], - "properties": { - "in_channel": { - "type": "short_channel_id", - "description": "only the matching forwards on the given inbound channel are deleted.\n\tNote: for **listforwards** entries without an *in_htlc_id* entry (no longer created in v22.11, but can exist from older versions), a value of 18446744073709551615 can be used, but then it will delete *all* entries without *in_htlc_id* for this *in_channel* and *status*" - }, - "in_htlc_id": { - "type": "u64", - "description": "the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)" - }, - "status": { - "type": "string", - "description": "the status of the forward to delete. You cannot delete forwards which have status *offered* (i.e. are currently active)", - "enum": [ - "settled", - "local_failed", - "failed" - ] - } - } -} diff --git a/doc/schemas/delforward.schema.json b/doc/schemas/delforward.schema.json deleted file mode 100644 index 65571ad4c703..000000000000 --- a/doc/schemas/delforward.schema.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": {} -} diff --git a/doc/schemas/delinvoice.request.json b/doc/schemas/delinvoice.request.json deleted file mode 100644 index fff8a3f1a7c0..000000000000 --- a/doc/schemas/delinvoice.request.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "label", - "status" - ], - "properties": { - "label": { - "type": "string or integer", - "description": "label of the invoice to be deleted" - }, - "status": { - "type": "string", - "description": "label of the invoice to be deleted. The caller should be particularly aware of the error case caused by the *status* changing just before this command is invoked!", - "enum": [ - "paid", - "expired", - "unpaid" - ] - }, - "desconly": { - "type": "boolean", - "description": "if set to True, the invoice is not deleted, but has its description removed (this can save space with very large descriptions, as would be used with lightning-invoice(7) *deschashonly*" - } - } -} diff --git a/doc/schemas/delinvoice.schema.json b/doc/schemas/delinvoice.schema.json deleted file mode 100644 index 34bf29dd26c8..000000000000 --- a/doc/schemas/delinvoice.schema.json +++ /dev/null @@ -1,192 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "label", - "payment_hash", - "status", - "created_index", - "expires_at" - ], - "additionalProperties": true, - "properties": { - "label": { - "type": "string", - "description": "Unique label given at creation time" - }, - "bolt11": { - "type": "string", - "description": "BOLT11 string" - }, - "bolt12": { - "type": "string", - "description": "BOLT12 string" - }, - "amount_msat": { - "type": "msat", - "description": "the amount required to pay this invoice" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "updated_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was changed (only present if it has changed since creation)" - }, - "status": { - "type": "string", - "description": "State of invoice", - "enum": [ - "paid", - "expired", - "unpaid" - ] - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp when invoice expires (or expired)" - } - }, - "allOf": [ - { - "if": { - "required": [ - "bolt12" - ] - }, - "then": { - "required": [], - "additionalProperties": false, - "properties": { - "label": {}, - "bolt12": {}, - "status": {}, - "expires_at": {}, - "msatoshi": {}, - "amount_msat": {}, - "description": {}, - "payment_hash": {}, - "pay_index": {}, - "created_index": {}, - "updated_index": {}, - "amount_received_msat": {}, - "paid_at": {}, - "payment_preimage": {}, - "local_offer_id": { - "type": "hex", - "description": "offer for which this invoice was created" - }, - "invreq_payer_note": { - "type": "string", - "description": "the optional *invreq_payer_note* from invoice_request which created this invoice" - } - } - }, - "else": { - "required": [ - "bolt11" - ], - "additionalProperties": false, - "properties": { - "label": {}, - "bolt11": {}, - "status": {}, - "expires_at": {}, - "msatoshi": {}, - "amount_msat": {}, - "description": {}, - "payment_hash": {}, - "pay_index": {}, - "created_index": {}, - "updated_index": {}, - "amount_received_msat": {}, - "msatoshi_received": {}, - "paid_at": {}, - "payment_preimage": {} - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "paid" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "pay_index", - "amount_received_msat", - "paid_at", - "payment_preimage" - ], - "properties": { - "label": {}, - "bolt11": {}, - "bolt12": {}, - "status": {}, - "expires_at": {}, - "msatoshi": {}, - "amount_msat": {}, - "description": {}, - "payment_hash": {}, - "invreq_payer_note": {}, - "local_offer_id": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": { - "type": "u64", - "description": "unique index for this invoice payment" - }, - "amount_received_msat": { - "type": "msat", - "description": "how much was actually received" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when payment was received" - }, - "payment_preimage": { - "type": "secret", - "description": "SHA256 of this is the *payment_hash* offered in the invoice" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "label": {}, - "bolt11": {}, - "bolt12": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "description": {}, - "payment_hash": {}, - "expires_at": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": {}, - "invreq_payer_note": {}, - "local_offer_id": {} - } - } - } - ] -} diff --git a/doc/schemas/delpay.request.json b/doc/schemas/delpay.request.json deleted file mode 100644 index 5cd3d2ebf29b..000000000000 --- a/doc/schemas/delpay.request.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "payment_hash", - "status" - ], - "additionalProperties": false, - "properties": { - "payment_hash": { - "type": "hash", - "description": "the unique identifier of a payment" - }, - "status": { - "type": "string", - "description": "expected status of the payment. Only deletes if the payment status matches. Deleting a `pending` payment will return an error", - "enum": [ - "complete", - "failed" - ] - }, - "partid": { - "type": "u64", - "description": "specific partid to delete (must be paired with *groupid*)" - }, - "groupid": { - "type": "u64", - "description": "specific groupid to delete (must be paired with *partid*)" - } - } -} diff --git a/doc/schemas/delpay.schema.json b/doc/schemas/delpay.schema.json deleted file mode 100644 index 64e6d445b6b7..000000000000 --- a/doc/schemas/delpay.schema.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "payments" - ], - "additionalProperties": false, - "properties": { - "payments": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "created_index", - "id", - "payment_hash", - "status", - "amount_sent_msat", - "created_at" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was created in" - }, - "id": { - "type": "u64", - "description": "old synonym for created_index" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "failed", - "complete" - ], - "description": "status of the payment" - }, - "amount_sent_msat": { - "type": "msat", - "description": "the amount we actually sent, including fees" - }, - "partid": { - "type": "u64", - "description": "unique ID within this (multi-part) payment" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "amount_msat": { - "type": "msat", - "description": "the amount the destination received, if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was changed (only present if it has changed since creation)" - }, - "completed_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was completed" - }, - "groupid": { - "type": "u64", - "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "payment_preimage": { - "type": "secret", - "description": "proof of payment" - }, - "label": { - "type": "string", - "description": "the label, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if pay supplied one)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied for pay: **experimental-offers** only)." - }, - "erroronion": { - "type": "hex", - "description": "the error onion returned on failure, if any." - } - } - } - } - } -} diff --git a/doc/schemas/disableinvoicerequest.request.json b/doc/schemas/disableinvoicerequest.request.json deleted file mode 100644 index b7f80bb86ec1..000000000000 --- a/doc/schemas/disableinvoicerequest.request.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v22.11", - "required": [ - "invreq_id" - ], - "properties": { - "invreq_id": { - "type": "string", - "description": "a specific invoice can be disabled by providing the `invreq_id`, which is presented by lightning-invoicerequest(7)" - } - } -} diff --git a/doc/schemas/disableinvoicerequest.schema.json b/doc/schemas/disableinvoicerequest.schema.json deleted file mode 100644 index ed645fb201ca..000000000000 --- a/doc/schemas/disableinvoicerequest.schema.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invreq_id", - "single_use", - "active", - "bolt12", - "used" - ], - "properties": { - "invreq_id": { - "type": "hash", - "description": "the SHA256 hash of all invoice_request fields less than 160" - }, - "active": { - "type": "boolean", - "enum": [ - false - ], - "description": "whether the invoice_request is currently active" - }, - "single_use": { - "type": "boolean", - "description": "whether the invoice_request will become inactive after we pay an invoice for it" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string starting with lnr" - }, - "used": { - "type": "boolean", - "description": "whether the invoice_request has already been used" - }, - "label": { - "type": "string", - "description": "the label provided when creating the invoice_request" - } - } -} diff --git a/doc/schemas/disableoffer.request.json b/doc/schemas/disableoffer.request.json deleted file mode 100644 index 053011840d42..000000000000 --- a/doc/schemas/disableoffer.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["offer_id"], - "properties": { - "offer_id": { - "type": "hex", - "description": "the id we use to identify this offer", - "maxLength": 64, - "minLength": 64 - } - } -} \ No newline at end of file diff --git a/doc/schemas/disableoffer.schema.json b/doc/schemas/disableoffer.schema.json deleted file mode 100644 index 3c4a28446882..000000000000 --- a/doc/schemas/disableoffer.schema.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "offer_id", - "active", - "single_use", - "bolt12", - "used" - ], - "additionalProperties": false, - "properties": { - "offer_id": { - "type": "hash", - "description": "the merkle hash of the offer" - }, - "active": { - "type": "boolean", - "enum": [ - false - ], - "description": "Whether the offer can produce invoices/payments" - }, - "single_use": { - "type": "boolean", - "description": "Whether the offer is disabled after first successful use" - }, - "bolt12": { - "type": "string", - "description": "The bolt12 string representing this offer" - }, - "used": { - "type": "boolean", - "description": "Whether the offer has had an invoice paid / payment made" - }, - "label": { - "type": "string", - "description": "The label provided when offer was created" - } - } -} diff --git a/doc/schemas/disconnect.request.json b/doc/schemas/disconnect.request.json deleted file mode 100644 index c823d72ca390..000000000000 --- a/doc/schemas/disconnect.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "the public key of the peer to terminate the connection.\n\tIt can be discovered in the output of the listpeers command, which returns a set of peers:\n\t{\n\t\t'peers': [\n\t\t\t{\n\t\t\t'id': '0563aea81...',\n\t\t\t'connected': true,\n\t\t\t...\n\t\t}\n\t\t]\n\t}" - }, - "force": { - "type": "boolean", - "description": "if set to True, it will disconnect even with an active channel" - } - } -} diff --git a/doc/schemas/disconnect.schema.json b/doc/schemas/disconnect.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/disconnect.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/emergencyrecover.request.json b/doc/schemas/emergencyrecover.request.json deleted file mode 100644 index f99496c5ac84..000000000000 --- a/doc/schemas/emergencyrecover.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/emergencyrecover.schema.json b/doc/schemas/emergencyrecover.schema.json deleted file mode 100644 index 17c3e64383c8..000000000000 --- a/doc/schemas/emergencyrecover.schema.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "stubs" - ], - "properties": { - "stubs": { - "type": "array", - "items": { - "type": "hex", - "description": "Channel IDs of channels successfully inserted." - } - } - } -} diff --git a/doc/schemas/feerates.request.json b/doc/schemas/feerates.request.json deleted file mode 100644 index 032d8aee2684..000000000000 --- a/doc/schemas/feerates.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "style" - ], - "properties": { - "style": { - "type": "string", - "description": "\n\t*perkw* - provide feerate in units of satoshis per 1000 weight (e.g. the minimum fee is usually `253perkw`)\n\t*perkb* - provide feerate in units of satoshis per 1000 virtual bytes (eg. the minimum fee is usually `1000perkb`)", - "enum": [ - "perkb", - "perkw" - ] - } - } -} diff --git a/doc/schemas/feerates.schema.json b/doc/schemas/feerates.schema.json deleted file mode 100644 index a98969818802..000000000000 --- a/doc/schemas/feerates.schema.json +++ /dev/null @@ -1,226 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "warning_missing_feerates": { - "type": "string", - "description": "Some fee estimates are missing" - }, - "perkb": { - "type": "object", - "description": "If *style* parameter was perkb", - "additionalProperties": false, - "required": [ - "min_acceptable", - "max_acceptable", - "floor", - "estimates" - ], - "properties": { - "min_acceptable": { - "type": "u32", - "description": "The smallest feerate that we allow peers to specify: half the 100-block estimate" - }, - "max_acceptable": { - "type": "u32", - "description": "The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet)." - }, - "floor": { - "type": "u32", - "added": "v23.05", - "description": "The smallest feerate that our backend tells us it will accept (i.e. minrelayfee or mempoolminfee)" - }, - "estimates": { - "type": "array", - "added": "v23.05", - "description": "Feerate estimates from plugin which we are using (usuallly bcli)", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "blockcount", - "feerate", - "smoothed_feerate" - ], - "properties": { - "blockcount": { - "type": "u32", - "added": "v23.05", - "description": "The number of blocks the feerate is expected to get a transaction in" - }, - "feerate": { - "type": "u32", - "added": "v23.05", - "description": "The feerate for this estimate, in given *style*" - }, - "smoothed_feerate": { - "type": "u32", - "added": "v23.05", - "description": "The feerate, smoothed over time (useful for coordinating with other nodes)" - } - } - } - }, - "opening": { - "type": "u32", - "description": "Default feerate for lightning-fundchannel(7) and lightning-withdraw(7)" - }, - "mutual_close": { - "type": "u32", - "description": "Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer." - }, - "unilateral_close": { - "type": "u32", - "description": "Feerate for commitment_transaction in a live channel which we originally funded" - }, - "unilateral_anchor_close": { - "type": "u32", - "added": "v23.08", - "description": "Feerate for commitment_transaction in a live channel which we originally funded (if anchor_outputs was negotiated)" - }, - "delayed_to_us": { - "type": "u32", - "deprecated": "v23.05", - "description": "Feerate for returning unilateral close funds to our wallet" - }, - "htlc_resolution": { - "type": "u32", - "deprecated": "v23.05", - "description": "Feerate for returning unilateral close HTLC outputs to our wallet" - }, - "penalty": { - "type": "u32", - "description": "Feerate to use when creating penalty tx for watchtowers" - } - } - }, - "perkw": { - "type": "object", - "description": "If *style* parameter was perkw", - "additionalProperties": false, - "required": [ - "min_acceptable", - "max_acceptable", - "floor", - "estimates" - ], - "properties": { - "min_acceptable": { - "type": "u32", - "description": "The smallest feerate that you can use, usually the minimum relayed feerate of the backend" - }, - "max_acceptable": { - "type": "u32", - "description": "The largest feerate we will accept from remote negotiations. If a peer attempts to set the feerate higher than this we will unilaterally close the channel (or simply forget it if it's not open yet)." - }, - "floor": { - "type": "u32", - "added": "v23.05", - "description": "The smallest feerate that our backend tells us it will accept (i.e. minrelayfee or mempoolminfee)" - }, - "estimates": { - "type": "array", - "added": "v23.05", - "description": "Feerate estimates from plugin which we are using (usuallly bcli)", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "blockcount", - "feerate", - "smoothed_feerate" - ], - "properties": { - "blockcount": { - "type": "u32", - "added": "v23.05", - "description": "The number of blocks the feerate is expected to get a transaction in" - }, - "feerate": { - "type": "u32", - "added": "v23.05", - "description": "The feerate for this estimate, in given *style*" - }, - "smoothed_feerate": { - "type": "u32", - "added": "v23.05", - "description": "The feerate, smoothed over time (useful for coordinating with other nodes)" - } - } - } - }, - "opening": { - "type": "u32", - "description": "Default feerate for lightning-fundchannel(7) and lightning-withdraw(7)" - }, - "mutual_close": { - "type": "u32", - "description": "Feerate to aim for in cooperative shutdown. Note that since mutual close is a **negotiation**, the actual feerate used in mutual close will be somewhere between this and the corresponding mutual close feerate of the peer." - }, - "unilateral_close": { - "type": "u32", - "description": "Feerate for commitment_transaction in a live channel which we originally funded (if anchor_outputs was not negotiated)" - }, - "unilateral_anchor_close": { - "type": "u32", - "added": "v23.08", - "description": "Feerate for commitment_transaction in a live channel which we originally funded (if anchor_outputs was negotiated)" - }, - "delayed_to_us": { - "type": "u32", - "deprecated": "v23.05", - "description": "Feerate for returning unilateral close funds to our wallet" - }, - "htlc_resolution": { - "type": "u32", - "deprecated": "v23.05", - "description": "Feerate for returning unilateral close HTLC outputs to our wallet" - }, - "penalty": { - "type": "u32", - "description": "Feerate to use when creating penalty tx for watchtowers" - } - } - }, - "onchain_fee_estimates": { - "type": "object", - "additionalProperties": false, - "required": [ - "opening_channel_satoshis", - "mutual_close_satoshis", - "unilateral_close_satoshis", - "htlc_timeout_satoshis", - "htlc_success_satoshis" - ], - "properties": { - "opening_channel_satoshis": { - "type": "u64", - "description": "Estimated cost of typical channel open" - }, - "mutual_close_satoshis": { - "type": "u64", - "description": "Estimated cost of typical channel close" - }, - "unilateral_close_satoshis": { - "type": "u64", - "description": "Estimated cost of typical unilateral close (without HTLCs). If anchors are supported, this assumes a channel with anchors." - }, - "unilateral_close_nonanchor_satoshis": { - "added": "v23.08", - "type": "u64", - "description": "Estimated cost of non-anchor typical unilateral close (without HTLCs)." - }, - "htlc_timeout_satoshis": { - "type": "u64", - "description": "Estimated cost of typical HTLC timeout transaction (non-anchors)" - }, - "htlc_success_satoshis": { - "type": "u64", - "description": "Estimated cost of typical HTLC fulfillment transaction (non-anchors)" - } - } - } - } -} diff --git a/doc/schemas/fetchinvoice.request.json b/doc/schemas/fetchinvoice.request.json deleted file mode 100644 index dbbfb8342cad..000000000000 --- a/doc/schemas/fetchinvoice.request.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "offer" - ], - "additionalProperties": false, - "properties": { - "offer": { - "type": "string", - "description": "offer string to get an actual invoice that can be paid" - }, - "amount_msat": { - "type": "msat", - "description": "required if the offer does not specify an amount at all, otherwise it is optional (but presumably if you set it to less than the offer, you will get an error from the issuer)" - }, - "quantity": { - "type": "u64", - "description": "required if the offer specifies quantity_max, otherwise it is not allowed" - }, - "recurrence_counter": { - "type": "u64", - "description": "required if the offer specifies recurrence, otherwise it is not allowed. recurrence_counter should first be set to 0, and incremented for each successive invoice in a given series" - }, - "recurrence_start": { - "type": "number", - "description": "required if the offer specifies recurrence_base with start_any_period set, otherwise it is not allowed. It indicates what period number to start at" - }, - "recurrence_label": { - "type": "string", - "description": "required if recurrence_counter is set, and otherwise is not allowed. It must be the same as prior fetchinvoice calls for the same recurrence, as it is used to link them together" - }, - "timeout": { - "type": "number", - "description": "if we don't get a reply before this we fail (default, 60 seconds)" - }, - "payer_note": { - "type": "string", - "description": "to ask the issuer to include in the fetched invoice" - } - } -} diff --git a/doc/schemas/fetchinvoice.schema.json b/doc/schemas/fetchinvoice.schema.json deleted file mode 100644 index 8c6d2365562e..000000000000 --- a/doc/schemas/fetchinvoice.schema.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invoice", - "changes" - ], - "properties": { - "invoice": { - "type": "string", - "description": "The BOLT12 invoice we fetched" - }, - "changes": { - "type": "object", - "description": "Summary of changes from offer", - "additionalProperties": false, - "required": [], - "properties": { - "description_appended": { - "type": "string", - "description": "extra characters appended to the *description* field." - }, - "description": { - "type": "string", - "description": "a completely replaced *description* field" - }, - "vendor_removed": { - "type": "string", - "description": "The *vendor* from the offer, which is missing in the invoice" - }, - "vendor": { - "type": "string", - "description": "a completely replaced *vendor* field" - }, - "amount_msat": { - "type": "msat", - "description": "the amount, if different from the offer amount multiplied by any *quantity* (or the offer had no amount, or was not in BTC)." - } - } - }, - "next_period": { - "type": "object", - "description": "Only for recurring invoices if the next period is under the *recurrence_limit*", - "additionalProperties": false, - "required": [ - "counter", - "starttime", - "endtime", - "paywindow_start", - "paywindow_end" - ], - "properties": { - "counter": { - "type": "u64", - "description": "the index of the next period to fetchinvoice" - }, - "starttime": { - "type": "u64", - "description": "UNIX timestamp that the next period starts" - }, - "endtime": { - "type": "u64", - "description": "UNIX timestamp that the next period ends" - }, - "paywindow_start": { - "type": "u64", - "description": "UNIX timestamp of the earliest time that the next invoice can be fetched" - }, - "paywindow_end": { - "type": "u64", - "description": "UNIX timestamp of the latest time that the next invoice can be fetched" - } - } - } - } -} diff --git a/doc/schemas/fundchannel.request.json b/doc/schemas/fundchannel.request.json deleted file mode 100644 index ff080bac1c5f..000000000000 --- a/doc/schemas/fundchannel.request.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "amount" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "id is the peer id obtained from connect" - }, - "amount": { - "type": "msat_or_all", - "description": "the amount in satoshis taken from the internal wallet to fund the channel (but if we have any anchor channels, this will always leave at least `min-emergency-msat` as change). The string *all* can be used to specify all available funds (or 16777215 satoshi if more is available and large channels were not negotiated with the peer). Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*. The value cannot be less than the dust limit, currently set to 546, nor more than 16777215 satoshi (unless large channels were negotiated with the peer)" - }, - "feerate": { - "type": "feerate", - "description": "used for the opening transaction and (unless *option_anchors_zero_fee_htlc_tx* is negotiated), as initial feerate for commitment and HTLC transactions (see NOTES in lightning-feerates(7)). The default is *normal*" - }, - "announce": { - "type": "boolean", - "description": "whether to announce this channel or not. An unannounced channel is considered private. Defaults to *True*" - }, - "minconf": { - "type": "u32", - "description": "the minimum number of confirmations that used outputs should have. Default is 1" - }, - "push_msat": { - "type": "msat", - "description": "the amount of millisatoshis to push to the channel peer at open. Note that this is a gift to the peer -- these satoshis are added to the initial balance of the peer at channel start and are largely unrecoverable once pushed" - }, - "close_to": { - "type": "string", - "description": "a Bitcoin address to which the channel funds should be sent to on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`. Returns `close_to` set to closing script iff is negotiated" - }, - "request_amt": { - "type": "msat", - "description": "an amount of liquidity you'd like to lease from the peer. If peer supports `option_will_fund`, indicates to them to include this much liquidity into the channel. Must also pass in *compact_lease*" - }, - "compact_lease": { - "type": "string", - "description": "a compact represenation of the peer's expected channel lease terms. If the peer's terms don't match this set, we will fail to open the channel" - }, - "utxos": { - "type": "array", - "description": "the utxos to be used to fund the channel, as an array of `txid:vout`", - "items": { - "type": "outpoint" - } - }, - "mindepth": { - "description": "Number of confirmations required before we consider the channel active", - "type": "u32" - }, - "reserve": { - "type": "msat", - "description": "the amount we want the peer to maintain on its side of the channel. Default is 1% of the funding amount. It can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - } - } -} diff --git a/doc/schemas/fundchannel.schema.json b/doc/schemas/fundchannel.schema.json deleted file mode 100644 index 63444352f718..000000000000 --- a/doc/schemas/fundchannel.schema.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "tx", - "txid", - "outnum", - "channel_id" - ], - "properties": { - "tx": { - "type": "hex", - "description": "The raw transaction which funded the channel" - }, - "txid": { - "type": "txid", - "description": "The txid of the transaction which funded the channel" - }, - "outnum": { - "type": "u32", - "description": "The 0-based output index showing which output funded the channel" - }, - "channel_id": { - "type": "hex", - "description": "The channel_id of the resulting channel", - "minLength": 64, - "maxLength": 64 - }, - "close_to": { - "type": "hex", - "description": "The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`" - }, - "mindepth": { - "type": "u32", - "description": "Number of confirmations before we consider the channel active." - } - } -} diff --git a/doc/schemas/fundchannel_cancel.request.json b/doc/schemas/fundchannel_cancel.request.json deleted file mode 100644 index d380e4663e48..000000000000 --- a/doc/schemas/fundchannel_cancel.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["id"], - "properties": { - "id": { - "type": "pubkey", - "description": "node id of the remote peer with which to cancel" - } - } -} \ No newline at end of file diff --git a/doc/schemas/fundchannel_cancel.schema.json b/doc/schemas/fundchannel_cancel.schema.json deleted file mode 100644 index 2c507db3e20f..000000000000 --- a/doc/schemas/fundchannel_cancel.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "cancelled" - ], - "properties": { - "cancelled": { - "type": "string", - "description": "A message indicating it was cancelled by RPC" - } - } -} diff --git a/doc/schemas/fundchannel_complete.request.json b/doc/schemas/fundchannel_complete.request.json deleted file mode 100644 index 77466f7433f3..000000000000 --- a/doc/schemas/fundchannel_complete.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["id", "psbt"], - "properties": { - "id": { - "type": "pubkey", - "description": "node id of the remote peer" - }, - "psbt": { - "type": "string", - "description": "transaction to use for funding (does not need to be signed but must be otherwise complete)" - } - } -} \ No newline at end of file diff --git a/doc/schemas/fundchannel_complete.schema.json b/doc/schemas/fundchannel_complete.schema.json deleted file mode 100644 index 3b3d0eefbaae..000000000000 --- a/doc/schemas/fundchannel_complete.schema.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "commitments_secured" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "The channel_id of the resulting channel", - "minLength": 64, - "maxLength": 64 - }, - "commitments_secured": { - "type": "boolean", - "enum": [ - true - ], - "description": "Indication that channel is safe to use" - } - } -} diff --git a/doc/schemas/fundchannel_start.request.json b/doc/schemas/fundchannel_start.request.json deleted file mode 100644 index 9f07bdbf1f63..000000000000 --- a/doc/schemas/fundchannel_start.request.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["id", "amount"], - "properties": { - "id": { - "type": "pubkey", - "description": "node id of the remote peer" - }, - "amount": { - "type": "integer", - "description": "satoshi value that the channel will be funded at. This value MUST be accurate, otherwise the negotiated commitment transactions will not encompass the correct channel value" - }, - "feerate": { - "type": "object", - "description": "feerate for subsequent commitment transactions: see **fundchannel**. Note that this is ignored for channels with *option_anchors_zero_fee_htlc_tx* (we always use a low commitment fee for these)", - "additionalProperties": false, - "required": [ - "perkw", - "perkb" - ], - "properties": { - "perkw": { - "type": "u32", - "description": "Feerate per 1000 weight (i.e kSipa)" - }, - "perkb": { - "type": "u32", - "description": "Feerate per 1000 virtual bytes" - } - } - }, - "announce": { - "type": "boolean", - "description": "whether or not to announce this channel" - }, - "close_to": { - "type": "string", - "description": "bitcoin address to which the channel funds should be sent to on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`. Returns `close_to` set to closing script iff is negotiated" - }, - "push_msat": { - "type": "msat", - "description": "amount of millisatoshis to push to the channel peer at open. Note that this is a gift to the peer -- these satoshis are added to the initial balance of the peer at channel start and are largely unrecoverable once pushed" - } - } -} \ No newline at end of file diff --git a/doc/schemas/fundchannel_start.schema.json b/doc/schemas/fundchannel_start.schema.json deleted file mode 100644 index cbd420a39e75..000000000000 --- a/doc/schemas/fundchannel_start.schema.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "funding_address", - "scriptpubkey", - "warning_usage" - ], - "properties": { - "funding_address": { - "type": "string", - "description": "The address to send funding to for the channel. DO NOT SEND COINS TO THIS ADDRESS YET." - }, - "scriptpubkey": { - "type": "hex", - "description": "The raw scriptPubkey for the address" - }, - "close_to": { - "type": "hex", - "description": "The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`" - }, - "warning_usage": { - "type": "string", - "description": "A warning not to prematurely broadcast the funding transaction (always present!)" - }, - "mindepth": { - "type": "u32", - "description": "Number of confirmations before we consider the channel active." - } - } -} diff --git a/doc/schemas/funderupdate.request.json b/doc/schemas/funderupdate.request.json deleted file mode 100644 index d029598713ae..000000000000 --- a/doc/schemas/funderupdate.request.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "policy": { - "type": "string", - "enum": [ - "match", - "available", - "fixed" - ], - "description": "funder plugin will use to decide how much captial to commit to a v2 open channel request.\n\tThere are three policy options, detailed below:\n\t* `match` -- Contribute *policy_mod* percent of their requested funds.\n\tValid *policy_mod* values are 0 to 200. If this is a channel lease\n\trequest, we match based on their requested funds. If it is not a\n\tchannel lease request (and *lease_only* is false), then we match\n\ttheir funding amount. Note: any lease match less than 100 will\n\tlikely fail, as clients will not accept a lease less than their request.\n\t* `available` -- Contribute *policy_mod* percent of our available\n\tnode wallet funds. Valid *policy_mod* values are 0 to 100.\n\t* `fixed` -- Contributes a fixed *policy_mod* sats to v2 channel open requests.\n\tDefault is fixed" - }, - "policy_mod": { - "type": "u32", - "description": "number or 'modification' to apply to the policy. Default is 0sats" - }, - "leases_only": { - "type": "boolean", - "description": "only contribute funds to `option_will_fund` requests which pay to lease funds. It will fund any v2 open request using *policy* even if it's they're not seeking to lease funds. Note that `option_will_fund` commits funds for 4032 blocks (~1mo). Must also set *lease_fee_base_msat*, *lease_fee_basis*, *funding_weight*, *channel_fee_max_base_msat*, and *channel_fee_max_proportional_thousandths* to advertise available channel leases. Defaults to *False*" - }, - "min_their_funding_msat": { - "type": "msat", - "description": "minimum funding sats that we require in order to activate our contribution policy to the v2 open. Defaults to 10k sats" - }, - "max_their_funding_msat": { - "type": "msat", - "description": "maximum funding sats that we will consider to activate our contribution policy to the v2 open. Any channel open above this will not be funded. Defaults to no max (`UINT_MAX`)" - }, - "per_channel_min_msat": { - "type": "msat", - "description": "minimum amount that we will contribute to a channel open. Defaults to 10k sats" - }, - "per_channel_max_msat": { - "type": "msat", - "description": "maximum amount that we will contribute to a channel open. Defaults to no max (`UINT_MAX`)" - }, - "reserve_tank_msat": { - "type": "msat", - "description": "amount of sats to leave available in the node wallet. Defaults to zero sats" - }, - "fuzz_percent": { - "type": "u32", - "description": "a percentage to fuzz the resulting contribution amount by. Valid values are 0 to 100. Note that turning this on with (match, 100) policy will randomly fail `option_will_fund` leases, as most clients expect an exact or greater match of their `requested_funds`. Defaults to 0% (no fuzz)" - }, - "fund_probability": { - "type": "u32", - "description": "the percent of v2 channel open requests to apply our policy to. Valid values are integers from 0 (fund 0% of all open requests) to 100 (fund every request). Useful for randomizing opens that receive funds. Useful for randomizing opens that receive funds. Defaults to 100" - }, - "lease_fee_base_msat": { - "type": "msat", - "description": "flat fee for a channel lease. Node will receive this much extra added to their channel balance, paid by the opening node. Defaults to 2k sats. Note that the minimum is 1sat" - }, - "lease_fee_basis": { - "type": "u32", - "description": "a basis fee that's calculated as 1/10k of the total requested funds the peer is asking for. Node will receive the total of *lease_fee_basis* times requested funds / 10k satoshis added to their channel balance, paid by the opening node. Default is 0.65% (65 basis points)" - }, - "funding_weight": { - "type": "u32", - "description": "to calculate the fee the peer will compensate your node for its contributing inputs to the funding transaction. The total fee is calculated as the `open_channel2`.`funding_feerate_perkw` times this *funding_weight* divided by 1000. Node will have this funding fee added to their channel balance, paid by the opening node. Default is 2 inputs + 1 P2WPKH output" - }, - "channel_fee_max_base_msat": { - "type": "msat", - "description": "a commitment to a maximum `channel_fee_base_msat` that your node will charge for routing payments over this leased channel during the lease duration. Default is 5k sats" - }, - "channel_fee_max_proportional_thousandths": { - "type": "u32", - "description": "a commitment to a maximum `channel_fee_proportional_millionths` that your node will charge for routing payments over this leased channel during the lease duration. Note that it's denominated in 'thousandths'. A setting of `1` is equal to 1k ppm; `5` is 5k ppm, etc. Default is 100 (100k ppm)" - }, - "compact_lease": { - "type": "hex", - "description": "a compact description of the channel lease params. When opening a channel, passed in to `fundchannel` to indicate the terms we expect from the peer" - } - } -} \ No newline at end of file diff --git a/doc/schemas/funderupdate.schema.json b/doc/schemas/funderupdate.schema.json deleted file mode 100644 index 4bca1365220b..000000000000 --- a/doc/schemas/funderupdate.schema.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "summary", - "policy", - "policy_mod", - "leases_only", - "min_their_funding_msat", - "max_their_funding_msat", - "per_channel_min_msat", - "per_channel_max_msat", - "reserve_tank_msat", - "fuzz_percent", - "fund_probability" - ], - "properties": { - "summary": { - "type": "string", - "description": "Summary of the current funding policy e.g. (match 100)" - }, - "policy": { - "type": "string", - "enum": [ - "match", - "available", - "fixed" - ], - "description": "Policy funder plugin will use to decide how much captial to commit to a v2 open channel request" - }, - "policy_mod": { - "type": "u32", - "description": "The *policy_mod* is the number or 'modification' to apply to the policy." - }, - "leases_only": { - "type": "boolean", - "description": "Only contribute funds to `option_will_fund` lease requests." - }, - "min_their_funding_msat": { - "type": "msat", - "description": "The minimum funding sats that we require from peer to activate our funding policy." - }, - "max_their_funding_msat": { - "type": "msat", - "description": "The maximum funding sats that we'll allow from peer to activate our funding policy." - }, - "per_channel_min_msat": { - "type": "msat", - "description": "The minimum amount that we will fund a channel open with." - }, - "per_channel_max_msat": { - "type": "msat", - "description": "The maximum amount that we will fund a channel open with." - }, - "reserve_tank_msat": { - "type": "msat", - "description": "Amount of sats to leave available in the node wallet." - }, - "fuzz_percent": { - "type": "u32", - "description": "Percentage to fuzz our funding amount by." - }, - "fund_probability": { - "type": "u32", - "description": "Percent of opens to consider funding. 100 means we'll consider funding every requested open channel request." - }, - "lease_fee_base_msat": { - "type": "msat", - "description": "Flat fee to charge for a channel lease." - }, - "lease_fee_basis": { - "type": "u32", - "description": "Proportional fee to charge for a channel lease, calculated as 1/10,000th of requested funds." - }, - "funding_weight": { - "type": "u32", - "description": "Transaction weight the channel opener will pay us for a leased funding transaction." - }, - "channel_fee_max_base_msat": { - "type": "msat", - "description": "Maximum channel_fee_base_msat we'll charge for routing funds leased on this channel." - }, - "channel_fee_max_proportional_thousandths": { - "type": "u32", - "description": "Maximum channel_fee_proportional_millitionths we'll charge for routing funds leased on this channel, in thousandths." - }, - "compact_lease": { - "type": "hex", - "description": "Compact description of the channel lease parameters." - } - } -} diff --git a/doc/schemas/fundpsbt.request.json b/doc/schemas/fundpsbt.request.json deleted file mode 100644 index d1baebd68d42..000000000000 --- a/doc/schemas/fundpsbt.request.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "satoshi", - "feerate", - "startweight" - ], - "properties": { - "satoshi": { - "type": "msat_or_all", - "description": "the minimum satoshi value of the output(s) needed (or the string `all` meaning use all unreserved inputs). If a value, it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - }, - "feerate": { - "type": "feerate", - "description": "used for the transaction as initial feerate. The default is *normal*" - }, - "startweight": { - "type": "u32", - "description": "the weight of the transaction before *fundpsbt* has added any inputs" - }, - "minconf": { - "type": "u32", - "description": "the minimum number of confirmations that used outputs should have. Default is 1" - }, - "reserve": { - "type": "u32", - "description": "if not zero, then *reserveinputs* is called (successfully, with *exclusive* true) on the returned PSBT for this number of blocks. Defaults to 72 blocks if unspecified" - }, - "locktime": { - "type": "u32", - "description": "the locktime of the transaction. if not set, it is set to a recent block height" - }, - "min_witness_weight": { - "type": "u32", - "description": "minimum weight to use for a UTXO's witness. If the actual witness weight is greater than the provided minimum, the actual witness weight will be used" - }, - "excess_as_change": { - "type": "boolean", - "description": "flag to add a change output for the excess sats" - }, - "nonwrapped": { - "added": "v23.02", - "type": "boolean", - "description": "to signal to filter out any p2sh-wrapped inputs from funding this PSBT" - }, - "opening_anchor_channel": { - "added": "v23.08", - "type": "boolean", - "description": "to signel that it needs emergency reserve for anchors so that we can lowball our commitment tx fees, and min-emergency-msat for reserving some sats for closing anchor channels" - } - } -} diff --git a/doc/schemas/fundpsbt.schema.json b/doc/schemas/fundpsbt.schema.json deleted file mode 100644 index 84f0969e77f9..000000000000 --- a/doc/schemas/fundpsbt.schema.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt", - "feerate_per_kw", - "estimated_final_weight", - "excess_msat" - ], - "properties": { - "psbt": { - "type": "string", - "description": "Unsigned PSBT which fulfills the parameters given" - }, - "feerate_per_kw": { - "type": "u32", - "description": "The feerate used to create the PSBT, in satoshis-per-kiloweight" - }, - "estimated_final_weight": { - "type": "u32", - "description": "The estimated weight of the transaction once fully signed" - }, - "excess_msat": { - "type": "msat", - "description": "The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change_outnum* is also returned" - }, - "change_outnum": { - "type": "u32", - "description": "The 0-based output number where change was placed (only if parameter *excess_as_change* was true and there was sufficient funds)" - }, - "reservations": { - "type": "array", - "description": "If *reserve* was true or a non-zero number, just as per lightning-reserveinputs(7)", - "items": { - "type": "object", - "required": [ - "txid", - "vout", - "was_reserved", - "reserved", - "reserved_to_block" - ], - "additionalProperties": false, - "properties": { - "txid": { - "type": "txid", - "description": "The txid of the transaction" - }, - "vout": { - "type": "u32", - "description": "The 0-based output number" - }, - "was_reserved": { - "type": "boolean", - "enum": [ - false - ], - "description": "Whether this output was previously reserved" - }, - "reserved": { - "type": "boolean", - "enum": [ - true - ], - "description": "Whether this output is now reserved" - }, - "reserved_to_block": { - "type": "u32", - "description": "The blockheight the reservation will expire" - } - } - } - } - } -} diff --git a/doc/schemas/getinfo.request.json b/doc/schemas/getinfo.request.json deleted file mode 100644 index f99496c5ac84..000000000000 --- a/doc/schemas/getinfo.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/getinfo.schema.json b/doc/schemas/getinfo.schema.json deleted file mode 100644 index ceba996f896f..000000000000 --- a/doc/schemas/getinfo.schema.json +++ /dev/null @@ -1,297 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "alias", - "color", - "num_peers", - "num_pending_channels", - "num_active_channels", - "num_inactive_channels", - "version", - "blockheight", - "network", - "fees_collected_msat", - "lightning-dir", - "address" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "The public key unique to this node" - }, - "alias": { - "type": "string", - "description": "The fun alias this node will advertize", - "maxLength": 32 - }, - "color": { - "type": "hex", - "description": "The favorite RGB color this node will advertize", - "minLength": 6, - "maxLength": 6 - }, - "num_peers": { - "type": "u32", - "description": "The total count of peers, connected or with channels" - }, - "num_pending_channels": { - "type": "u32", - "description": "The total count of channels being opened" - }, - "num_active_channels": { - "type": "u32", - "description": "The total count of channels in normal state" - }, - "num_inactive_channels": { - "type": "u32", - "description": "The total count of channels waiting for opening or closing transactions to be mined" - }, - "version": { - "type": "string", - "description": "Identifies what bugs you are running into" - }, - "lightning-dir": { - "type": "string", - "description": "Identifies where you can find the configuration and other related files" - }, - "our_features": { - "type": "object", - "description": "Our BOLT #9 feature bits (as hexstring) for various contexts", - "additionalProperties": true, - "required": [ - "init", - "node", - "channel", - "invoice" - ], - "properties": { - "init": { - "type": "hex", - "description": "features (incl. globalfeatures) in our init message, these also restrict what we offer in open_channel or accept in accept_channel" - }, - "node": { - "type": "hex", - "description": "features in our node_announcement message" - }, - "channel": { - "type": "hex", - "description": "negotiated channel features we (as channel initiator) publish in the channel_announcement message" - }, - "invoice": { - "type": "hex", - "description": "features in our BOLT11 invoices" - } - } - }, - "blockheight": { - "type": "u32", - "description": "The highest block height we've learned" - }, - "network": { - "type": "string", - "description": "represents the type of network on the node are working (e.g: `bitcoin`, `testnet`, or `regtest`)" - }, - "fees_collected_msat": { - "type": "msat", - "description": "Total routing fees collected by this node" - }, - "address": { - "type": "array", - "description": "The addresses we announce to the world", - "items": { - "type": "object", - "required": [ - "type", - "port" - ], - "additionalProperties": true, - "properties": { - "type": { - "type": "string", - "enum": [ - "dns", - "ipv4", - "ipv6", - "torv2", - "torv3" - ], - "description": "Type of connection (until 23.08, `websocket` was also allowed)" - }, - "port": { - "type": "u16", - "description": "port number" - } - }, - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "dns", - "ipv4", - "ipv6", - "torv2", - "torv3" - ] - } - } - }, - "then": { - "required": [ - "type", - "address", - "port" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "port": {}, - "address": { - "type": "string", - "description": "address in expected format for **type**" - } - } - }, - "else": { - "required": [ - "type", - "port" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "port": {} - } - } - } - }, - "binding": { - "type": "array", - "description": "The addresses we are listening on", - "items": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "*FIXME*": "The variant in connect.schema.json is more complete", - "enum": [ - "local socket", - "websocket", - "ipv4", - "ipv6", - "torv2", - "torv3" - ], - "description": "Type of connection" - }, - "address": { - "type": "string", - "description": "address in expected format for **type**" - }, - "port": { - "type": "u16", - "description": "port number" - } - }, - "allOf": [ - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "local socket" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "type", - "socket" - ], - "properties": { - "type": {}, - "socket": { - "type": "string", - "description": "socket filename" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "type", - "address", - "port" - ], - "properties": { - "type": {}, - "address": {}, - "port": {}, - "subtype": {} - } - } - }, - { - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "websocket" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "type", - "address", - "port", - "subtype" - ], - "properties": { - "type": {}, - "address": {}, - "port": {}, - "subtype": { - "type": "string", - "description": "type of address" - } - } - }, - "else": { - "additionalProperties": false, - "required": [ - "type" - ], - "properties": { - "type": {}, - "address": {}, - "port": {}, - "socket": {} - } - } - } - ] - } - }, - "warning_bitcoind_sync": { - "type": "string", - "description": "Bitcoind is not up-to-date with network." - }, - "warning_lightningd_sync": { - "type": "string", - "description": "Lightningd is still loading latest blocks from bitcoind." - } - } -} diff --git a/doc/schemas/getlog.request.json b/doc/schemas/getlog.request.json deleted file mode 100644 index 3adb34edc7ad..000000000000 --- a/doc/schemas/getlog.request.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "level": { - "type": "string", - "enum": [ - "broken", - "unusual", - "info", - "debug", - "io" - ], - "description": "a string that represents the log level. The default is *info*" - } - } -} \ No newline at end of file diff --git a/doc/schemas/getlog.schema.json b/doc/schemas/getlog.schema.json deleted file mode 100644 index b2ba62b7555d..000000000000 --- a/doc/schemas/getlog.schema.json +++ /dev/null @@ -1,163 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "created_at", - "bytes_used", - "bytes_max", - "log" - ], - "properties": { - "created_at": { - "type": "string", - "description": "UNIX timestamp with 9 decimal places, when logging was initialized" - }, - "bytes_used": { - "type": "u32", - "description": "The number of bytes used by logging records" - }, - "bytes_max": { - "type": "u32", - "description": "The bytes_used values at which records will be trimmed " - }, - "log": { - "type": "array", - "items": { - "type": "object", - "required": [ - "type" - ], - "additionalProperties": true, - "properties": { - "type": { - "type": "string", - "enum": [ - "SKIPPED", - "BROKEN", - "UNUSUAL", - "INFO", - "DEBUG", - "IO_IN", - "IO_OUT" - ] - } - }, - "allOf": [ - { - "if": { - "additionalProperties": true, - "properties": { - "type": { - "enum": [ - "SKIPPED" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "num_skipped" - ], - "properties": { - "type": {}, - "num_skipped": { - "type": "u32", - "description": "number of unprinted log entries (deleted or below *level* parameter)" - } - } - } - }, - { - "if": { - "additionalProperties": true, - "properties": { - "type": { - "enum": [ - "BROKEN", - "UNUSUAL", - "INFO", - "DEBUG" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "time", - "source", - "log" - ], - "properties": { - "type": {}, - "time": { - "type": "string", - "description": "UNIX timestamp with 9 decimal places after **created_at**" - }, - "source": { - "type": "string", - "description": "The particular logbook this was found in" - }, - "log": { - "type": "string", - "description": "The actual log message" - }, - "node_id": { - "type": "pubkey", - "description": "The peer this is associated with" - } - } - } - }, - { - "if": { - "additionalProperties": true, - "properties": { - "type": { - "enum": [ - "IO_IN", - "IO_OUT" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "time", - "source", - "log", - "data" - ], - "properties": { - "type": {}, - "time": { - "type": "string", - "description": "Seconds after **created_at**, with 9 decimal places" - }, - "source": { - "type": "string", - "description": "The particular logbook this was found in" - }, - "log": { - "type": "string", - "description": "The associated log message" - }, - "node_id": { - "type": "pubkey", - "description": "The peer this is associated with" - }, - "data": { - "type": "hex", - "description": "The IO which occurred" - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/getroute.request.json b/doc/schemas/getroute.request.json deleted file mode 100644 index 81c1ed20618e..000000000000 --- a/doc/schemas/getroute.request.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "id", - "amount_msat", - "riskfactor" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "node pubkey to find the best route for the payment" - }, - "amount_msat": { - "type": "msat", - "description": "amount to send. It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*. The 0 value is special: it ignores any *htlc_minimum_msat* setting on channels, and simply returns a possible route (if any) which is useful for simple probing" - }, - "riskfactor": { - "type": "u64", - "description": "a non-negative floating-point field controls this tradeoff; it is the annual cost of your funds being stuck (as a percentage).\n\tFor example, if you thought the convenience of keeping your funds liquid (not stuck) was worth 20% per annum interest, *riskfactor* would be 20.\n\tIf you didn't care about risk, *riskfactor* would be zero" - }, - "cltv": { - "type": "u32", - "description": "cltv-blocks to spare. Default is 9" - }, - "fromid": { - "type": "pubkey", - "description": "the node to start the route from. Default is this node" - }, - "fuzzpercent": { - "type": "u32", - "description": "used to distort fees to provide some randomization to the route generated, but it was not properly implemented and is ignored" - }, - "exclude": { - "type": "array", - "description": "a JSON array of short-channel-id/direction (e.g. ['564334x877x1/0', '564195x1292x0/1' ]) or node-id which should be excluded from consideration for routing. The default is not to exclude any channels or nodes. Note if the source or destination is excluded, the command result is undefined", - "items": { - "type": "string" - } - }, - "maxhops": { - "type": "u32", - "description": "the maximum number of channels to return. Default is 20" - } - } -} diff --git a/doc/schemas/getroute.schema.json b/doc/schemas/getroute.schema.json deleted file mode 100644 index 8faa690a1e99..000000000000 --- a/doc/schemas/getroute.schema.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "route" - ], - "properties": { - "route": { - "type": "array", - "items": { - "type": "object", - "required": [ - "id", - "direction", - "channel", - "amount_msat", - "delay", - "style" - ], - "additionalProperties": false, - "properties": { - "id": { - "type": "pubkey", - "description": "The node at the end of this hop" - }, - "channel": { - "type": "short_channel_id", - "description": "The channel joining these nodes" - }, - "direction": { - "type": "u32", - "description": "0 if this channel is traversed from lesser to greater **id**, otherwise 1" - }, - "amount_msat": { - "type": "msat", - "description": "The amount expected by the node at the end of this hop" - }, - "delay": { - "type": "u32", - "description": "The total CLTV expected by the node at the end of this hop" - }, - "style": { - "type": "string", - "description": "The features understood by the destination node", - "enum": [ - "tlv" - ] - } - } - } - } - } -} diff --git a/doc/schemas/help.request.json b/doc/schemas/help.request.json deleted file mode 100644 index dc4c9c23da3f..000000000000 --- a/doc/schemas/help.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "command": { - "type": "string", - "description": "command to get information about" - } - } -} \ No newline at end of file diff --git a/doc/schemas/help.schema.json b/doc/schemas/help.schema.json deleted file mode 100644 index df8777c0d28e..000000000000 --- a/doc/schemas/help.schema.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "help" - ], - "properties": { - "help": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "command", - "category", - "description", - "verbose" - ], - "properties": { - "command": { - "type": "string", - "description": "the command" - }, - "category": { - "type": "string", - "description": "the category for this command (useful for grouping)" - }, - "description": { - "type": "string", - "description": "a one-line description of the purpose of this command" - }, - "verbose": { - "type": "string", - "description": "a full description of this command (including whether it's deprecated)" - } - } - } - }, - "format-hint": {} - } -} diff --git a/doc/schemas/invoice.request.json b/doc/schemas/invoice.request.json deleted file mode 100644 index 237a123a9f7b..000000000000 --- a/doc/schemas/invoice.request.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "amount_msat", - "label", - "description" - ], - "properties": { - "amount_msat": { - "type": "msat_or_any", - "description": "the string `any`, which creates an invoice that can be paid with any amount. Otherwise it is a positive value in millisatoshi precision; it can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*" - }, - "label": { - "type": "string", - "description": "a unique string or number (which is treated as a string, so `01` is different from `1`); it is never revealed to other nodes on the lightning network, but it can be used to query the status of this invoice" - }, - "description": { - "type": "string", - "description": "a short description of purpose of payment, e.g. *1 cup of coffee*. This value is encoded into the BOLT11 invoice and is viewable by any node you send this invoice to (unless *deschashonly* is true as described below). It must be UTF-8, and cannot use *\\u* JSON escape codes" - }, - "expiry": { - "type": "u64", - "description": "the time the invoice is valid for, in seconds. If no value is provided the default of 604800 (1 week) is used" - }, - "fallbacks": { - "type": "array", - "description": "one or more fallback addresses to include in the invoice (in order from most-preferred to least): note that these arrays are not currently tracked to fulfill the invoice", - "items": { - "type": "string" - } - }, - "preimage": { - "type": "hex", - "description": "a 64-digit hex string to be used as payment preimage for the created invoice. By default, if unspecified, lightningd will generate a secure pseudorandom preimage seeded from an appropriate entropy source on your system. **IMPORTANT**: if you specify the *preimage*, you are responsible, to ensure appropriate care for generating using a secure pseudorandom generator seeded with sufficient entropy, and keeping the preimage secret. This parameter is an advanced feature intended for use with cutting-edge cryptographic protocols and should not be used unless explicitly needed" - }, - "exposeprivatechannels": { - "description": "if specified, it overrides the default route hint logic, which will use unpublished channels only if there are no published channels", - "oneOf": [ - { - "type": "boolean", - "description": "if *True* unpublished channels are always considered as a route hint candidate; if *False*, never" - }, - { - "type": "array", - "description": "array of short channel ids (or a remote alias), only those specific channels will be considered candidates, even if they are public or dead-ends", - "items": { - "type": "short_channel_id" - } - }, - { - "type": "short_channel_id", - "description": "if it is a short channel id (e.g. *1x1x3*), only this specific channel will be considered candidate, even if it is public or dead-end" - } - ] - }, - "cltv": { - "type": "u32", - "description": "if specified, sets the *min_final_cltv_expiry* for the invoice. Otherwise, it's set to the parameter **cltv-final**" - }, - "deschashonly": { - "type": "boolean", - "description": "if True, then the bolt11 returned contains a hash of the *description*, rather than the *description* itself: this allows much longer descriptions, but they must be communicated via some other mechanism. Defaults to False" - } - } -} diff --git a/doc/schemas/invoice.schema.json b/doc/schemas/invoice.schema.json deleted file mode 100644 index d9e073061852..000000000000 --- a/doc/schemas/invoice.schema.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "payment_hash", - "expires_at", - "created_index", - "bolt11", - "payment_secret" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "the bolt11 string" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "payment_secret": { - "type": "secret", - "description": "the *payment_secret* to place in the onion" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when invoice expires" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "warning_capacity": { - "type": "string", - "description": "even using all possible channels, there's not enough incoming capacity to pay this invoice." - }, - "warning_offline": { - "type": "string", - "description": "there would be enough incoming capacity, but some channels are offline, so there isn't." - }, - "warning_deadends": { - "type": "string", - "description": "there would be enough incoming capacity, but some channels are dead-ends (no other public channels from those peers), so there isn't." - }, - "warning_private_unused": { - "type": "string", - "description": "there would be enough incoming capacity, but some channels are unannounced and *exposeprivatechannels* is *false*, so there isn't." - }, - "warning_mpp": { - "type": "string", - "description": "there is sufficient capacity, but not in a single channel, so the payer will have to use multi-part payments." - } - } -} diff --git a/doc/schemas/invoicerequest.request.json b/doc/schemas/invoicerequest.request.json deleted file mode 100644 index fbade5e2a5f0..000000000000 --- a/doc/schemas/invoicerequest.request.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "amount", - "description" - ], - "added": "v22.11", - "properties": { - "amount": { - "type": "msat", - "description": "a positive value in millisatoshi precision; it can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*" - }, - "description": { - "type": "string", - "description": "a short description of purpose of the payment, e.g. *ATM withdrawl*. This value is encoded into the resulting `invoice_request` and is viewable by anyone you expose it to. It must be UTF-8, and cannot use *\\u* JSON escape codes" - }, - "issuer": { - "type": "string", - "description": "who is issuing it (i.e. you) if appropriate" - }, - "label": { - "type": "string", - "description": "an internal-use name for the offer, which can be any UTF-8 string" - }, - "absolute_expiry": { - "type": "u64", - "description": "the time the offer is valid until, in seconds since the first day of 1970 UTC. If not set, the `invoice_request` remains valid (though it can be deactivated by the issuer of course). This is encoded in the `invoice_request`" - }, - "single_use": { - "type": "boolean", - "description": "indicates that the `invoice_request` is only valid once; we may attempt multiple payments, but as soon as one is successful no more invoices are accepted (i.e. only one person can take the money). Defaults to True" - } - } -} diff --git a/doc/schemas/invoicerequest.schema.json b/doc/schemas/invoicerequest.schema.json deleted file mode 100644 index 378a95650c72..000000000000 --- a/doc/schemas/invoicerequest.schema.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invreq_id", - "single_use", - "active", - "bolt12", - "used" - ], - "properties": { - "invreq_id": { - "type": "hash", - "description": "the SHA256 hash of all invoice_request fields less than 160" - }, - "active": { - "type": "boolean", - "enum": [ - true - ], - "description": "whether the invoice_request is currently active" - }, - "single_use": { - "type": "boolean", - "description": "whether the invoice_request will become inactive after we pay an invoice for it" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string starting with lnr" - }, - "used": { - "type": "boolean", - "enum": [ - false - ], - "description": "whether the invoice_request has already been used" - }, - "label": { - "type": "string", - "description": "the label provided when creating the invoice_request" - } - } -} diff --git a/doc/schemas/keysend.request.json b/doc/schemas/keysend.request.json deleted file mode 100644 index 66f37cb4b42c..000000000000 --- a/doc/schemas/keysend.request.json +++ /dev/null @@ -1,79 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "destination", - "amount_msat" - ], - "properties": { - "destination": { - "type": "pubkey", - "description": "the 33 byte, hex-encoded, node ID of the node that the payment should go to" - }, - "amount_msat": { - "type": "msat", - "description": "a whole number, or a whole number with suffix `msat` or `sat`, or a three decimal point number with suffix `sat`, or an 1 to 11 decimal point number suffixed by `btc`" - }, - "label": { - "type": "string", - "description": "used to attach a label to payments, and is returned in lightning-listpays(7) and lightning-listsendpays(7)" - }, - "maxfeepercent": { - "type": "number", - "description": "limits the money paid in fees as percentage of the total amount that is to be transferred, and defaults to *0.5*" - }, - "retry_for": { - "type": "u32", - "description": "until *retry_for* seconds passes, the command will keep finding routes and retrying the payment. However, a payment may be delayed for up to `maxdelay` blocks by another node; clients should be prepared for this worst case. Defaults to 60 seconds" - }, - "maxdelay": { - "type": "u32", - "description": "number of blocks the payment may be delayed" - }, - "exemptfee": { - "type": "msat", - "description": "used for tiny payments which would be dominated by the fee leveraged by forwarding nodes. Setting `exemptfee` allows the `maxfeepercent` check to be skipped on fees that are smaller than *exemptfee*. Defaults to 5000 millisatoshi" - }, - "routehints": { - "type": "array", - "items": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "scid", - "feebase", - "feeprop", - "expirydelta" - ], - "properties": { - "id": { - "type": "pubkey" - }, - "scid": { - "type": "short_channel_id" - }, - "feebase": { - "type": "msat" - }, - "feeprop": { - "type": "u32" - }, - "expirydelta": { - "type": "u16" - } - } - } - } - }, - "extratlvs": { - "type": "object", - "additionalProperties": true, - "required": [], - "description": "dictionary of additional fields to insert into the final tlv. The format is 'fieldnumber': 'hexstring'" - } - } -} diff --git a/doc/schemas/keysend.schema.json b/doc/schemas/keysend.schema.json deleted file mode 100644 index a2a3fc88b435..000000000000 --- a/doc/schemas/keysend.schema.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "payment_preimage", - "payment_hash", - "created_at", - "parts", - "amount_msat", - "amount_sent_msat", - "status" - ], - "properties": { - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "created_at": { - "type": "number", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "parts": { - "type": "u32", - "description": "how many attempts this took" - }, - "amount_msat": { - "type": "msat", - "description": "Amount the recipient received" - }, - "amount_sent_msat": { - "type": "msat", - "description": "Total amount we sent (including fees)" - }, - "warning_partial_completion": { - "type": "string", - "description": "Not all parts of a multi-part payment have completed" - }, - "status": { - "type": "string", - "enum": [ - "complete" - ], - "description": "status of payment" - } - } -} diff --git a/doc/schemas/listchannels.request.json b/doc/schemas/listchannels.request.json deleted file mode 100644 index 2779b0298de4..000000000000 --- a/doc/schemas/listchannels.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "short_channel_id": { - "type": "short_channel_id", - "description": "if short_channel_id is a short channel id, then only known channels with a matching short_channel_id are returned. Otherwise, it must be null" - }, - "source": { - "type": "pubkey", - "description": "if source is a node id, then only channels leading from that node id are returned" - }, - "destination": { - "type": "pubkey", - "description": "if destination is a node id, then only channels leading to that node id are returned" - } - } -} diff --git a/doc/schemas/listchannels.schema.json b/doc/schemas/listchannels.schema.json deleted file mode 100644 index bd3dd50de372..000000000000 --- a/doc/schemas/listchannels.schema.json +++ /dev/null @@ -1,101 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channels" - ], - "properties": { - "channels": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "source", - "destination", - "short_channel_id", - "direction", - "public", - "amount_msat", - "message_flags", - "channel_flags", - "active", - "last_update", - "base_fee_millisatoshi", - "fee_per_millionth", - "delay", - "htlc_minimum_msat", - "features" - ], - "properties": { - "source": { - "type": "pubkey", - "description": "the source node" - }, - "destination": { - "type": "pubkey", - "description": "the destination node" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "short channel id of channel" - }, - "direction": { - "type": "u32", - "description": "direction (0 if source < destination, 1 otherwise)." - }, - "public": { - "type": "boolean", - "description": "true if this is announced (from *v24.02*, being false is deprecated)" - }, - "amount_msat": { - "type": "msat", - "description": "the total capacity of this channel (always a whole number of satoshis)" - }, - "message_flags": { - "type": "u8", - "description": "as defined by BOLT #7" - }, - "channel_flags": { - "type": "u8", - "description": "as defined by BOLT #7" - }, - "active": { - "type": "boolean", - "description": "true unless source has disabled it (or (deprecated in *v24.02*) it's a local channel and the peer is disconnected or it's still opening or closing)" - }, - "last_update": { - "type": "u32", - "description": "UNIX timestamp on the last channel_update from *source*" - }, - "base_fee_millisatoshi": { - "type": "u32", - "description": "Base fee changed by *source* to use this channel" - }, - "fee_per_millionth": { - "type": "u32", - "description": "Proportional fee changed by *source* to use this channel, in parts-per-million" - }, - "delay": { - "type": "u32", - "description": "The number of blocks delay required by *source* to use this channel" - }, - "htlc_minimum_msat": { - "type": "msat", - "description": "The smallest payment *source* will allow via this channel" - }, - "satoshis": {}, - "htlc_maximum_msat": { - "type": "msat", - "description": "The largest payment *source* will allow via this channel" - }, - "features": { - "type": "hex", - "description": "BOLT #9 features bitmap for this channel" - } - } - } - } - } -} diff --git a/doc/schemas/listclosedchannels.request.json b/doc/schemas/listclosedchannels.request.json deleted file mode 100644 index eb11e66565ad..000000000000 --- a/doc/schemas/listclosedchannels.request.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "added": "v23.05", - "properties": { - "id": { - "type": "pubkey", - "description": "if no *id* is supplied, then channel data on all historical channels are given. Supplying *id* will filter the results to only match channels to that peer. Note that prior to v23.05, old peers were forgotten" - } - } -} diff --git a/doc/schemas/listclosedchannels.schema.json b/doc/schemas/listclosedchannels.schema.json deleted file mode 100644 index b090bf2cbcc0..000000000000 --- a/doc/schemas/listclosedchannels.schema.json +++ /dev/null @@ -1,188 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.05", - "required": [ - "closedchannels" - ], - "properties": { - "closedchannels": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "channel_id", - "opener", - "private", - "total_msat", - "total_local_commitments", - "total_remote_commitments", - "total_htlcs_sent", - "funding_txid", - "funding_outnum", - "leased", - "final_to_us_msat", - "min_to_us_msat", - "max_to_us_msat", - "close_cause" - ], - "properties": { - "peer_id": { - "type": "pubkey", - "description": "Peer public key (can be missing with pre-v23.05 closes!)" - }, - "channel_id": { - "type": "hash", - "description": "The full channel_id (funding txid Xored with output number)" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "The short_channel_id" - }, - "alias": { - "type": "object", - "required": [], - "properties": { - "local": { - "type": "short_channel_id", - "description": "An alias assigned by this node to this channel, used for outgoing payments" - }, - "remote": { - "type": "short_channel_id", - "description": "An alias assigned by the remote node to this channel, usable in routehints and invoices" - } - } - }, - "opener": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel" - }, - "closer": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel close (only present if closing)" - }, - "private": { - "type": "boolean", - "description": "if True, we will not announce this channel" - }, - "channel_type": { - "type": "object", - "description": "channel_type as negotiated with peer", - "additionalProperties": false, - "required": [ - "bits", - "names" - ], - "properties": { - "bits": { - "type": "array", - "description": "Each bit set in this channel_type", - "items": { - "type": "u32", - "description": "Bit number" - } - }, - "names": { - "type": "array", - "description": "Feature name for each bit set in this channel_type", - "items": { - "type": "string", - "enum": [ - "static_remotekey/even", - "anchor_outputs/even", - "anchors_zero_fee_htlc_tx/even", - "scid_alias/even", - "zeroconf/even" - ], - "description": "Name of feature bit" - } - } - } - }, - "total_local_commitments": { - "type": "u64", - "description": "Number of commitment transaction we made" - }, - "total_remote_commitments": { - "type": "u64", - "description": "Number of commitment transaction they made" - }, - "total_htlcs_sent": { - "type": "u64", - "description": "Number of HTLCs we ever sent" - }, - "funding_txid": { - "type": "txid", - "description": "ID of the funding transaction" - }, - "funding_outnum": { - "type": "u32", - "description": "The 0-based output number of the funding transaction which opens the channel" - }, - "leased": { - "type": "boolean", - "description": "Whether this channel was leased from `opener`" - }, - "funding_fee_paid_msat": { - "type": "msat", - "description": "How much we paid to lease the channel (iff `leased` is true and `opener` is local)" - }, - "funding_fee_rcvd_msat": { - "type": "msat", - "description": "How much they paid to lease the channel (iff `leased` is true and `opener` is remote)" - }, - "funding_pushed_msat": { - "type": "msat", - "description": "How much `opener` pushed immediate (if non-zero)" - }, - "total_msat": { - "type": "msat", - "description": "total amount in the channel" - }, - "final_to_us_msat": { - "type": "msat", - "description": "Our balance in final commitment transaction" - }, - "min_to_us_msat": { - "type": "msat", - "description": "Least amount owed to us ever. If the peer were to succesfully steal from us, this is the amount we would still retain." - }, - "max_to_us_msat": { - "type": "msat", - "description": "Most amount owed to us ever. If we were to successfully steal from the peer, this is the amount we could potentially get." - }, - "last_commitment_txid": { - "type": "hash", - "description": "The final commitment tx's txid (or mutual close, if we accepted it). Not present for some very old, small channels pre-0.7.0." - }, - "last_commitment_fee_msat": { - "type": "msat", - "description": "The fee on `last_commitment_txid`" - }, - "close_cause": { - "type": "string", - "enum": [ - "unknown", - "local", - "user", - "remote", - "protocol", - "onchain" - ], - "description": "What caused the channel to close" - } - } - } - } - } -} diff --git a/doc/schemas/listconfigs.request.json b/doc/schemas/listconfigs.request.json deleted file mode 100644 index 9c74a640d873..000000000000 --- a/doc/schemas/listconfigs.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "config": { - "type": "string", - "description": "configuration option name to restrict return" - } - } -} \ No newline at end of file diff --git a/doc/schemas/listconfigs.schema.json b/doc/schemas/listconfigs.schema.json deleted file mode 100644 index bc307d191752..000000000000 --- a/doc/schemas/listconfigs.schema.json +++ /dev/null @@ -1,1798 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "configs": { - "added": "v23.08", - "type": "object", - "comment": "Plugins can add fields to this, so we can't rule out additional properties :(", - "additionalProperties": true, - "required": [], - "properties": { - "conf": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from cmdline" - }, - "source": { - "type": "string", - "enum": [ - "cmdline" - ], - "description": "source of configuration setting" - } - } - }, - "developer": { - "type": "object", - "added": "v23.08", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "clear-plugins": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "disable-mpp": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - }, - "plugin": { - "type": "string", - "description": "plugin which registered this configuration setting" - } - } - }, - "mainnet": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "regtest": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "signet": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "testnet": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "important-plugin": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "plugin": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "plugin-dir": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "lightning-dir": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "network": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default (can also be changed by `testnet`, `signet`, `regtest` options!)" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "allow-deprecated-apis": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "rpc-file": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "disable-plugin": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "always-use-proxy": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "daemon": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "wallet": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "large-channels": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-dual-fund": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-splicing": { - "added": "v23.08", - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-onion-messages": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-offers": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-shutdown-wrong-funding": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-websocket-port": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-peer-storage": { - "added": "v23.02", - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "experimental-anchors": { - "type": "object", - "added": "v23.08", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "database-upgrade": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "rgb": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "hex", - "description": "field from config or cmdline, or default", - "maxLength": 6, - "minLength": 6 - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "alias": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "pid-file": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "ignore-fee-limits": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "watchtime-blocks": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "max-locktime-blocks": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "funding-confirms": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "cltv-delta": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "cltv-final": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "commit-time": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "fee-base": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "rescan": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "integer", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "fee-per-satoshi": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "max-concurrent-htlcs": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "htlc-minimum-msat": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_msat", - "source" - ], - "properties": { - "value_msat": { - "type": "msat", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "htlc-maximum-msat": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_msat", - "source" - ], - "properties": { - "value_msat": { - "type": "msat", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "max-dust-htlc-exposure-msat": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_msat", - "source" - ], - "properties": { - "value_msat": { - "type": "msat", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "min-capacity-sat": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u64", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - }, - "dynamic": { - "type": "boolean", - "enum": [ - true - ], - "description": "Can this be set by setconfig()" - } - } - }, - "addr": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "announce-addr": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "bind-addr": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "offline": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "autolisten": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "proxy": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "disable-dns": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "announce-addr-discovered": { - "added": "v23.02", - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "enum": [ - "true", - "false", - "auto" - ], - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "announce-addr-discovered-port": { - "added": "v23.02", - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "encrypted-hsm": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "rpc-file-mode": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "log-level": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "log-prefix": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "log-file": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "log-timestamps": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "force-feerates": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "subdaemon": { - "type": "object", - "additionalProperties": false, - "required": [ - "values_str", - "sources" - ], - "properties": { - "values_str": { - "type": "array", - "items": { - "type": "string", - "description": "field from config or cmdline" - } - }, - "sources": { - "type": "array", - "items": { - "type": "string", - "description": "source of configuration setting" - } - } - } - }, - "fetchinvoice-noconnect": { - "type": "object", - "additionalProperties": false, - "required": [ - "set", - "source" - ], - "properties": { - "set": { - "type": "boolean", - "description": "`true` if set in config or cmdline" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "accept-htlc-tlv-types": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "tor-service-password": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_str", - "source" - ], - "properties": { - "value_str": { - "type": "string", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "announce-addr-dns": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "require-confirmed-inputs": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_bool", - "source" - ], - "properties": { - "value_bool": { - "type": "boolean", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "commit-fee": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u64", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - }, - "commit-feerate-offset": { - "type": "object", - "additionalProperties": false, - "required": [ - "value_int", - "source" - ], - "properties": { - "value_int": { - "type": "u32", - "description": "field from config or cmdline, or default" - }, - "source": { - "type": "string", - "description": "source of configuration setting" - } - } - } - } - }, - "# version": { - "deprecated": "v23.08", - "type": "string", - "description": "Special field indicating the current version" - }, - "plugins": { - "type": "array", - "deprecated": "v23.08", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "path", - "name" - ], - "description": "`plugin` field from config or cmdline", - "properties": { - "path": { - "type": "string", - "description": "Full path of the plugin" - }, - "name": { - "type": "string", - "description": "short name of the plugin" - }, - "options": { - "type": "object", - "additionalProperties": true, - "required": [], - "description": "Specific options set for this plugin", - "properties": {} - } - } - } - }, - "important-plugins": { - "type": "array", - "deprecated": "v23.08", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "path", - "name" - ], - "description": "`important-plugin` field from config or cmdline, or built-in", - "properties": { - "path": { - "type": "string", - "description": "Full path of the plugin" - }, - "name": { - "type": "string", - "description": "short name of the plugin" - }, - "options": { - "type": "object", - "additionalProperties": true, - "required": [], - "description": "Specific options set for this plugin", - "properties": {} - } - } - } - }, - "conf": { - "deprecated": "v23.08", - "type": "string", - "description": "`conf` field from cmdline, or default" - }, - "lightning-dir": { - "deprecated": "v23.08", - "type": "string", - "description": "`lightning-dir` field from config or cmdline, or default" - }, - "network": { - "deprecated": "v23.08", - "type": "string", - "description": "`network` field from config or cmdline, or default" - }, - "allow-deprecated-apis": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`allow-deprecated-apis` field from config or cmdline, or default" - }, - "rpc-file": { - "deprecated": "v23.08", - "type": "string", - "description": "`rpc-file` field from config or cmdline, or default" - }, - "disable-plugin": { - "deprecated": "v23.08", - "type": "array", - "items": { - "type": "string", - "description": "`disable-plugin` field from config or cmdline" - } - }, - "bookkeeper-dir": { - "deprecated": "v23.08", - "type": "string", - "description": "`bookkeeper-dir` field from config or cmdline, or default" - }, - "bookkeeper-db": { - "deprecated": "v23.08", - "type": "string", - "description": "`bookkeeper-db` field from config or cmdline, or default" - }, - "always-use-proxy": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`always-use-proxy` field from config or cmdline, or default" - }, - "daemon": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`daemon` field from config or cmdline, or default" - }, - "wallet": { - "deprecated": "v23.08", - "type": "string", - "description": "`wallet` field from config or cmdline default" - }, - "large-channels": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`large-channels` field from config or cmdline, or default" - }, - "experimental-dual-fund": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`experimental-dual-fund` field from config or cmdline, or default" - }, - "experimental-splicing": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`experimental-splicing` field from config or cmdline, or default" - }, - "experimental-onion-messages": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`experimental-onion-messages` field from config or cmdline, or default" - }, - "experimental-offers": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`experimental-offers` field from config or cmdline, or default" - }, - "experimental-shutdown-wrong-funding": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`experimental-shutdown-wrong-funding` field from config or cmdline, or default" - }, - "experimental-websocket-port": { - "deprecated": "v23.08", - "type": "u16", - "description": "`experimental-websocket-port` field from config or cmdline, or default" - }, - "experimental-peer-storage": { - "deprecated": "v23.08", - "type": "boolean", - "added": "v23.02", - "description": "`experimental-peer-storage` field from config or cmdline, or default" - }, - "experimental-quiesce": { - "type": "boolean", - "added": "v23.08", - "deprecated": "v23.08", - "description": "`experimental-quiesce` field from config or cmdline, or default" - }, - "experimental-upgrade-protocol": { - "type": "boolean", - "added": "v23.08", - "deprecated": "v23.08", - "description": "`experimental-upgrade-protocol` field from config or cmdline, or default" - }, - "invoices-onchain-fallback": { - "type": "boolean", - "added": "v23.11", - "description": "`invoices-onchain-fallback` field from config or cmdline, or default" - }, - "database-upgrade": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`database-upgrade` field from config or cmdline" - }, - "rgb": { - "deprecated": "v23.08", - "type": "hex", - "description": "`rgb` field from config or cmdline, or default", - "maxLength": 6, - "minLength": 6 - }, - "alias": { - "deprecated": "v23.08", - "type": "string", - "description": "`alias` field from config or cmdline, or default" - }, - "pid-file": { - "deprecated": "v23.08", - "type": "string", - "description": "`pid-file` field from config or cmdline, or default" - }, - "ignore-fee-limits": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`ignore-fee-limits` field from config or cmdline, or default" - }, - "watchtime-blocks": { - "deprecated": "v23.08", - "type": "u32", - "description": "`watchtime-blocks` field from config or cmdline, or default" - }, - "max-locktime-blocks": { - "deprecated": "v23.08", - "type": "u32", - "description": "`max-locktime-blocks` field from config or cmdline, or default" - }, - "funding-confirms": { - "deprecated": "v23.08", - "type": "u32", - "description": "`funding-confirms` field from config or cmdline, or default" - }, - "cltv-delta": { - "deprecated": "v23.08", - "type": "u32", - "description": "`cltv-delta` field from config or cmdline, or default" - }, - "cltv-final": { - "deprecated": "v23.08", - "type": "u32", - "description": "`cltv-final` field from config or cmdline, or default" - }, - "commit-time": { - "deprecated": "v23.08", - "type": "u32", - "description": "`commit-time` field from config or cmdline, or default" - }, - "fee-base": { - "deprecated": "v23.08", - "type": "u32", - "description": "`fee-base` field from config or cmdline, or default" - }, - "rescan": { - "deprecated": "v23.08", - "type": "integer", - "description": "`rescan` field from config or cmdline, or default" - }, - "fee-per-satoshi": { - "deprecated": "v23.08", - "type": "u32", - "description": "`fee-per-satoshi` field from config or cmdline, or default" - }, - "max-concurrent-htlcs": { - "deprecated": "v23.08", - "type": "u32", - "description": "`max-concurrent-htlcs` field from config or cmdline, or default" - }, - "htlc-minimum-msat": { - "deprecated": "v23.08", - "type": "msat", - "description": "`htlc-minimum-msat` field from config or cmdline, or default" - }, - "htlc-maximum-msat": { - "deprecated": "v23.08", - "type": "msat", - "description": "`htlc-maximum-msat` field from config or cmdline, or default" - }, - "max-dust-htlc-exposure-msat": { - "deprecated": "v23.08", - "type": "msat", - "description": "`max-dust-htlc-exposure-mast` field from config or cmdline, or default" - }, - "min-capacity-sat": { - "deprecated": "v23.08", - "type": "u64", - "description": "`min-capacity-sat` field from config or cmdline, or default" - }, - "addr": { - "deprecated": "v23.08", - "type": "string", - "description": "`addr` field from config or cmdline (can be more than one)" - }, - "announce-addr": { - "deprecated": "v23.08", - "type": "string", - "description": "`announce-addr` field from config or cmdline (can be more than one)" - }, - "bind-addr": { - "deprecated": "v23.08", - "type": "string", - "description": "`bind-addr` field from config or cmdline (can be more than one)" - }, - "offline": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`true` if `offline` was set in config or cmdline" - }, - "autolisten": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`autolisten` field from config or cmdline, or default" - }, - "proxy": { - "deprecated": "v23.08", - "type": "string", - "description": "`proxy` field from config or cmdline, or default" - }, - "disable-dns": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`true` if `disable-dns` was set in config or cmdline" - }, - "disable-ip-discovery": { - "deprecated": "v23.02", - "type": "boolean", - "description": "`true` if `disable-ip-discovery` was set in config or cmdline" - }, - "announce-addr-discovered": { - "deprecated": "v23.08", - "type": "string", - "description": "`true`/`false`/`auto` depending on how `announce-addr-discovered` was set in config or cmdline", - "added": "v23.02" - }, - "announce-addr-discovered-port": { - "deprecated": "v23.08", - "type": "integer", - "description": "Sets the announced TCP port for dynamically discovered IPs.", - "added": "v23.02" - }, - "encrypted-hsm": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`true` if `encrypted-hsm` was set in config or cmdline" - }, - "rpc-file-mode": { - "deprecated": "v23.08", - "type": "string", - "description": "`rpc-file-mode` field from config or cmdline, or default" - }, - "log-level": { - "deprecated": "v23.08", - "type": "string", - "description": "`log-level` field from config or cmdline, or default" - }, - "log-prefix": { - "deprecated": "v23.08", - "type": "string", - "description": "`log-prefix` field from config or cmdline, or default" - }, - "log-file": { - "deprecated": "v23.08", - "type": "string", - "description": "`log-file` field from config or cmdline, or default" - }, - "log-timestamps": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`log-timestamps` field from config or cmdline, or default" - }, - "force-feerates": { - "deprecated": "v23.08", - "type": "string", - "description": "force-feerate configuration setting, if any" - }, - "subdaemon": { - "deprecated": "v23.08", - "type": "string", - "description": "`subdaemon` fields from config or cmdline if any (can be more than one)" - }, - "fetchinvoice-noconnect": { - "deprecated": "v23.08", - "type": "boolean", - "description": "`fetchinvoice-noconnect` fields from config or cmdline, or default" - }, - "accept-htlc-tlv-types": { - "deprecated": "v23.08", - "type": "string", - "description": "`accept-htlc-tlv-types` field from config or cmdline, or not present" - }, - "tor-service-password": { - "deprecated": "v23.08", - "type": "string", - "description": "`tor-service-password` field from config or cmdline, if any" - }, - "dev-allowdustreserve": { - "deprecated": "v23.08", - "type": "boolean", - "description": "Whether we allow setting dust reserves" - }, - "announce-addr-dns": { - "deprecated": "v23.08", - "type": "boolean", - "added": "v22.11.1", - "description": "Whether we put DNS entries into node_announcement" - }, - "require-confirmed-inputs": { - "deprecated": "v23.08", - "type": "boolean", - "description": "Request peers to only send confirmed inputs (dual-fund only)" - }, - "developer": { - "added": "v23.08", - "type": "boolean", - "description": "Whether developer mode is enabled" - }, - "commit-fee": { - "deprecated": "v23.08", - "type": "u64", - "added": "v23.05", - "description": "The percentage of the 6-block fee estimate to use for commitment transactions" - }, - "min-emergency-msat": { - "type": "msat", - "added": "v23.08", - "description": "field from config or cmdline, or default" - }, - "commit-feerate-offset": { - "type": "u32", - "added": "v23.11", - "description": "additional commitment feerate applied by channel owner" - } - } -} diff --git a/doc/schemas/listdatastore.request.json b/doc/schemas/listdatastore.request.json deleted file mode 100644 index 2002bbd32231..000000000000 --- a/doc/schemas/listdatastore.request.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "key": { - "oneOf": [ - { - "type": "array", - "description": "all immediate children of the *key* (or root children) are returned.\n\t\tUsing the first element of the key as the plugin name (e.g. `[ 'summary' ]`) is recommended.\n\t\tAn array of values to form a hierarchy (though a single value is treated as a one-element array)", - "items": { - "type": "string" - } - }, - { - "type": "string" - } - ] - } - } -} diff --git a/doc/schemas/listdatastore.schema.json b/doc/schemas/listdatastore.schema.json deleted file mode 100644 index a07f793de3b4..000000000000 --- a/doc/schemas/listdatastore.schema.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "datastore" - ], - "properties": { - "datastore": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "key" - ], - "properties": { - "key": { - "type": "array", - "items": { - "type": "string", - "description": "Part of the key added to the datastore" - } - }, - "generation": { - "type": "u64", - "description": "The number of times this has been updated" - }, - "hex": { - "type": "hex", - "description": "The hex data from the datastore" - }, - "string": { - "type": "string", - "description": "The data as a string, if it's valid utf-8" - } - } - } - } - } -} diff --git a/doc/schemas/listforwards.request.json b/doc/schemas/listforwards.request.json deleted file mode 100644 index 22c91902d2dc..000000000000 --- a/doc/schemas/listforwards.request.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "properties": { - "status": { - "type": "string", - "description": "if specified, then only the forwards with the given status are returned", - "enum": [ - "offered", - "settled", - "local_failed", - "failed" - ] - }, - "in_channel": { - "type": "short_channel_id", - "description": "only the matching forwards on the given inbound channel are returned" - }, - "out_channel": { - "type": "short_channel_id", - "description": "only the matching forwards on the given outbount channel are returned" - }, - "index": { - "type": "string", - "added": "v23.11", - "enum": [ - "created", - "updated" - ], - "description": "if neither *in_channel* nor *out_channel* is specified, it controls ordering. Defaults to `created`" - }, - "start": { - "type": "u64", - "added": "v23.11", - "description": "if `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)" - }, - "limit": { - "type": "u32", - "added": "v23.11", - "description": "if `index` is specified, `limit` can be used to specify the maximum number of entries to return" - } - } -} diff --git a/doc/schemas/listforwards.schema.json b/doc/schemas/listforwards.schema.json deleted file mode 100644 index a5b999054ff1..000000000000 --- a/doc/schemas/listforwards.schema.json +++ /dev/null @@ -1,267 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "forwards" - ], - "properties": { - "forwards": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "created_index", - "in_channel", - "in_msat", - "status", - "received_time" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this forward was created in" - }, - "in_channel": { - "type": "short_channel_id", - "description": "the channel that received the HTLC" - }, - "in_htlc_id": { - "type": "u64", - "description": "the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)" - }, - "in_msat": { - "type": "msat", - "description": "the value of the incoming HTLC" - }, - "status": { - "type": "string", - "enum": [ - "offered", - "settled", - "local_failed", - "failed" - ], - "description": "still ongoing, completed, failed locally, or failed after forwarding" - }, - "received_time": { - "type": "number", - "description": "the UNIX timestamp when this was received" - }, - "out_channel": { - "type": "short_channel_id", - "description": "the channel that the HTLC (trying to) forward to" - }, - "out_htlc_id": { - "type": "u64", - "description": "the unique HTLC id we gave this when sending (may be missing even if out_channel is present, for old forwards before v22.11)" - }, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this forward was changed (only present if it has changed since creation)" - }, - "style": { - "type": "string", - "enum": [ - "legacy", - "tlv" - ], - "description": "Either a legacy onion format or a modern tlv format" - } - }, - "allOf": [ - { - "if": { - "required": [ - "out_msat" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "fee_msat", - "out_msat", - "out_channel" - ], - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "resolved_time": {}, - "out_channel": {}, - "out_htlc_id": {}, - "failcode": {}, - "failreason": {}, - "fee_msat": { - "type": "msat", - "description": "the amount this paid in fees" - }, - "out_msat": { - "type": "msat", - "description": "the amount we sent out the *out_channel*" - } - } - }, - "else": { - "additionalProperties": false, - "required": [], - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "resolved_time": {}, - "failcode": {}, - "failreason": {}, - "out_channel": {} - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "settled", - "failed" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "resolved_time" - ], - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "out_channel": {}, - "out_htlc_id": {}, - "fee": {}, - "fee_msat": {}, - "out_msatoshi": {}, - "out_msat": {}, - "failcode": {}, - "failreason": {}, - "resolved_time": { - "type": "number", - "description": "the UNIX timestamp when this was resolved" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "out_channel": {}, - "out_htlc_id": {}, - "fee": {}, - "fee_msat": {}, - "failcode": {}, - "failreason": {}, - "out_msatoshi": {}, - "out_msat": {} - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "local_failed", - "failed" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "out_channel": {}, - "out_htlc_id": {}, - "fee": {}, - "fee_msat": {}, - "out_msatoshi": {}, - "out_msat": {}, - "resolved_time": {}, - "failcode": { - "type": "u32", - "description": "the numeric onion code returned" - }, - "failreason": { - "type": "string", - "description": "the name of the onion code returned" - } - } - }, - "else": { - "additionalProperties": false, - "required": [], - "properties": { - "created_index": {}, - "updated_index": {}, - "in_channel": {}, - "in_htlc_id": {}, - "in_msatoshi": {}, - "in_msat": {}, - "status": {}, - "style": {}, - "received_time": {}, - "out_channel": {}, - "out_htlc_id": {}, - "fee": {}, - "fee_msat": {}, - "out_msatoshi": {}, - "out_msat": {}, - "resolved_time": {} - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listfunds.request.json b/doc/schemas/listfunds.request.json deleted file mode 100644 index cef1bb3128ee..000000000000 --- a/doc/schemas/listfunds.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "spent": { - "type": "boolean", - "description": "if True, then the *outputs* will include spent outputs in addition to the unspent ones. Default is False" - } - } -} diff --git a/doc/schemas/listfunds.schema.json b/doc/schemas/listfunds.schema.json deleted file mode 100644 index c074e93dcd45..000000000000 --- a/doc/schemas/listfunds.schema.json +++ /dev/null @@ -1,275 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "outputs", - "channels" - ], - "properties": { - "outputs": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "txid", - "output", - "amount_msat", - "scriptpubkey", - "status", - "reserved" - ], - "properties": { - "txid": { - "type": "txid", - "description": "the ID of the spendable transaction" - }, - "output": { - "type": "u32", - "description": "the index within *txid*" - }, - "amount_msat": { - "type": "msat", - "description": "the amount of the output" - }, - "scriptpubkey": { - "type": "hex", - "description": "the scriptPubkey of the output" - }, - "address": { - "type": "string", - "description": "the bitcoin address of the output" - }, - "redeemscript": { - "type": "hex", - "description": "the redeemscript, only if it's p2sh-wrapped" - }, - "status": { - "type": "string", - "enum": [ - "unconfirmed", - "confirmed", - "spent", - "immature" - ] - }, - "reserved": { - "type": "boolean", - "description": "whether this UTXO is currently reserved for an in-flight tx" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "confirmed" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "blockheight" - ], - "properties": { - "txid": {}, - "output": {}, - "amount_msat": {}, - "scriptpubkey": {}, - "address": {}, - "value": {}, - "redeemscript": {}, - "status": {}, - "reserved": {}, - "reserved_to_block": {}, - "blockheight": { - "type": "u32", - "description": "Block height where it was confirmed" - } - } - } - }, - { - "if": { - "properties": { - "reserved": { - "type": "boolean", - "enum": [ - "true" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "reserved_to_block" - ], - "properties": { - "txid": {}, - "output": {}, - "amount_msat": {}, - "scriptpubkey": {}, - "address": {}, - "value": {}, - "redeemscript": {}, - "status": {}, - "blockheight": {}, - "reserved": {}, - "reserved_to_block": { - "type": "u32", - "description": "Block height where reservation will expire" - } - } - } - } - ] - } - }, - "channels": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "peer_id", - "our_amount_msat", - "amount_msat", - "funding_txid", - "funding_output", - "connected", - "state", - "channel_id" - ], - "properties": { - "peer_id": { - "type": "pubkey", - "description": "the peer with which the channel is opened" - }, - "our_amount_msat": { - "type": "msat", - "description": "available satoshis on our node's end of the channel" - }, - "amount_msat": { - "type": "msat", - "description": "total channel value" - }, - "funding_txid": { - "type": "txid", - "description": "funding transaction id" - }, - "funding_output": { - "type": "u32", - "description": "the 0-based index of the output in the funding transaction" - }, - "connected": { - "type": "boolean", - "description": "whether the channel peer is connected" - }, - "state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY" - ], - "description": "the channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" - }, - "channel_id": { - "type": "hash", - "description": "The full channel_id (funding txid Xored with output number)", - "added": "v23.05" - } - }, - "allOf": [ - { - "if": { - "properties": { - "state": { - "type": "string", - "enum": [ - "CHANNELD_NORMAL" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "short_channel_id" - ], - "properties": { - "peer_id": {}, - "our_amount_msat": {}, - "channel_sat": {}, - "amount_msat": {}, - "channel_total_sat": {}, - "funding_txid": {}, - "funding_output": {}, - "connected": {}, - "state": {}, - "channel_id": {}, - "short_channel_id": { - "type": "short_channel_id", - "description": "short channel id of channel" - } - } - } - }, - { - "if": { - "properties": { - "state": { - "type": "string", - "enum": [ - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "peer_id": {}, - "our_amount_msat": {}, - "channel_sat": {}, - "amount_msat": {}, - "channel_total_sat": {}, - "funding_txid": {}, - "funding_output": {}, - "connected": {}, - "state": {}, - "channel_id": {}, - "short_channel_id": { - "type": "short_channel_id", - "description": "short channel id of channel (only if funding reached lockin depth before closing)" - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listhtlcs.request.json b/doc/schemas/listhtlcs.request.json deleted file mode 100644 index 764e3dbc064e..000000000000 --- a/doc/schemas/listhtlcs.request.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "properties": { - "id": { - "type": "string", - "description": "a short channel id (e.g. 1x2x3) or full 64-byte hex channel id, it will only list htlcs for that channel (which must be known)" - } - } -} diff --git a/doc/schemas/listhtlcs.schema.json b/doc/schemas/listhtlcs.schema.json deleted file mode 100644 index 8de6f5462a88..000000000000 --- a/doc/schemas/listhtlcs.schema.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "htlcs" - ], - "properties": { - "htlcs": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "short_channel_id", - "id", - "expiry", - "direction", - "amount_msat", - "payment_hash", - "state" - ], - "properties": { - "short_channel_id": { - "type": "short_channel_id", - "description": "the channel that contains/contained the HTLC" - }, - "id": { - "type": "u64", - "description": "the unique, incrementing HTLC id the creator gave this" - }, - "expiry": { - "type": "u32", - "description": "the block number where this HTLC expires/expired" - }, - "amount_msat": { - "type": "msat", - "description": "the value of the HTLC" - }, - "direction": { - "type": "string", - "enum": [ - "out", - "in" - ], - "description": "out if we offered this to the peer, in if they offered it" - }, - "payment_hash": { - "type": "hash", - "description": "payment hash sought by HTLC" - }, - "state": { - "type": "string", - "enum": [ - "SENT_ADD_HTLC", - "SENT_ADD_COMMIT", - "RCVD_ADD_REVOCATION", - "RCVD_ADD_ACK_COMMIT", - "SENT_ADD_ACK_REVOCATION", - "RCVD_REMOVE_HTLC", - "RCVD_REMOVE_COMMIT", - "SENT_REMOVE_REVOCATION", - "SENT_REMOVE_ACK_COMMIT", - "RCVD_REMOVE_ACK_REVOCATION", - "RCVD_ADD_HTLC", - "RCVD_ADD_COMMIT", - "SENT_ADD_REVOCATION", - "SENT_ADD_ACK_COMMIT", - "RCVD_ADD_ACK_REVOCATION", - "SENT_REMOVE_HTLC", - "SENT_REMOVE_COMMIT", - "RCVD_REMOVE_REVOCATION", - "RCVD_REMOVE_ACK_COMMIT", - "SENT_REMOVE_ACK_REVOCATION" - ], - "description": "The first 10 states are for `in`, the next 10 are for `out`." - } - } - } - } - } -} diff --git a/doc/schemas/listinvoicerequests.request.json b/doc/schemas/listinvoicerequests.request.json deleted file mode 100644 index 2b22dace5708..000000000000 --- a/doc/schemas/listinvoicerequests.request.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v22.11", - "properties": { - "invreq_id": { - "type": "string", - "description": "a specific invoice can be queried by providing the `invreq_id`, which is presented by lightning-invoicerequest(7), or can be calculated from a bolt12 invoice" - }, - "active_only": { - "type": "boolean", - "description": "if it is *True* then only active invoice requests are returned. Default is *False*" - } - } -} diff --git a/doc/schemas/listinvoicerequests.schema.json b/doc/schemas/listinvoicerequests.schema.json deleted file mode 100644 index a2472c30e1c6..000000000000 --- a/doc/schemas/listinvoicerequests.schema.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invoicerequests" - ], - "properties": { - "invoicerequests": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "invreq_id", - "single_use", - "active", - "bolt12", - "used" - ], - "properties": { - "invreq_id": { - "type": "hash", - "description": "the SHA256 hash of all invoice_request fields less than 160" - }, - "active": { - "type": "boolean", - "description": "whether the invoice_request is currently active" - }, - "single_use": { - "type": "boolean", - "description": "whether the invoice_request will become inactive after we pay an invoice for it" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string starting with lnr" - }, - "used": { - "type": "boolean", - "description": "whether the invoice_request has already been used" - }, - "label": { - "type": "string", - "description": "the label provided when creating the invoice_request" - } - } - } - } - } -} diff --git a/doc/schemas/listinvoices.request.json b/doc/schemas/listinvoices.request.json deleted file mode 100644 index 5d82eceb1784..000000000000 --- a/doc/schemas/listinvoices.request.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "label": { - "type": "string", - "description": "a label used a the creation of the invoice to get a specific invoice" - }, - "invstring": { - "type": "string", - "description": "the string value to query a specific invoice" - }, - "payment_hash": { - "type": "hex", - "description": "a payment_hash of the invoice to get the details of a specific invoice" - }, - "offer_id": { - "type": "string", - "description": "a local `offer_id` the invoice was issued for a specific invoice details" - }, - "index": { - "type": "string", - "added": "v23.08", - "enum": [ - "created", - "updated" - ], - "description": "if neither *in_channel* nor *out_channel* is specified, it controls ordering. Defaults to `created`" - }, - "start": { - "type": "u64", - "added": "v23.11", - "description": "if `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)" - }, - "limit": { - "type": "u32", - "added": "v23.11", - "description": "if `index` is specified, `limit` can be used to specify the maximum number of entries to return" - } - } -} diff --git a/doc/schemas/listinvoices.schema.json b/doc/schemas/listinvoices.schema.json deleted file mode 100644 index 34b87d1812df..000000000000 --- a/doc/schemas/listinvoices.schema.json +++ /dev/null @@ -1,175 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "invoices" - ], - "properties": { - "invoices": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "label", - "created_index", - "payment_hash", - "status", - "expires_at" - ], - "properties": { - "label": { - "type": "string", - "description": "unique label supplied at invoice creation" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "unpaid", - "paid", - "expired" - ], - "description": "Whether it's paid, unpaid or unpayable" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when it will become / became unpayable" - }, - "amount_msat": { - "type": "msat", - "description": "the amount required to pay this invoice" - }, - "bolt11": { - "type": "string", - "description": "the BOLT11 string (always present unless *bolt12* is)" - }, - "bolt12": { - "type": "string", - "description": "the BOLT12 string (always present unless *bolt11* is)" - }, - "local_offer_id": { - "type": "hash", - "description": "the *id* of our offer which created this invoice (**experimental-offers** only)." - }, - "invreq_payer_note": { - "type": "string", - "description": "the optional *invreq_payer_note* from invoice_request which created this invoice (**experimental-offers** only)." - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "updated_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was changed (only present if it has changed since creation)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "paid" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "pay_index", - "amount_received_msat", - "paid_at", - "payment_preimage" - ], - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "local_offer_id": {}, - "invreq_payer_note": {}, - "expires_at": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": { - "type": "u64", - "description": "Unique incrementing index for this payment" - }, - "amount_received_msat": { - "type": "msat", - "description": "the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when it was paid" - }, - "paid_outpoint": { - "type": "object", - "description": "Outpoint this invoice was paid with", - "added": "v23.11", - "additionalProperties": false, - "required": [ - "txid", - "outnum" - ], - "properties": { - "txid": { - "added": "v23.11", - "type": "txid", - "description": "ID of the transaction that paid the invoice" - }, - "outnum": { - "added": "v23.11", - "type": "u32", - "description": "The 0-based output number of the transaction that paid the invoice" - } - } - }, - "payment_preimage": { - "type": "secret", - "description": "proof of payment" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "local_offer_id": {}, - "invreq_payer_note": {}, - "created_index": {}, - "updated_index": {}, - "expires_at": {} - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listnodes.request.json b/doc/schemas/listnodes.request.json deleted file mode 100644 index 4ea8c6322d77..000000000000 --- a/doc/schemas/listnodes.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "id": { - "type": "pubkey", - "description": "The public key of the node to list" - } - } -} diff --git a/doc/schemas/listnodes.schema.json b/doc/schemas/listnodes.schema.json deleted file mode 100644 index 38f848fa9c72..000000000000 --- a/doc/schemas/listnodes.schema.json +++ /dev/null @@ -1,199 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "nodes" - ], - "properties": { - "nodes": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "nodeid" - ], - "properties": { - "nodeid": { - "type": "pubkey", - "description": "the public key of the node" - }, - "last_timestamp": { - "type": "u32", - "description": "A node_announcement has been received for this node (UNIX timestamp)" - } - }, - "allOf": [ - { - "if": { - "required": [ - "last_timestamp" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "nodeid", - "last_timestamp", - "alias", - "color", - "features", - "addresses" - ], - "properties": { - "nodeid": {}, - "last_timestamp": {}, - "option_will_fund": {}, - "alias": { - "type": "string", - "description": "The fun alias this node advertized", - "maxLength": 32 - }, - "color": { - "type": "hex", - "description": "The favorite RGB color this node advertized", - "minLength": 6, - "maxLength": 6 - }, - "features": { - "type": "hex", - "description": "BOLT #9 features bitmap this node advertized" - }, - "addresses": { - "type": "array", - "description": "The addresses this node advertized", - "items": { - "type": "object", - "required": [ - "type", - "port" - ], - "additionalProperties": true, - "properties": { - "type": { - "type": "string", - "enum": [ - "dns", - "ipv4", - "ipv6", - "torv2", - "torv3" - ], - "description": "Type of connection (until 23.08, `websocket` was also allowed)" - }, - "port": { - "type": "u16", - "description": "port number" - } - }, - "if": { - "properties": { - "type": { - "type": "string", - "enum": [ - "dns", - "ipv4", - "ipv6", - "torv2", - "torv3" - ] - } - } - }, - "then": { - "required": [ - "type", - "address", - "port" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "port": {}, - "address": { - "type": "string", - "description": "address in expected format for **type**" - } - } - }, - "else": { - "required": [ - "type", - "port" - ], - "additionalProperties": false, - "properties": { - "type": {}, - "port": {} - } - } - } - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "nodeid": {} - } - } - }, - { - "if": { - "required": [ - "option_will_fund" - ] - }, - "then": { - "additionalProperties": true, - "required": [ - "option_will_fund" - ], - "properties": { - "option_will_fund": { - "type": "object", - "additionalProperties": false, - "required": [ - "lease_fee_base_msat", - "lease_fee_basis", - "funding_weight", - "channel_fee_max_base_msat", - "channel_fee_max_proportional_thousandths", - "compact_lease" - ], - "properties": { - "lease_fee_base_msat": { - "type": "msat", - "description": "the fixed fee for a lease (whole number of satoshis)" - }, - "lease_fee_basis": { - "type": "u32", - "description": "the proportional fee in basis points (parts per 10,000) for a lease" - }, - "funding_weight": { - "type": "u32", - "description": "the onchain weight you'll have to pay for a lease" - }, - "channel_fee_max_base_msat": { - "type": "msat", - "description": "the maximum base routing fee this node will charge during the lease" - }, - "channel_fee_max_proportional_thousandths": { - "type": "u32", - "description": "the maximum proportional routing fee this node will charge during the lease (in thousandths, not millionths like channel_update)" - }, - "compact_lease": { - "type": "hex", - "description": "the lease as represented in the node_announcement" - } - } - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listoffers.request.json b/doc/schemas/listoffers.request.json deleted file mode 100644 index 4bc91e64450c..000000000000 --- a/doc/schemas/listoffers.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "offer_id": { - "type": "string", - "description": "offer_id to get details for (if it exists)" - }, - "active_only": { - "type": "boolean", - "description": "if set and is true, only offers with `active` true are returned" - } - } -} \ No newline at end of file diff --git a/doc/schemas/listoffers.schema.json b/doc/schemas/listoffers.schema.json deleted file mode 100644 index 340bb927d00f..000000000000 --- a/doc/schemas/listoffers.schema.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "offers" - ], - "properties": { - "offers": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "offer_id", - "active", - "single_use", - "bolt12", - "used" - ], - "properties": { - "offer_id": { - "type": "hash", - "description": "the id of this offer (merkle hash of non-signature fields)" - }, - "active": { - "type": "boolean", - "description": "whether this can still be used" - }, - "single_use": { - "type": "boolean", - "description": "whether this expires as soon as it's paid" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 encoding of the offer" - }, - "used": { - "type": "boolean", - "description": "True if an associated invoice has been paid" - }, - "label": { - "type": "string", - "description": "the (optional) user-specified label" - } - } - } - } - } -} diff --git a/doc/schemas/listpays.request.json b/doc/schemas/listpays.request.json deleted file mode 100644 index 50cdac247831..000000000000 --- a/doc/schemas/listpays.request.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "bolt11": { - "type": "string", - "description": "bolt11 string to get the payment details" - }, - "payment_hash": { - "type": "hash", - "description": "payment hash to get the payment details" - }, - "status": { - "type": "string", - "description": "to filter the payment by status", - "enum": [ - "pending", - "complete", - "failed" - ] - } - } -} diff --git a/doc/schemas/listpays.schema.json b/doc/schemas/listpays.schema.json deleted file mode 100644 index b4aad0a33626..000000000000 --- a/doc/schemas/listpays.schema.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "pays" - ], - "properties": { - "pays": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "payment_hash", - "status", - "created_at" - ], - "properties": { - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "failed", - "complete" - ], - "description": "status of the payment" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "completed_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was completed" - }, - "label": { - "type": "string", - "description": "the label, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if pay supplied one)" - }, - "description": { - "type": "string", - "description": "the description matching the bolt11 description hash (if pay supplied one)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied for pay: **experimental-offers** only)." - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "complete" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "amount_sent_msat", - "preimage" - ], - "properties": { - "payment_hash": {}, - "status": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "label": {}, - "bolt11": {}, - "description": {}, - "bolt12": {}, - "amount_msat": { - "type": "msat", - "description": "The amount of millisatoshi we intended to send to the destination" - }, - "amount_sent_msat": { - "type": "msat", - "description": "The amount of millisatoshi we sent in order to pay (may include fees and not match amount_msat)" - }, - "preimage": { - "type": "secret", - "description": "proof of payment" - }, - "number_of_parts": { - "type": "u64", - "description": "the number of parts for a successful payment (only if more than one)." - } - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "amount_sent_msat" - ], - "properties": { - "payment_hash": {}, - "status": {}, - "destination": {}, - "created_at": {}, - "label": {}, - "bolt11": {}, - "description": {}, - "bolt12": {}, - "amount_sent_msat": {}, - "erroronion": { - "type": "hex", - "description": "the error onion returned on failure, if any." - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listpeerchannels.request.json b/doc/schemas/listpeerchannels.request.json deleted file mode 100644 index ecd4b81063d9..000000000000 --- a/doc/schemas/listpeerchannels.request.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "added": "v23.02", - "properties": { - "id": { - "type": "pubkey", - "description": "If supplied, limits the channels to just the peer with the given ID, if it exists" - } - } -} diff --git a/doc/schemas/listpeerchannels.schema.json b/doc/schemas/listpeerchannels.schema.json deleted file mode 100644 index fb3a8ad047e1..000000000000 --- a/doc/schemas/listpeerchannels.schema.json +++ /dev/null @@ -1,985 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.02", - "required": [ - "channels" - ], - "properties": { - "channels": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "state", - "opener", - "features", - "peer_connected", - "peer_id" - ], - "properties": { - "peer_id": { - "type": "pubkey", - "description": "Node Public key" - }, - "peer_connected": { - "type": "boolean", - "description": "A boolean flag that is set to true if the peer is online" - }, - "state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "CHANNELD_AWAITING_SPLICE", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY" - ], - "description": "the channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" - }, - "scratch_txid": { - "type": "txid", - "description": "The txid we would use if we went onchain now" - }, - "channel_type": { - "type": "object", - "description": "channel_type as negotiated with peer", - "added": "v23.05", - "additionalProperties": false, - "required": [ - "bits", - "names" - ], - "properties": { - "bits": { - "type": "array", - "description": "Each bit set in this channel_type", - "items": { - "type": "u32", - "description": "Bit number" - } - }, - "names": { - "type": "array", - "description": "Feature name for each bit set in this channel_type", - "items": { - "type": "string", - "enum": [ - "static_remotekey/even", - "anchor_outputs/even", - "anchors_zero_fee_htlc_tx/even", - "scid_alias/even", - "zeroconf/even" - ], - "description": "Name of feature bit" - } - } - } - }, - "ignore_fee_limits": { - "type": "boolean", - "added": "v23.08", - "description": "set if we allow this peer to set fees to anything they want" - }, - "feerate": { - "type": "object", - "description": "Feerates for the current tx", - "additionalProperties": false, - "required": [ - "perkw", - "perkb" - ], - "properties": { - "perkw": { - "type": "u32", - "description": "Feerate per 1000 weight (i.e kSipa)" - }, - "perkb": { - "type": "u32", - "description": "Feerate per 1000 virtual bytes" - } - } - }, - "owner": { - "type": "string", - "description": "The current subdaemon controlling this connection" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "The short_channel_id (once locked in)" - }, - "channel_id": { - "type": "hash", - "description": "The full channel_id (funding txid Xored with output number)" - }, - "funding_txid": { - "type": "txid", - "description": "ID of the funding transaction" - }, - "funding_outnum": { - "type": "u32", - "description": "The 0-based output number of the funding transaction which opens the channel" - }, - "initial_feerate": { - "type": "string", - "description": "For inflight opens, the first feerate used to initiate the channel open" - }, - "last_feerate": { - "type": "string", - "description": "For inflight opens, the most recent feerate used on the channel open" - }, - "next_feerate": { - "type": "string", - "description": "For inflight opens, the next feerate we'll use for the channel open" - }, - "next_fee_step": { - "type": "u32", - "description": "For inflight opens, the next feerate step we'll use for the channel open" - }, - "inflight": { - "type": "array", - "description": "Current candidate funding transactions", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "funding_txid", - "funding_outnum", - "feerate", - "total_funding_msat", - "splice_amount", - "our_funding_msat" - ], - "properties": { - "funding_txid": { - "type": "txid", - "description": "ID of the funding transaction" - }, - "funding_outnum": { - "type": "u32", - "description": "The 0-based output number of the funding transaction which opens the channel" - }, - "feerate": { - "type": "string", - "description": "The feerate for this funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "total_funding_msat": { - "type": "msat", - "description": "total amount in the channel" - }, - "splice_amount": { - "type": "integer", - "added": "v23.08", - "description": "The amouont of sats we're splicing in or out" - }, - "our_funding_msat": { - "type": "msat", - "description": "amount we have in the channel" - }, - "scratch_txid": { - "type": "txid", - "description": "The commitment transaction txid we would use if we went onchain now" - } - } - } - }, - "close_to": { - "type": "hex", - "description": "scriptPubkey which we have to close to if we mutual close" - }, - "private": { - "type": "boolean", - "description": "if True, we will not announce this channel" - }, - "opener": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel" - }, - "closer": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel close (only present if closing)" - }, - "features": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "option_static_remotekey", - "option_anchor_outputs", - "option_anchors_zero_fee_htlc_tx", - "option_scid_alias", - "option_zeroconf" - ], - "description": "BOLT #9 features which apply to this channel" - } - }, - "funding": { - "type": "object", - "additionalProperties": false, - "required": [ - "local_funds_msat", - "remote_funds_msat" - ], - "properties": { - "pushed_msat": { - "type": "msat", - "description": "Amount pushed from opener to peer" - }, - "local_funds_msat": { - "type": "msat", - "description": "Amount of channel we funded" - }, - "remote_funds_msat": { - "type": "msat", - "description": "Amount of channel they funded" - }, - "fee_paid_msat": { - "type": "msat", - "description": "Amount we paid peer at open" - }, - "fee_rcvd_msat": { - "type": "msat", - "description": "Amount we were paid by peer at open" - } - } - }, - "to_us_msat": { - "type": "msat", - "description": "How much of channel is owed to us" - }, - "min_to_us_msat": { - "type": "msat", - "description": "Least amount owed to us ever. If the peer were to succesfully steal from us, this is the amount we would still retain." - }, - "max_to_us_msat": { - "type": "msat", - "description": "Most amount owed to us ever. If we were to successfully steal from the peer, this is the amount we could potentially get." - }, - "total_msat": { - "type": "msat", - "description": "total amount in the channel" - }, - "fee_base_msat": { - "type": "msat", - "description": "amount we charge to use the channel" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "amount we charge to use the channel in parts-per-million" - }, - "dust_limit_msat": { - "type": "msat", - "description": "Minimum amount for an output on the channel transactions" - }, - "max_total_htlc_in_msat": { - "type": "msat", - "description": "Max amount accept in a single payment" - }, - "their_reserve_msat": { - "type": "msat", - "description": "Minimum we insist they keep in channel (default is 1% of the total channel capacity). If they have less than this in the channel, they cannot send to us on that channel" - }, - "our_reserve_msat": { - "type": "msat", - "description": "Minimum they insist we keep in channel. If you have less than this in the channel, you cannot send out via this channel." - }, - "spendable_msat": { - "type": "msat", - "description": "An estimate of the total we could send through channel (can be wrong because adding HTLCs requires an increase in fees paid to onchain miners, and onchain fees change dynamically according to onchain activity)" - }, - "receivable_msat": { - "type": "msat", - "description": "An estimate of the total peer could send through channel" - }, - "minimum_htlc_in_msat": { - "type": "msat", - "description": "The minimum amount HTLC we accept" - }, - "minimum_htlc_out_msat": { - "type": "msat", - "description": "The minimum amount HTLC we will send" - }, - "maximum_htlc_out_msat": { - "type": "msat", - "description": "The maximum amount HTLC we will send" - }, - "their_to_self_delay": { - "type": "u32", - "description": "The number of blocks before they can take their funds if they unilateral close" - }, - "our_to_self_delay": { - "type": "u32", - "description": "The number of blocks before we can take our funds if we unilateral close" - }, - "max_accepted_htlcs": { - "type": "u32", - "description": "Maximum number of incoming HTLC we will accept at once" - }, - "alias": { - "type": "object", - "required": [], - "properties": { - "local": { - "type": "short_channel_id", - "description": "An alias assigned by this node to this channel, used for outgoing payments" - }, - "remote": { - "type": "short_channel_id", - "description": "An alias assigned by the remote node to this channel, usable in routehints and invoices" - } - } - }, - "state_changes": { - "type": "array", - "description": "Prior state changes", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "timestamp", - "old_state", - "new_state", - "cause", - "message" - ], - "properties": { - "timestamp": { - "type": "string", - "description": "UTC timestamp of form YYYY-mm-ddTHH:MM:SS.%03dZ" - }, - "old_state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY", - "CHANNELD_AWAITING_SPLICE" - ], - "description": "Previous state" - }, - "new_state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY", - "CHANNELD_AWAITING_SPLICE" - ], - "description": "New state" - }, - "cause": { - "type": "string", - "enum": [ - "unknown", - "local", - "user", - "remote", - "protocol", - "onchain" - ], - "description": "What caused the change" - }, - "message": { - "type": "string", - "description": "Human-readable explanation" - } - } - } - }, - "status": { - "type": "array", - "items": { - "type": "string", - "description": "Billboard log of significant changes" - } - }, - "in_payments_offered": { - "type": "u64", - "description": "Number of incoming payment attempts" - }, - "in_offered_msat": { - "type": "msat", - "description": "Total amount of incoming payment attempts" - }, - "in_payments_fulfilled": { - "type": "u64", - "description": "Number of successful incoming payment attempts" - }, - "in_fulfilled_msat": { - "type": "msat", - "description": "Total amount of successful incoming payment attempts" - }, - "out_payments_offered": { - "type": "u64", - "description": "Number of outgoing payment attempts" - }, - "out_offered_msat": { - "type": "msat", - "description": "Total amount of outgoing payment attempts" - }, - "out_payments_fulfilled": { - "type": "u64", - "description": "Number of successful outgoing payment attempts" - }, - "out_fulfilled_msat": { - "type": "msat", - "description": "Total amount of successful outgoing payment attempts" - }, - "htlcs": { - "type": "array", - "description": "current HTLCs in this channel", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "direction", - "id", - "amount_msat", - "expiry", - "payment_hash", - "state" - ], - "properties": { - "direction": { - "type": "string", - "enum": [ - "in", - "out" - ], - "description": "Whether it came from peer, or is going to peer" - }, - "id": { - "type": "u64", - "description": "Unique ID for this htlc on this channel in this direction" - }, - "amount_msat": { - "type": "msat", - "description": "Amount send/received for this HTLC" - }, - "expiry": { - "type": "u32", - "description": "Block this HTLC expires at (after which an `in` direction HTLC will be returned to the peer, an `out` returned to us). If this expiry is too close, lightningd(8) will automatically unilaterally close the channel in order to enforce the timeout onchain." - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the payment_preimage which will prove payment" - }, - "local_trimmed": { - "type": "boolean", - "enum": [ - true - ], - "description": "If this is too small to enforce onchain; it doesn't appear in the commitment transaction and will not be enforced in a unilateral close. Generally true if the HTLC (after subtracting onchain fees) is below the `dust_limit_msat` for the channel." - }, - "status": { - "type": "string", - "description": "set if this HTLC is currently waiting on a hook (and shows what plugin)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "direction": { - "enum": [ - "out" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "state" - ], - "properties": { - "direction": {}, - "id": {}, - "amount_msat": {}, - "msatoshi": {}, - "expiry": {}, - "payment_hash": {}, - "local_trimmed": {}, - "status": {}, - "alias": {}, - "peer_id": {}, - "peer_connected": {}, - "state": { - "type": "string", - "enum": [ - "SENT_ADD_HTLC", - "SENT_ADD_COMMIT", - "RCVD_ADD_REVOCATION", - "RCVD_ADD_ACK_COMMIT", - "SENT_ADD_ACK_REVOCATION", - "RCVD_REMOVE_HTLC", - "RCVD_REMOVE_COMMIT", - "SENT_REMOVE_REVOCATION", - "SENT_REMOVE_ACK_COMMIT", - "RCVD_REMOVE_ACK_REVOCATION" - ], - "description": "Status of the HTLC" - } - } - } - }, - { - "if": { - "properties": { - "direction": { - "enum": [ - "in" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "state" - ], - "properties": { - "direction": {}, - "id": {}, - "amount_msat": {}, - "msatoshi": {}, - "expiry": {}, - "payment_hash": {}, - "local_trimmed": {}, - "status": {}, - "peer_id": {}, - "peer_connected": {}, - "state": { - "type": "string", - "enum": [ - "RCVD_ADD_HTLC", - "RCVD_ADD_COMMIT", - "SENT_ADD_REVOCATION", - "SENT_ADD_ACK_COMMIT", - "RCVD_ADD_ACK_REVOCATION", - "SENT_REMOVE_HTLC", - "SENT_REMOVE_COMMIT", - "RCVD_REMOVE_REVOCATION", - "RCVD_REMOVE_ACK_COMMIT", - "SENT_REMOVE_ACK_REVOCATION" - ], - "description": "Status of the HTLC" - } - } - } - } - ] - } - } - }, - "allOf": [ - { - "if": { - "required": [ - "close_to" - ] - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "state": {}, - "peer_id": {}, - "peer_connected": {}, - "scratch_txid": {}, - "channel_type": {}, - "feerate": {}, - "ignore_fee_limits": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "close_to": {}, - "private": {}, - "alias": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "inflight": {}, - "last_tx_fee_msat": {}, - "direction": {}, - "close_to_addr": { - "type": "string", - "description": "The bitcoin address we will close to (present if close_to_addr is a standardized address)" - } - } - } - }, - { - "if": { - "required": [ - "scratch_txid" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "last_tx_fee_msat" - ], - "properties": { - "state": {}, - "peer_id": {}, - "peer_connected": {}, - "alias": {}, - "scratch_txid": {}, - "channel_type": {}, - "feerate": {}, - "ignore_fee_limits": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "inflight": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "close_to_addr": {}, - "direction": {}, - "last_tx_fee_msat": { - "type": "msat", - "description": "fee attached to this the current tx" - } - } - } - }, - { - "if": { - "required": [ - "short_channel_id" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "direction" - ], - "properties": { - "alias": {}, - "peer_id": {}, - "peer_connected": {}, - "state": {}, - "scratch_txid": {}, - "channel_type": {}, - "feerate": {}, - "ignore_fee_limits": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "inflight": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "close_to_addr": {}, - "last_tx_fee_msat": {}, - "direction": { - "type": "u32", - "description": "0 if we're the lesser node_id, 1 if we're the greater (as used in BOLT #7 channel_update)" - } - } - } - }, - { - "if": { - "required": [ - "inflight" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "initial_feerate", - "last_feerate", - "next_feerate" - ], - "properties": { - "state": {}, - "peer_id": {}, - "peer_connected": {}, - "scratch_txid": {}, - "channel_type": {}, - "feerate": {}, - "ignore_fee_limits": {}, - "owner": {}, - "alias": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "inflight": {}, - "close_to_addr": {}, - "direction": {}, - "last_tx_fee_msat": {}, - "initial_feerate": { - "type": "string", - "description": "The feerate for the initial funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "last_feerate": { - "type": "string", - "description": "The feerate for the latest funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "next_feerate": { - "type": "string", - "description": "The minimum feerate for the next funding transaction in per-1000-weight, with \"kpw\" appended" - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listpeers.request.json b/doc/schemas/listpeers.request.json deleted file mode 100644 index 01f5bbe453cb..000000000000 --- a/doc/schemas/listpeers.request.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "id": { - "type": "pubkey", - "description": "if supplied, limits the result to just the peer with the given ID, if it exists" - }, - "level": { - "type": "string", - "description": "supplying level will show log entries related to that peer at the given log level", - "enum": [ - "io", - "debug", - "info", - "unusual" - ] - } - } -} diff --git a/doc/schemas/listpeers.schema.json b/doc/schemas/listpeers.schema.json deleted file mode 100644 index 52bc176d0e9a..000000000000 --- a/doc/schemas/listpeers.schema.json +++ /dev/null @@ -1,1131 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "peers" - ], - "properties": { - "peers": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "id", - "connected", - "num_channels" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "the public key of the peer" - }, - "connected": { - "type": "boolean", - "description": "True if the peer is currently connected" - }, - "num_channels": { - "type": "u32", - "description": "The number of channels the peer has with this node", - "added": "v23.02" - }, - "log": { - "type": "array", - "description": "if *level* is specified, logs for this peer", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "SKIPPED", - "BROKEN", - "UNUSUAL", - "INFO", - "DEBUG", - "IO_IN", - "IO_OUT" - ] - } - }, - "allOf": [ - { - "if": { - "properties": { - "type": { - "enum": [ - "SKIPPED" - ] - } - } - }, - "then": { - "type": "object", - "additionalProperties": false, - "required": [ - "num_skipped" - ], - "properties": { - "type": {}, - "num_skipped": { - "type": "u32", - "description": "number of deleted/omitted entries" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "enum": [ - "BROKEN", - "UNUSUAL", - "INFO", - "DEBUG" - ] - } - } - }, - "then": { - "type": "object", - "additionalProperties": false, - "required": [ - "time", - "source", - "log", - "node_id" - ], - "properties": { - "type": {}, - "time": { - "type": "string", - "description": "UNIX timestamp with 9 decimal places" - }, - "source": { - "type": "string", - "description": "The particular logbook this was found in" - }, - "log": { - "type": "string", - "description": "The actual log message" - }, - "node_id": { - "type": "pubkey", - "description": "The peer this is associated with" - } - } - } - }, - { - "if": { - "properties": { - "type": { - "enum": [ - "IO_IN", - "IO_OUT" - ] - } - } - }, - "then": { - "type": "object", - "additionalProperties": false, - "required": [ - "time", - "source", - "log", - "node_id", - "data" - ], - "properties": { - "type": {}, - "time": { - "type": "string", - "description": "UNIX timestamp with 9 decimal places" - }, - "source": { - "type": "string", - "description": "The particular logbook this was found in" - }, - "log": { - "type": "string", - "description": "The actual log message" - }, - "node_id": { - "type": "pubkey", - "description": "The peer this is associated with" - }, - "data": { - "type": "hex", - "description": "The IO which occurred" - } - } - } - } - ] - } - }, - "channels": { - "deprecated": "v23.02", - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "state", - "opener", - "features" - ], - "properties": { - "state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY" - ], - "description": "the channel state, in particular \"CHANNELD_NORMAL\" means the channel can be used normally" - }, - "scratch_txid": { - "type": "txid", - "description": "The txid we would use if we went onchain now" - }, - "feerate": { - "type": "object", - "description": "Feerates for the current tx", - "additionalProperties": false, - "required": [ - "perkw", - "perkb" - ], - "properties": { - "perkw": { - "type": "u32", - "description": "Feerate per 1000 weight (i.e kSipa)" - }, - "perkb": { - "type": "u32", - "description": "Feerate per 1000 virtual bytes" - } - } - }, - "owner": { - "type": "string", - "description": "The current subdaemon controlling this connection" - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "The short_channel_id (once locked in)" - }, - "channel_id": { - "type": "hash", - "description": "The full channel_id", - "minLength": 64, - "maxLength": 64 - }, - "funding_txid": { - "type": "txid", - "description": "ID of the funding transaction" - }, - "funding_outnum": { - "type": "u32", - "description": "The 0-based output number of the funding transaction which opens the channel" - }, - "initial_feerate": { - "type": "string", - "description": "For inflight opens, the first feerate used to initiate the channel open" - }, - "last_feerate": { - "type": "string", - "description": "For inflight opens, the most recent feerate used on the channel open" - }, - "next_feerate": { - "type": "string", - "description": "For inflight opens, the next feerate we'll use for the channel open" - }, - "next_fee_step": { - "type": "u32", - "description": "For inflight opens, the next feerate step we'll use for the channel open" - }, - "inflight": { - "type": "array", - "description": "Current candidate funding transactions (only for dual-funding)", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "funding_txid", - "funding_outnum", - "feerate", - "total_funding_msat", - "our_funding_msat", - "splice_amount", - "scratch_txid" - ], - "properties": { - "funding_txid": { - "type": "txid", - "description": "ID of the funding transaction" - }, - "funding_outnum": { - "type": "u32", - "description": "The 0-based output number of the funding transaction which opens the channel" - }, - "feerate": { - "type": "string", - "description": "The feerate for this funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "total_funding_msat": { - "type": "msat", - "description": "total amount in the channel" - }, - "our_funding_msat": { - "type": "msat", - "description": "amount we have in the channel" - }, - "splice_amount": { - "type": "integer", - "added": "v23.08", - "description": "The amouont of sats we're splicing in or out" - }, - "scratch_txid": { - "type": "txid", - "description": "The commitment transaction txid we would use if we went onchain now" - } - } - } - }, - "close_to": { - "type": "hex", - "description": "scriptPubkey which we have to close to if we mutual close" - }, - "private": { - "type": "boolean", - "description": "if True, we will not announce this channel" - }, - "opener": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel" - }, - "closer": { - "type": "string", - "enum": [ - "local", - "remote" - ], - "description": "Who initiated the channel close" - }, - "features": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "option_static_remotekey", - "option_anchor_outputs", - "option_scid_alias", - "option_zeroconf" - ], - "description": "BOLT #9 features which apply to this channel" - } - }, - "funding": { - "type": "object", - "additionalProperties": false, - "required": [ - "local_funds_msat", - "remote_funds_msat" - ], - "properties": { - "pushed_msat": { - "type": "msat", - "description": "Amount pushed from opener to peer" - }, - "local_funds_msat": { - "type": "msat", - "description": "Amount of channel we funded" - }, - "remote_funds_msat": { - "type": "msat", - "description": "Amount of channel they funded" - }, - "fee_paid_msat": { - "type": "msat", - "description": "Amount we paid peer at open" - }, - "fee_rcvd_msat": { - "type": "msat", - "description": "Amount we were paid by peer at open" - } - } - }, - "to_us_msat": { - "type": "msat", - "description": "how much of channel is owed to us" - }, - "min_to_us_msat": { - "type": "msat", - "description": "least amount owed to us ever" - }, - "max_to_us_msat": { - "type": "msat", - "description": "most amount owed to us ever" - }, - "total_msat": { - "type": "msat", - "description": "total amount in the channel" - }, - "fee_base_msat": { - "type": "msat", - "description": "amount we charge to use the channel" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "amount we charge to use the channel in parts-per-million" - }, - "dust_limit_msat": { - "type": "msat", - "description": "minimum amount for an output on the channel transactions" - }, - "max_total_htlc_in_msat": { - "type": "msat", - "description": "max amount accept in a single payment" - }, - "their_reserve_msat": { - "type": "msat", - "description": "minimum we insist they keep in channel" - }, - "our_reserve_msat": { - "type": "msat", - "description": "minimum they insist we keep in channel" - }, - "spendable_msat": { - "type": "msat", - "description": "total we could send through channel" - }, - "receivable_msat": { - "type": "msat", - "description": "total peer could send through channel" - }, - "minimum_htlc_in_msat": { - "type": "msat", - "description": "the minimum amount HTLC we accept" - }, - "minimum_htlc_out_msat": { - "type": "msat", - "description": "the minimum amount HTLC we will send" - }, - "maximum_htlc_out_msat": { - "type": "msat", - "description": "the maximum amount HTLC we will send" - }, - "their_to_self_delay": { - "type": "u32", - "description": "the number of blocks before they can take their funds if they unilateral close" - }, - "our_to_self_delay": { - "type": "u32", - "description": "the number of blocks before we can take our funds if we unilateral close" - }, - "max_accepted_htlcs": { - "type": "u32", - "description": "Maximum number of incoming HTLC we will accept at once" - }, - "alias": { - "type": "object", - "required": [], - "properties": { - "local": { - "type": "short_channel_id", - "description": "An alias assigned by this node to this channel, used for outgoing payments" - }, - "remote": { - "type": "short_channel_id", - "description": "An alias assigned by the remote node to this channel, usable in routehints and invoices" - } - } - }, - "state_changes": { - "type": "array", - "description": "Prior state changes", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "timestamp", - "old_state", - "new_state", - "cause", - "message" - ], - "properties": { - "timestamp": { - "type": "string", - "description": "UTC timestamp of form YYYY-mm-ddTHH:MM:SS.%03dZ" - }, - "old_state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY" - ], - "description": "Previous state" - }, - "new_state": { - "type": "string", - "enum": [ - "OPENINGD", - "CHANNELD_AWAITING_LOCKIN", - "CHANNELD_NORMAL", - "CHANNELD_SHUTTING_DOWN", - "CLOSINGD_SIGEXCHANGE", - "CLOSINGD_COMPLETE", - "AWAITING_UNILATERAL", - "FUNDING_SPEND_SEEN", - "ONCHAIN", - "DUALOPEND_OPEN_INIT", - "DUALOPEND_AWAITING_LOCKIN", - "DUALOPEND_OPEN_COMMITTED", - "DUALOPEND_OPEN_COMMIT_READY" - ], - "description": "New state" - }, - "cause": { - "type": "string", - "enum": [ - "unknown", - "local", - "user", - "remote", - "protocol", - "onchain" - ], - "description": "What caused the change" - }, - "message": { - "type": "string", - "description": "Human-readable explanation" - } - } - } - }, - "status": { - "type": "array", - "items": { - "type": "string", - "description": "Billboard log of significant changes" - } - }, - "in_payments_offered": { - "type": "u64", - "description": "Number of incoming payment attempts" - }, - "in_offered_msat": { - "type": "msat", - "description": "Total amount of incoming payment attempts" - }, - "in_payments_fulfilled": { - "type": "u64", - "description": "Number of successful incoming payment attempts" - }, - "in_fulfilled_msat": { - "type": "msat", - "description": "Total amount of successful incoming payment attempts" - }, - "out_payments_offered": { - "type": "u64", - "description": "Number of outgoing payment attempts" - }, - "out_offered_msat": { - "type": "msat", - "description": "Total amount of outgoing payment attempts" - }, - "out_payments_fulfilled": { - "type": "u64", - "description": "Number of successful outgoing payment attempts" - }, - "out_fulfilled_msat": { - "type": "msat", - "description": "Total amount of successful outgoing payment attempts" - }, - "htlcs": { - "type": "array", - "description": "current HTLCs in this channel", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "direction", - "id", - "amount_msat", - "expiry", - "payment_hash", - "state" - ], - "properties": { - "direction": { - "type": "string", - "enum": [ - "in", - "out" - ], - "description": "Whether it came from peer, or is going to peer" - }, - "id": { - "type": "u64", - "description": "Unique ID for this htlc on this channel in this direction" - }, - "amount_msat": { - "type": "msat", - "description": "Amount send/received for this HTLC" - }, - "expiry": { - "type": "u32", - "description": "Block this HTLC expires at" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the payment_preimage which will prove payment", - "maxLength": 64, - "minLength": 64 - }, - "local_trimmed": { - "type": "boolean", - "enum": [ - true - ], - "description": "if this is too small to enforce onchain" - }, - "status": { - "type": "string", - "description": "set if this HTLC is currently waiting on a hook (and shows what plugin)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "direction": { - "enum": [ - "out" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "state" - ], - "properties": { - "direction": {}, - "id": {}, - "amount_msat": {}, - "msatoshi": {}, - "expiry": {}, - "payment_hash": {}, - "local_trimmed": {}, - "status": {}, - "alias": {}, - "state": { - "type": "string", - "enum": [ - "SENT_ADD_HTLC", - "SENT_ADD_COMMIT", - "RCVD_ADD_REVOCATION", - "RCVD_ADD_ACK_COMMIT", - "SENT_ADD_ACK_REVOCATION", - "RCVD_REMOVE_HTLC", - "RCVD_REMOVE_COMMIT", - "SENT_REMOVE_REVOCATION", - "SENT_REMOVE_ACK_COMMIT", - "RCVD_REMOVE_ACK_REVOCATION" - ], - "description": "Status of the HTLC" - } - } - } - }, - { - "if": { - "properties": { - "direction": { - "enum": [ - "in" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "state" - ], - "properties": { - "direction": {}, - "id": {}, - "amount_msat": {}, - "msatoshi": {}, - "expiry": {}, - "payment_hash": {}, - "local_trimmed": {}, - "status": {}, - "state": { - "type": "string", - "enum": [ - "RCVD_ADD_HTLC", - "RCVD_ADD_COMMIT", - "SENT_ADD_REVOCATION", - "SENT_ADD_ACK_COMMIT", - "RCVD_ADD_ACK_REVOCATION", - "SENT_REMOVE_HTLC", - "SENT_REMOVE_COMMIT", - "RCVD_REMOVE_REVOCATION", - "RCVD_REMOVE_ACK_COMMIT", - "SENT_REMOVE_ACK_REVOCATION" - ], - "description": "Status of the HTLC" - } - } - } - } - ] - } - } - }, - "allOf": [ - { - "if": { - "required": [ - "close_to" - ] - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "state": {}, - "scratch_txid": {}, - "feerate": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "close_to": {}, - "private": {}, - "alias": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "inflight": {}, - "last_tx_fee_msat": {}, - "direction": {}, - "close_to_addr": { - "type": "string", - "description": "The bitcoin address we will close to" - } - } - } - }, - { - "if": { - "required": [ - "scratch_txid" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "last_tx_fee_msat" - ], - "properties": { - "state": {}, - "alias": {}, - "scratch_txid": {}, - "feerate": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "inflight": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "close_to_addr": {}, - "direction": {}, - "last_tx_fee_msat": { - "type": "msat", - "description": "fee attached to this the current tx" - } - } - } - }, - { - "if": { - "required": [ - "short_channel_id" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "direction" - ], - "properties": { - "alias": {}, - "state": {}, - "scratch_txid": {}, - "feerate": {}, - "owner": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "inflight": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "initial_feerate": {}, - "last_feerate": {}, - "next_feerate": {}, - "close_to_addr": {}, - "last_tx_fee_msat": {}, - "direction": { - "type": "u32", - "description": "0 if we're the lesser node_id, 1 if we're the greater" - } - } - } - }, - { - "if": { - "required": [ - "inflight" - ] - }, - "then": { - "additionalProperties": false, - "required": [ - "initial_feerate", - "last_feerate", - "next_feerate" - ], - "properties": { - "state": {}, - "scratch_txid": {}, - "feerate": {}, - "owner": {}, - "alias": {}, - "short_channel_id": {}, - "channel_id": {}, - "funding_txid": {}, - "funding_outnum": {}, - "close_to": {}, - "private": {}, - "opener": {}, - "closer": {}, - "features": {}, - "funding": {}, - "to_us_msat": {}, - "min_to_us_msat": {}, - "max_to_us_msat": {}, - "total_msat": {}, - "fee_base_msat": {}, - "fee_proportional_millionths": {}, - "dust_limit_msat": {}, - "max_total_htlc_in_msat": {}, - "their_reserve_msat": {}, - "our_reserve_msat": {}, - "spendable_msat": {}, - "receivable_msat": {}, - "minimum_htlc_in_msat": {}, - "minimum_htlc_out_msat": {}, - "maximum_htlc_out_msat": {}, - "spendable_msatoshi": {}, - "receivable_msatoshi": {}, - "their_to_self_delay": {}, - "our_to_self_delay": {}, - "max_accepted_htlcs": {}, - "msatoshi_to_us": {}, - "msatoshi_to_us_min": {}, - "msatoshi_to_us_max": {}, - "msatoshi_total": {}, - "dust_limit_satoshis": {}, - "max_htlc_value_in_flight_msat": {}, - "our_channel_reserve_satoshis": {}, - "their_channel_reserve_satoshis": {}, - "spendable_satoshis": {}, - "receivable_satoshis": {}, - "htlc_minimum_msat": {}, - "state_changes": {}, - "status": {}, - "in_payments_offered": {}, - "in_offered_msat": {}, - "in_msatoshi_offered": {}, - "in_payments_fulfilled": {}, - "in_fulfilled_msat": {}, - "in_msatoshi_fulfilled": {}, - "out_payments_offered": {}, - "out_offered_msat": {}, - "out_msatoshi_offered": {}, - "out_payments_fulfilled": {}, - "out_fulfilled_msat": {}, - "out_msatoshi_fulfilled": {}, - "htlcs": {}, - "inflight": {}, - "close_to_addr": {}, - "direction": {}, - "last_tx_fee_msat": {}, - "initial_feerate": { - "type": "string", - "description": "The feerate for the initial funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "last_feerate": { - "type": "string", - "description": "The feerate for the latest funding transaction in per-1000-weight, with \"kpw\" appended" - }, - "next_feerate": { - "type": "string", - "description": "The minimum feerate for the next funding transaction in per-1000-weight, with \"kpw\" appended" - } - } - } - } - ] - } - } - }, - "allOf": [ - { - "if": { - "additionalProperties": true, - "properties": { - "connected": { - "enum": [ - true - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "netaddr", - "features" - ], - "properties": { - "id": {}, - "channels": {}, - "connected": {}, - "num_channels": {}, - "htlcs": {}, - "log": {}, - "netaddr": { - "type": "array", - "minItems": 1, - "maxItems": 1, - "description": "A single entry array", - "items": { - "type": "string", - "description": "address, e.g. 1.2.3.4:1234" - } - }, - "remote_addr": { - "type": "string", - "description": "The public IPv4/6 address the peer sees us from, e.g. 1.2.3.4:1234" - }, - "features": { - "type": "hex", - "description": "bitmap of BOLT #9 features from peer's INIT message" - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listsendpays.request.json b/doc/schemas/listsendpays.request.json deleted file mode 100644 index 701f6a76efd9..000000000000 --- a/doc/schemas/listsendpays.request.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "bolt11": { - "type": "string", - "description": "bolt11 invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the payment_preimage" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "complete", - "failed" - ], - "description": "Whether the invoice has been paid, pending, or failed" - }, - "index": { - "type": "string", - "added": "v23.11", - "enum": [ - "created", - "updated" - ], - "description": "if neither bolt11 or payment_hash is specified, `index` controls ordering, by `created` (default) or `updated`" - }, - "start": { - "type": "u64", - "added": "v23.11", - "description": "if `index` is specified, `start` may be specified to start from that value, which is generally returned from lightning-wait(7)" - }, - "limit": { - "type": "u32", - "added": "v23.11", - "description": "if `index` is specified, `limit` can be used to specify the maximum number of entries to return" - } - } -} diff --git a/doc/schemas/listsendpays.schema.json b/doc/schemas/listsendpays.schema.json deleted file mode 100644 index 5162829ce367..000000000000 --- a/doc/schemas/listsendpays.schema.json +++ /dev/null @@ -1,214 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "payments" - ], - "properties": { - "payments": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "id", - "created_index", - "payment_hash", - "status", - "groupid", - "created_at", - "amount_sent_msat" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was created in" - }, - "id": { - "type": "u64", - "description": "old synonym for created_index" - }, - "groupid": { - "type": "u64", - "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "partid": { - "type": "u64", - "description": "Part number (for multiple parts to a single payment)" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was changed (only present if it has changed since creation)" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "failed", - "complete" - ], - "description": "status of the payment" - }, - "amount_msat": { - "type": "msat", - "description": "The amount delivered to destination (if known)" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "amount_sent_msat": { - "type": "msat", - "description": "The amount sent" - }, - "label": { - "type": "string", - "description": "the label, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if pay supplied one)" - }, - "description": { - "type": "string", - "description": "the description matching the bolt11 description hash (if pay supplied one)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied for pay: **experimental-offers** only)." - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "complete" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "payment_preimage" - ], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "partid": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "bolt11": {}, - "description": {}, - "bolt12": {}, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - } - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "failed" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "partid": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "bolt11": {}, - "description": {}, - "bolt12": {}, - "erroronion": { - "type": "hex", - "description": "the onion message returned" - } - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "pending" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "partid": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "bolt11": {}, - "description": {}, - "bolt12": {} - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/listsqlschemas.request.json b/doc/schemas/listsqlschemas.request.json deleted file mode 100644 index a1b83e4d867e..000000000000 --- a/doc/schemas/listsqlschemas.request.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "added": "v23.02", - "properties": { - "table": { - "type": "string" - } - } -} diff --git a/doc/schemas/listsqlschemas.schema.json b/doc/schemas/listsqlschemas.schema.json deleted file mode 100644 index def50479caac..000000000000 --- a/doc/schemas/listsqlschemas.schema.json +++ /dev/null @@ -1,67 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "schemas" - ], - "properties": { - "schemas": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "tablename", - "columns" - ], - "properties": { - "tablename": { - "type": "string", - "description": "the name of the table" - }, - "columns": { - "type": "array", - "description": "the columns, in database order", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "name", - "type" - ], - "properties": { - "name": { - "type": "string", - "description": "the name of the column" - }, - "type": { - "type": "string", - "enum": [ - "INTEGER", - "BLOB", - "TEXT", - "REAL" - ], - "description": "the SQL type of the column" - } - } - } - }, - "indices": { - "type": "array", - "description": "Any index we created to speed lookups", - "items": { - "type": "array", - "description": "The columns for this index", - "items": { - "type": "string", - "description": "The column name" - } - } - } - } - } - } - } -} diff --git a/doc/schemas/listtransactions.request.json b/doc/schemas/listtransactions.request.json deleted file mode 100644 index f99496c5ac84..000000000000 --- a/doc/schemas/listtransactions.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/listtransactions.schema.json b/doc/schemas/listtransactions.schema.json deleted file mode 100644 index 067e139e17ad..000000000000 --- a/doc/schemas/listtransactions.schema.json +++ /dev/null @@ -1,107 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "transactions" - ], - "properties": { - "transactions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "hash", - "rawtx", - "blockheight", - "txindex", - "locktime", - "version", - "inputs", - "outputs" - ], - "properties": { - "hash": { - "type": "txid", - "description": "the transaction id" - }, - "rawtx": { - "type": "hex", - "description": "the raw transaction" - }, - "blockheight": { - "type": "u32", - "description": "the block height of this tx" - }, - "txindex": { - "type": "u32", - "description": "the transaction number within the block" - }, - "locktime": { - "type": "u32", - "description": "The nLocktime for this tx" - }, - "version": { - "type": "u32", - "description": "The nVersion for this tx" - }, - "inputs": { - "type": "array", - "description": "Each input, in order", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "txid", - "index", - "sequence" - ], - "properties": { - "txid": { - "type": "txid", - "description": "the transaction id spent" - }, - "index": { - "type": "u32", - "description": "the output spent" - }, - "sequence": { - "type": "u32", - "description": "the nSequence value" - } - } - } - }, - "outputs": { - "type": "array", - "description": "Each output, in order", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "index", - "amount_msat", - "scriptPubKey" - ], - "properties": { - "index": { - "type": "u32", - "description": "the 0-based output number" - }, - "amount_msat": { - "type": "msat", - "description": "the amount of the output" - }, - "scriptPubKey": { - "type": "hex", - "description": "the scriptPubKey" - } - } - } - } - } - } - } - } -} diff --git a/doc/schemas/makesecret.request.json b/doc/schemas/makesecret.request.json deleted file mode 100644 index 54d6fef91d11..000000000000 --- a/doc/schemas/makesecret.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "hex": { - "type": "hex", - "description": "One of `hex` or `string` must be specified: `hex` can be any hex data" - }, - "string": { - "type": "string", - "description": "One of `hex` or `string` must be specified: `string` is a UTF-8 string interpreted literally" - } - } -} diff --git a/doc/schemas/makesecret.schema.json b/doc/schemas/makesecret.schema.json deleted file mode 100644 index b9b8ff50808c..000000000000 --- a/doc/schemas/makesecret.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "secret" - ], - "properties": { - "secret": { - "type": "secret", - "description": "the pseudorandom key derived from HSM_secret" - } - } -} diff --git a/doc/schemas/multifundchannel.request.json b/doc/schemas/multifundchannel.request.json deleted file mode 100644 index 96f082479d5b..000000000000 --- a/doc/schemas/multifundchannel.request.json +++ /dev/null @@ -1,83 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["destinations"], - "properties": { - "destinations": { - "type": "array", - "description": "there must be at least one entry in *destinations*; it cannot be an empty array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "amount" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "node ID, with an optional *@host:port* appended to it in a manner understood by **connect**; see lightning-connect(7). Each entry in the *destinations* array must have a unique node *id*. If not already connected, **multifundchannel** will automatically attempt to connect to the node" - }, - "amount": { - "type": "msat", - "description": "amount in satoshis taken from the internal wallet to fund the channel (but if we have any anchor channels, this will always leave at least `min-emergency-msat` as change). The string *all* can be used to specify all available funds (or 16,777,215 satoshi if more is available and large channels were not negotiated with the peer). Otherwise it is in satoshi precision; it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*. The value cannot be less than the dust limit, currently 546 satoshi as of this writing, nor more than 16,777,215 satoshi (unless large channels were negotiated with the peer)" - - }, - "announce": { - "type": "boolean", - "description": "flag that indicates whether to announce the channel with this, default `true`. If set to `false`, the channel is unpublished" - }, - "push_msat": { - "type": "msat", - "description": "amount of millisatoshis to outright give to the node. This is a gift to the peer, and you do not get a proof-of-payment out of this" - }, - "close_to": { - "type": "string", - "description": "bitcoin address to which the channel funds should be sent to on close. Only valid if both peers have negotiated `option_upfront_shutdown_script` Returns `close_to` set to closing script iff is negotiated" - }, - "request_amt": { - "type": "msat", - "description": "amount of liquidity you'd like to lease from peer. If peer supports `option_will_fund`, indicates to them to include this much liquidity into the channel. Must also pass in *compact_lease*" - }, - "compact_lease": { - "type": "string", - "description": "compact represenation of the peer's expected channel lease terms. If the peer's terms don't match this set, we will fail to open the channel to this destination" - }, - "mindepth": { - "type": "u32", - "description": "number of confirmations before we consider the channel active" - }, - "reserve": { - "type": "msat", - "description": "amount we want the peer to maintain on its side of the channel. Default is 1% of the funding amount. It can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - } - } - } - }, - "feerate": { - "type": "feerate", - "description": "feerate used for the opening transaction, and if *commitment_feerate* is not set, as initial feerate for commitment and HTLC transactions. See NOTES in lightning-feerates(7) for possible values. The default is *normal*" - }, - "minconf": { - "type": "integer", - "description": "minimum number of confirmations that used outputs should have. Default is 1", - "default": 1 - }, - "utxos": { - "type": "array", - "items": { - "type": "outpoint", - "description": "utxos to be used to fund the channel, as an array of `txid:vout`" - } - }, - "minchannels": { - "type": "integer", - "description": "re-attempt funding as long as at least this many peers remain (must not be zero). The **multifundchannel** command will only fail if too many peers fail the funding process" - }, - "commitment_feerate": { - "type": "feerate", - "description": "initial feerate for commitment and HTLC transactions. See *feerate* for valid values" - } - } -} \ No newline at end of file diff --git a/doc/schemas/multifundchannel.schema.json b/doc/schemas/multifundchannel.schema.json deleted file mode 100644 index 18754c491033..000000000000 --- a/doc/schemas/multifundchannel.schema.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "tx", - "txid", - "channel_ids" - ], - "properties": { - "tx": { - "type": "hex", - "description": "The raw transaction which funded the channel" - }, - "txid": { - "type": "txid", - "description": "The txid of the transaction which funded the channel" - }, - "channel_ids": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "channel_id", - "outnum" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "The peer we opened the channel with" - }, - "outnum": { - "type": "u32", - "description": "The 0-based output index showing which output funded the channel" - }, - "channel_id": { - "type": "hex", - "description": "The channel_id of the resulting channel", - "minLength": 64, - "maxLength": 64 - }, - "close_to": { - "type": "hex", - "description": "The raw scriptPubkey which mutual close will go to; only present if *close_to* parameter was specified and peer supports `option_upfront_shutdown_script`" - } - } - } - }, - "failed": { - "type": "array", - "description": "any peers we failed to open with (if *minchannels* was specified less than the number of destinations)", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "id", - "method", - "error" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "The peer we failed to open the channel with" - }, - "method": { - "type": "string", - "enum": [ - "connect", - "openchannel_init", - "fundchannel_start", - "fundchannel_complete" - ], - "description": "What stage we failed at" - }, - "error": { - "type": "object", - "additionalProperties": false, - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "integer", - "description": "JSON error code from failing stage" - }, - "message": { - "type": "string", - "description": "Message from stage" - }, - "data": { - "untyped": true, - "description": "Additional error data" - } - } - } - } - } - } - } -} diff --git a/doc/schemas/multiwithdraw.request.json b/doc/schemas/multiwithdraw.request.json deleted file mode 100644 index 7e9339cb666a..000000000000 --- a/doc/schemas/multiwithdraw.request.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["outputs"], - "properties": { - "outputs": { - "type": "outputs", - "description": "an array containing objects of the form `{address: amount}`. The `amount` may be the string *all*, indicating that all onchain funds be sent to the specified address. Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - }, - "feerate": { - "type": "feerate", - "description": "feerate used for the withdrawals. See NOTES in lightning-feerates(7) for possible values. The default is *normal*" - }, - "minconf": { - "type": "integer", - "description": "minimum number of confirmations that used outputs should have. Default is 1", - "default": 1 - }, - "utxos": { - "type": "array", - "items": { - "type": "outpoint", - "description": "utxos to be used to be withdrawn from, as an array of `txid:vout`. These must be drawn from the node's available UTXO set" - } - } - } -} \ No newline at end of file diff --git a/doc/schemas/multiwithdraw.schema.json b/doc/schemas/multiwithdraw.schema.json deleted file mode 100644 index d3c831d17544..000000000000 --- a/doc/schemas/multiwithdraw.schema.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "tx", - "txid" - ], - "properties": { - "tx": { - "type": "hex", - "description": "The raw transaction which was sent" - }, - "txid": { - "type": "txid", - "description": "The txid of the **tx**" - } - } -} diff --git a/doc/schemas/newaddr.request.json b/doc/schemas/newaddr.request.json deleted file mode 100644 index b5089932f144..000000000000 --- a/doc/schemas/newaddr.request.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "addresstype": { - "type": "string", - "description": "it specifies the type of address wanted; currently *bech32* (e.g. `tb1qu9j4lg5f9rgjyfhvfd905vw46eg39czmktxqgg` on bitcoin testnet or `bc1qwqdg6squsna38e46795at95yu9atm8azzmyvckulcc7kytlcckxswvvzej` on bitcoin mainnet), or *p2tr* taproot addresses. The special value *all* generates all known address types for the same underlying key. Defaults to *bech32* address", - "enum": [ - "bech32", - "p2tr", - "all" - ] - } - } -} diff --git a/doc/schemas/newaddr.schema.json b/doc/schemas/newaddr.schema.json deleted file mode 100644 index 3cdca29f5cc5..000000000000 --- a/doc/schemas/newaddr.schema.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "p2tr": { - "added": "v23.08", - "type": "string", - "description": "The taproot address" - }, - "bech32": { - "type": "string", - "description": "The bech32 (native segwit) address" - }, - "p2sh-segwit": { - "deprecated": "v23.02", - "type": "string", - "description": "The p2sh-wrapped address" - } - } -} diff --git a/doc/schemas/notifications.request.json b/doc/schemas/notifications.request.json deleted file mode 100644 index 818e06179501..000000000000 --- a/doc/schemas/notifications.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["enable"], - "properties": { - "enable": { - "type": "boolean", - "description": "whether to enable or disable notifications" - } - } -} \ No newline at end of file diff --git a/doc/schemas/notifications.schema.json b/doc/schemas/notifications.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/notifications.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/offer.request.json b/doc/schemas/offer.request.json deleted file mode 100644 index b26435dbe7b8..000000000000 --- a/doc/schemas/offer.request.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["amount", "description"], - "properties": { - "amount": { - "type": "msat or any or string", - "description": "can be the string `any`, which creates an offer that can be paid with any amount (e.g. a donation). Otherwise it can be a positive value in millisatoshi precision; it can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*. It can also have an ISO 4217 postfix (i.e. USD), in which case currency conversion will need to be done for the invoice itself. A plugin is needed which provides the `currencyconvert` API for this currency, otherwise the offer creation will fail" - }, - "description": { - "type": "string", - "description": "a short description of purpose of the offer, e.g. *coffee*. This value is encoded into the resulting offer and is viewable by anyone you expose this offer to. It must be UTF-8, and cannot use *\\u* JSON escape codes" - }, - "issuer": { - "type": "string", - "description": "who is issuing this offer (i.e. you) if appropriate" - }, - "label": { - "type": "string", - "description": "an internal-use name for the offer, which can be any UTF-8 string. This is *NOT* encoded in the offer not sent to the issuer" - }, - "quantity_max": { - "type": "integer", - "description": "invoice can specify more than one of the items up (and including) this maximum: 0 is a special value meaning `no maximuim`. The *amount* for the invoice will need to be multiplied accordingly. This is encoded in the offer" - }, - "absolute_expiry": { - "type": "integer", - "description": "time the offer is valid until,in seconds since the first day of 1970 UTC. If not set, the offer remains valid (though it can be deactivated by the issuer of course). This is encoded in the offer" - }, - "recurrence": { - "type": "string", - "description": "an invoice is expected at regular intervals. The argument is a positive number followed by one of `seconds`, `minutes`, `hours`, `days`, `weeks`, `months` or `years` (variants without the trailing `s` are also permitted). This is encoded in the offer. The semantics of recurrence is fairly predictable, but fully documented in BOLT 12. e.g. `4weeks`" - }, - "recurrence_base": { - "type": "string", - "description": "time in seconds since the first day of 1970 UTC, optionally with a `@` prefix. This indicates when the first period begins; without this, the recurrence periods start from the first invoice. The `@` prefix means that the invoice must start by paying the first period; otherwise it is permitted to start at any period. This is encoded in the offer. e.g. `@1609459200` indicates you must start paying on the 1st January 2021" - }, - "recurrence_paywindow": { - "type": "string", - "description": "argument of form `-time+time[%]`. The first time is the number of seconds before the start of a period in which an invoice and payment is valid, the second time is the number of seconds after the start of the period. For example *-604800+86400* means you can fetch an pay the invoice 4 weeks before the given period starts, and up to 1 day afterwards. The optional *%* indicates that the amount of the invoice will be scaled by the time remaining in the period. If this is not specified, the default is that payment is allowed during the current and previous periods. This is encoded in the offer" - }, - "recurrence_limit": { - "type": "integer", - "description": "to indicate the maximum period which exists. eg. `12` means there are 13 periods, from 0 to 12 inclusive. This is encoded in the offer" - }, - "single_use": { - "type": "boolean", - "description": "indicates that the offer is only valid once; we may issue multiple invoices, but as soon as one is paid all other invoices will be expired (i.e. only one person can pay this offer). Defaults to false" - } - } -} \ No newline at end of file diff --git a/doc/schemas/offer.schema.json b/doc/schemas/offer.schema.json deleted file mode 100644 index 671de38dc900..000000000000 --- a/doc/schemas/offer.schema.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "offer_id", - "active", - "single_use", - "bolt12", - "used", - "created" - ], - "properties": { - "offer_id": { - "type": "hash", - "description": "the id of this offer (merkle hash of non-signature fields)" - }, - "active": { - "type": "boolean", - "enum": [ - true - ], - "description": "whether this can still be used" - }, - "single_use": { - "type": "boolean", - "description": "whether this expires as soon as it's paid (reflects the *single_use* parameter)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 encoding of the offer" - }, - "used": { - "type": "boolean", - "description": "True if an associated invoice has been paid" - }, - "created": { - "type": "boolean", - "description": "false if the offer already existed" - }, - "label": { - "type": "string", - "description": "the (optional) user-specified label" - } - } -} diff --git a/doc/schemas/openchannel_abort.request.json b/doc/schemas/openchannel_abort.request.json deleted file mode 100644 index b65a999d76e6..000000000000 --- a/doc/schemas/openchannel_abort.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["channel_id"], - "properties": { - "channel_id": { - "type": "string", - "description": "channel id of the channel to be aborted" - } - } -} \ No newline at end of file diff --git a/doc/schemas/openchannel_abort.schema.json b/doc/schemas/openchannel_abort.schema.json deleted file mode 100644 index 645f8fdb490f..000000000000 --- a/doc/schemas/openchannel_abort.schema.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "channel_canceled", - "reason" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "the channel id of the aborted channel", - "maxLength": 64, - "minLength": 64 - }, - "channel_canceled": { - "type": "boolean", - "description": "whether this is completely canceled (there may be remaining in-flight transactions)" - }, - "reason": { - "type": "string", - "description": "usually \"Abort requested\", but if it happened to fail at the same time it could be different" - } - } -} diff --git a/doc/schemas/openchannel_bump.request.json b/doc/schemas/openchannel_bump.request.json deleted file mode 100644 index 3d6d7d13d946..000000000000 --- a/doc/schemas/openchannel_bump.request.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["channel_id", "amount", "initialpsbt"], - "properties": { - "channel_id": { - "type": "string", - "description": "id of the channel to RBF" - }, - "amount": { - "type": "u64", - "description": "satoshi value that we will contribute to the channel. This value will be _added_ to the provided PSBT in the output which is encumbered by the 2-of-2 script for this channel" - }, - "initialpsbt": { - "type": "string", - "description": "the funded, incomplete PSBT that specifies the UTXOs and change output for our channel contribution. It can be updated, see `openchannel_update`; *initialpsbt* must have at least one input. Must have the Non-Witness UTXO (PSBT_IN_NON_WITNESS_UTXO) set for every input. An error (code 309) will be returned if this requirement is not met" - }, - "funding_feerate": { - "type": "u64", - "description": "feerate for the funding transaction. Defaults to 1/64th greater than the last feerate used for this channel" - } - } -} \ No newline at end of file diff --git a/doc/schemas/openchannel_bump.schema.json b/doc/schemas/openchannel_bump.schema.json deleted file mode 100644 index 8d444c2db6af..000000000000 --- a/doc/schemas/openchannel_bump.schema.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "psbt", - "commitments_secured", - "funding_serial" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "the channel id of the channel", - "maxLength": 64, - "minLength": 64 - }, - "psbt": { - "type": "string", - "description": "the (incomplete) PSBT of the RBF transaction" - }, - "commitments_secured": { - "type": "boolean", - "enum": [ - false - ], - "description": "whether the *psbt* is complete" - }, - "funding_serial": { - "type": "u64", - "description": "the serial_id of the funding output in the *psbt*" - }, - "requires_confirmed_inputs": { - "type": "boolean", - "description": "Does peer require confirmed inputs in psbt?" - } - } -} diff --git a/doc/schemas/openchannel_init.request.json b/doc/schemas/openchannel_init.request.json deleted file mode 100644 index 031730723966..000000000000 --- a/doc/schemas/openchannel_init.request.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["id", "amount", "initialpsbt"], - "properties": { - "id": { - "type": "pubkey", - "description": "node id of the remote peer" - }, - "amount": { - "type": "u64", - "description": "satoshi value that we will contribute to the channel. This value will be _added_ to the provided PSBT in the output which is encumbered by the 2-of-2 script for this channel" - }, - "initialpsbt": { - "type": "string", - "description": "funded, incomplete PSBT that specifies the UTXOs and change output for our channel contribution. It can be updated, see `openchannel_update`; *initialpsbt* must have at least one input. Must have the Non-Witness UTXO (PSBT_IN_NON_WITNESS_UTXO) set for every input. An error (code 309) will be returned if this requirement is not met" - }, - "commitment_feerate": { - "type": "u64", - "description": "feerate for commitment transactions for non-anchor channels: see **fundchannel**. For anchor channels, it is ignored" - }, - "funding_feerate": { - "type": "u64", - "description": "feerate for the funding transaction. Defaults to 'opening' feerate" - }, - "announce": { - "type": "boolean", - "description": "whether or not to announce this channel" - }, - "close_to": { - "type": "string", - "description": "bitcoin address to which the channel funds should be sent on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`" - }, - "request_amt": { - "type": "msat", - "description": "an amount of liquidity you'd like to lease from the peer. If peer supports `option_will_fund`, indicates to them to include this much liquidity into the channel. Must also pass in *compact_lease*" - }, - "compact_lease": { - "type": "string", - "description": "a compact represenation of the peer's expected channel lease terms. If the peer's terms don't match this set, we will fail to open the channel" - } - } -} \ No newline at end of file diff --git a/doc/schemas/openchannel_init.schema.json b/doc/schemas/openchannel_init.schema.json deleted file mode 100644 index b30965ea03b8..000000000000 --- a/doc/schemas/openchannel_init.schema.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "psbt", - "commitments_secured", - "funding_serial" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "the channel id of the channel", - "maxLength": 64, - "minLength": 64 - }, - "psbt": { - "type": "string", - "description": "the (incomplete) PSBT of the funding transaction" - }, - "commitments_secured": { - "type": "boolean", - "enum": [ - false - ], - "description": "whether the *psbt* is complete" - }, - "funding_serial": { - "type": "u64", - "description": "the serial_id of the funding output in the *psbt*" - }, - "requires_confirmed_inputs": { - "type": "boolean", - "description": "Does peer require confirmed inputs in psbt?" - } - } -} diff --git a/doc/schemas/openchannel_signed.request.json b/doc/schemas/openchannel_signed.request.json deleted file mode 100644 index a58e3d85257e..000000000000 --- a/doc/schemas/openchannel_signed.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["channel_id", "signed_psbt"], - "properties": { - "channel_id": { - "type": "string", - "description": "id of the channel" - }, - "signed_psbt": { - "type": "string", - "description": "the PSBT returned from `openchannel_update` (where *commitments_secured* was true) with partial signatures or finalized witness stacks included for every input that we contributed to the PSBT" - } - } -} \ No newline at end of file diff --git a/doc/schemas/openchannel_signed.schema.json b/doc/schemas/openchannel_signed.schema.json deleted file mode 100644 index 23b9a11d7e3f..000000000000 --- a/doc/schemas/openchannel_signed.schema.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "tx", - "txid" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "the channel id of the channel", - "maxLength": 64, - "minLength": 64 - }, - "tx": { - "type": "hex", - "description": "the funding transaction" - }, - "txid": { - "type": "txid", - "description": "The txid of the **tx**" - } - } -} diff --git a/doc/schemas/openchannel_update.request.json b/doc/schemas/openchannel_update.request.json deleted file mode 100644 index e07bf576d333..000000000000 --- a/doc/schemas/openchannel_update.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["channel_id", "psbt"], - "properties": { - "channel_id": { - "type": "string", - "description": "id of the channel" - }, - "psbt": { - "type": "string", - "description": "updated PSBT to be sent to the peer. May be identical to the PSBT last returned by either `openchannel_init` or `openchannel_update`" - } - } -} \ No newline at end of file diff --git a/doc/schemas/openchannel_update.schema.json b/doc/schemas/openchannel_update.schema.json deleted file mode 100644 index 91eff0d7bdf3..000000000000 --- a/doc/schemas/openchannel_update.schema.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "psbt", - "commitments_secured", - "funding_outnum" - ], - "properties": { - "channel_id": { - "type": "hex", - "description": "the channel id of the channel", - "maxLength": 64, - "minLength": 64 - }, - "psbt": { - "type": "string", - "description": "the PSBT of the funding transaction" - }, - "commitments_secured": { - "type": "boolean", - "description": "whether the *psbt* is complete (if true, sign *psbt* and call `openchannel_signed` to complete the channel open)" - }, - "funding_outnum": { - "type": "u32", - "description": "The index of the funding output in the psbt" - }, - "close_to": { - "type": "hex", - "description": "scriptPubkey which we have to close to if we mutual close" - }, - "requires_confirmed_inputs": { - "type": "boolean", - "description": "Does peer require confirmed inputs in psbt?" - } - } -} diff --git a/doc/schemas/parsefeerate.request.json b/doc/schemas/parsefeerate.request.json deleted file mode 100644 index da399ba5ee4e..000000000000 --- a/doc/schemas/parsefeerate.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["feerate_str"], - "properties": { - "feerate_str": { - "type": "string", - "description": "The feerate string to parse" - } - } -} \ No newline at end of file diff --git a/doc/schemas/parsefeerate.schema.json b/doc/schemas/parsefeerate.schema.json deleted file mode 100644 index e431936b1eb5..000000000000 --- a/doc/schemas/parsefeerate.schema.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "perkw": { - "type": "u32", - "description": "Value of *feerate_str* in kilosipa", - "additionalProperties": false - } - } -} diff --git a/doc/schemas/pay.request.json b/doc/schemas/pay.request.json deleted file mode 100644 index 8942a3863e9e..000000000000 --- a/doc/schemas/pay.request.json +++ /dev/null @@ -1,68 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "bolt11" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "bolt11 invoice, if **experimental-offers** is enabled, it can actually be a bolt12 invoice, such as one received from lightningd-fetchinvoice(7). If it does not contain an amount, *amount_msat* is required, otherwise if it is specified it must be *null*" - }, - "amount_msat": { - "type": "msat", - "description": "*amount_msat* is in millisatoshi precision; it can be a whole number, or a whole number with suffix *msat* or *sat*, or a three decimal point number with suffix *sat*, or an 1 to 11 decimal point number suffixed by *btc*" - }, - "label": { - "type": "string", - "description": "it is used to attach a label to payments, and is returned in lightning-listpays(7) and lightning-listsendpays(7)" - }, - "riskfactor": { - "type": "number", - "description": "the *riskfactor* is described in detail in lightning-getroute(7), and defaults to 10" - }, - "maxfeepercent": { - "type": "number", - "description": "percentage of the amount that is to be paid. Defaults to 0.5" - }, - "retry_for": { - "type": "u16", - "description": "until *retry_for* seconds passes, the command will keep finding routes and retrying the payment. Defaults to 60 seconds" - }, - "maxdelay": { - "type": "u16", - "description": "a payment may be delayed for up to `maxdelay` blocks by another node; clients should be prepared for this worst case" - }, - "exemptfee": { - "type": "msat", - "description": "this option can be used for tiny payments which would be dominated by the fee leveraged by forwarding nodes. Setting `exemptfee` allows the `maxfeepercent` check to be skipped on fees that are smaller than `exemptfee`. Defaults to 5000 millisatoshi" - }, - "localinvreqid": { - "type": "hex", - "description": "`localinvreqid` is used by offers to link a payment attempt to a local `invoice_request` offer created by lightningd-invoicerequest(7). This ensures that we only make a single payment for an offer, and that the offer is marked `used` once paid" - }, - "exclude": { - "type": "array", - "description": "*exclude* is a JSON array of short-channel-id/direction (e.g. [ '564334x877x1/0', '564195x1292x0/1' ]) or pubkey which should be excluded from consideration for routing. The default is not to exclude any channels or nodes", - "items": { - "oneOf": [ - { - "type": "short-channel-id/direction" - }, - { - "type": "pubkey" - } - ] - } - }, - "maxfee": { - "type": "msat", - "description": "*maxfee* overrides both *maxfeepercent* and *exemptfee* defaults (and if you specify *maxfee* you cannot specify either of those), and creates an absolute limit on what fee we will pay. This allows you to implement your own heuristics rather than the primitive ones used here" - }, - "description": { - "type": "string", - "description": "it is only required for bolt11 invoices which do not contain a description themselves, but contain a description hash: in this case *description* is required. *description* is then checked against the hash inside the invoice before it will be paid" - } - } -} diff --git a/doc/schemas/pay.schema.json b/doc/schemas/pay.schema.json deleted file mode 100644 index 697622643032..000000000000 --- a/doc/schemas/pay.schema.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "payment_preimage", - "payment_hash", - "created_at", - "parts", - "amount_msat", - "amount_sent_msat", - "status" - ], - "properties": { - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "created_at": { - "type": "number", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "parts": { - "type": "u32", - "description": "how many attempts this took" - }, - "amount_msat": { - "type": "msat", - "description": "Amount the recipient received" - }, - "amount_sent_msat": { - "type": "msat", - "description": "Total amount we sent (including fees)" - }, - "warning_partial_completion": { - "type": "string", - "description": "Not all parts of a multi-part payment have completed" - }, - "status": { - "type": "string", - "enum": [ - "complete", - "pending", - "failed" - ], - "description": "status of payment" - } - } -} diff --git a/doc/schemas/ping.request.json b/doc/schemas/ping.request.json deleted file mode 100644 index c5b2dae32470..000000000000 --- a/doc/schemas/ping.request.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "id" - ], - "additionalProperties": false, - "properties": { - "id": { - "type": "pubkey", - "description": "The pubkey of the node to ping" - }, - "len": { - "type": "u16", - "description": "the length of the ping. Defaults to 128" - }, - "pongbytes": { - "type": "u16", - "description": "the length of the reply. A value of 65532 to 65535 means `don't reply`. Defaults to 128" - } - } -} diff --git a/doc/schemas/ping.schema.json b/doc/schemas/ping.schema.json deleted file mode 100644 index 4ea5056a940b..000000000000 --- a/doc/schemas/ping.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "totlen" - ], - "properties": { - "totlen": { - "type": "u16", - "description": "the answer length of the reply message (including header: 0 means no reply expected)" - } - } -} diff --git a/doc/schemas/plugin.request.json b/doc/schemas/plugin.request.json deleted file mode 100644 index 472e6bba678d..000000000000 --- a/doc/schemas/plugin.request.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["subcommand"], - "properties": { - "subcommand": { - "type": "string", - "enum": [ - "start", - "stop", - "rescan", - "startdir", - "list" - ], - "description": "determines what action is taken" - }, - "plugin": { - "type": "string", - "description": "*path* or *name* of a plugin executable to start or stop" - }, - "directory": { - "type": "string", - "description": "*path* of a directory containing plugins" - }, - "options": { - "type": "array", - "items": { - "type": "string", - "description": "*keyword=value* options passed to plugin, can be repeated" - } - } - } -} \ No newline at end of file diff --git a/doc/schemas/plugin.schema.json b/doc/schemas/plugin.schema.json deleted file mode 100644 index 345d285e6fa3..000000000000 --- a/doc/schemas/plugin.schema.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "command" - ], - "properties": { - "command": { - "type": "string", - "enum": [ - "start", - "stop", - "rescan", - "startdir", - "list" - ], - "description": "the subcommand this is responding to" - } - }, - "allOf": [ - { - "if": { - "properties": { - "command": { - "type": "string", - "enum": [ - "start", - "startdir", - "rescan", - "list" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "command", - "plugins" - ], - "properties": { - "command": {}, - "plugins": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "name", - "active", - "dynamic" - ], - "properties": { - "name": { - "type": "string", - "description": "full pathname of the plugin" - }, - "active": { - "type": "boolean", - "description": "status; plugin completed init and is operational, plugins are configured asynchronously." - }, - "dynamic": { - "type": "boolean", - "description": "plugin can be stopped or started without restarting lightningd" - } - } - } - } - } - } - }, - { - "if": { - "properties": { - "command": { - "type": "string", - "enum": [ - "stop" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "command", - "result" - ], - "properties": { - "command": {}, - "result": { - "type": "string", - "description": "A message saying it successfully stopped" - } - } - } - } - ] -} diff --git a/doc/schemas/preapproveinvoice.request.json b/doc/schemas/preapproveinvoice.request.json deleted file mode 100644 index 19625fc29eff..000000000000 --- a/doc/schemas/preapproveinvoice.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.02", - "required": [ - "bolt11" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "bolt11 invoice to submit to the HSM to check", - "added": "v23.02" - } - } -} diff --git a/doc/schemas/preapproveinvoice.schema.json b/doc/schemas/preapproveinvoice.schema.json deleted file mode 100644 index c66ab0f77c31..000000000000 --- a/doc/schemas/preapproveinvoice.schema.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.02", - "properties": {} -} diff --git a/doc/schemas/preapprovekeysend.request.json b/doc/schemas/preapprovekeysend.request.json deleted file mode 100644 index ee2fc3a1d034..000000000000 --- a/doc/schemas/preapprovekeysend.request.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.02", - "required": [ - "destination", - "payment_hash", - "amount_msat" - ], - "properties": { - "destination": { - "type": "pubkey", - "description": "it is a 33 byte, hex-encoded, node ID of the node that the payment should go to", - "added": "v23.02" - }, - "payment_hash": { - "type": "hex", - "added": "v23.02", - "description": "it is the unique identifier of a payment", - "maxLength": 64, - "minLength": 64 - }, - "amount_msat": { - "type": "msat", - "description": "the amount to send in millisatoshi precision; it can be a whole number, or a whole number with suffix `msat` or `sat`, or a three decimal point number with suffix `sat`, or an 1 to 11 decimal point number suffixed by `btc`", - "added": "v23.02" - } - } -} diff --git a/doc/schemas/preapprovekeysend.schema.json b/doc/schemas/preapprovekeysend.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/preapprovekeysend.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/recover.request.json b/doc/schemas/recover.request.json deleted file mode 100644 index 2e983f6f3b93..000000000000 --- a/doc/schemas/recover.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "hsmsecret" - ], - "properties": { - "hsmsecret": { - "type": "string", - "description": "either a codex32 secret starting with `cl1` as returned by `hsmtool getcodexsecret`, or a raw 64 character hex string" - } - } -} diff --git a/doc/schemas/recover.schema.json b/doc/schemas/recover.schema.json deleted file mode 100644 index 1aad2dcae935..000000000000 --- a/doc/schemas/recover.schema.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/recoverchannel.request.json b/doc/schemas/recoverchannel.request.json deleted file mode 100644 index 073828a5fc44..000000000000 --- a/doc/schemas/recoverchannel.request.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "scb" - ], - "properties": { - "scb": { - "type": "array", - "description": "SCB of the channels in an array", - "items": { - "type": "hexstr" - } - } - } -} diff --git a/doc/schemas/recoverchannel.schema.json b/doc/schemas/recoverchannel.schema.json deleted file mode 100644 index 127dfbc6bf43..000000000000 --- a/doc/schemas/recoverchannel.schema.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "stubs" - ], - "properties": { - "stubs": { - "type": "array", - "items": { - "type": "string", - "description": "Channel IDs of channels successfully inserted." - } - } - } -} diff --git a/doc/schemas/renepay.request.json b/doc/schemas/renepay.request.json deleted file mode 100644 index 241abd8f7186..000000000000 --- a/doc/schemas/renepay.request.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["invstring"], - "properties": { - "invstring": { - "type": "string", - "description": "bolt11 invoice which the RPC command attempts to pay. Currently, **renepay** supports bolt11 invoices only" - }, - "amount_msat": { - "type": "msat", - "description": "if the *invstring* does not contain an amount, *amount_msat* is required, otherwise if it is specified it must be *null*. in millisatoshi precision; it can be a whole number, or a whole number with suffix *msat* or *sat*, or a three decimal point number with suffix *sat*, or an 1 to 11 decimal point number suffixed by *btc*" - }, - "maxfee": { - "type": "msat", - "description": "*maxfee* is a hard bound, in the sense that the command will never attempt a payment when the fees exceed that value" - }, - "maxdelay": { - "type": "number", - "description": "overrides the value of `max-locktime-blocks` for this payment. It serves to limit the locktime of funds in the payment HTLC measured in blocks" - }, - "retry_for": { - "type": "number", - "description": "measured in seconds specifies how much time it is allowed for the command to keep retrying the payment. Defaults to 60 seconds" - }, - "description": { - "type": "string", - "description": "only required for bolt11 invoices which do not contain a description themselves, but contain a description hash: in this case *description* is required. *description* is then checked against the hash inside the invoice before it will be paid" - }, - "label": { - "type": "string", - "description": "used to attach a label to payments, and is returned in lightning-listpays(7) and lightning-listsendpays(7)" - } - } -} \ No newline at end of file diff --git a/doc/schemas/renepay.schema.json b/doc/schemas/renepay.schema.json deleted file mode 100644 index 2700a5e92608..000000000000 --- a/doc/schemas/renepay.schema.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "added": "v23.08", - "type": "object", - "additionalProperties": false, - "required": [ - "payment_preimage", - "payment_hash", - "created_at", - "parts", - "amount_msat", - "amount_sent_msat", - "status" - ], - "properties": { - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "created_at": { - "type": "number", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "parts": { - "type": "u32", - "description": "how many attempts this took" - }, - "amount_msat": { - "type": "msat", - "description": "amount the recipient received" - }, - "amount_sent_msat": { - "type": "msat", - "description": "total amount we sent (including fees)" - }, - "status": { - "type": "string", - "enum": [ - "complete", - "pending", - "failed" - ], - "description": "status of payment" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment" - } - } -} diff --git a/doc/schemas/renepaystatus.request.json b/doc/schemas/renepaystatus.request.json deleted file mode 100644 index b1fd461dbd0f..000000000000 --- a/doc/schemas/renepaystatus.request.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "invstring": { - "type": "string", - "description": "if specified, the command will return a list of payment attempts whose invoice matches *invstring*, otherwise all payments with be listed" - } - } -} \ No newline at end of file diff --git a/doc/schemas/renepaystatus.schema.json b/doc/schemas/renepaystatus.schema.json deleted file mode 100644 index 03da45dc14d8..000000000000 --- a/doc/schemas/renepaystatus.schema.json +++ /dev/null @@ -1,83 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "added": "v23.08", - "type": "object", - "additionalProperties": false, - "required": [ - "paystatus" - ], - "properties": { - "paystatus": { - "type": "array", - "description": "a list of payments attempted by renepay", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "bolt11", - "payment_hash", - "created_at", - "groupid", - "amount_msat", - "status", - "notes" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "invoice string BOLT11" - }, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash** (for completed payments only)" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "created_at": { - "type": "number", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "groupid": { - "type": "u32", - "description": "the id for this payment attempt" - }, - "parts": { - "type": "u32", - "description": "how many attempts this took" - }, - "amount_msat": { - "type": "msat", - "description": "amount the recipient received" - }, - "amount_sent_msat": { - "type": "msat", - "description": "total amount we sent including fees (for completed payments only)" - }, - "status": { - "type": "string", - "enum": [ - "complete", - "pending", - "failed" - ], - "description": "status of payment" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment" - }, - "notes": { - "type": "array", - "description": "a list of messages for debugging purposes", - "items": { - "type": "string", - "description": "a message generated by renepay" - } - } - } - } - } - } -} diff --git a/doc/schemas/reserveinputs.request.json b/doc/schemas/reserveinputs.request.json deleted file mode 100644 index ddf5b2479272..000000000000 --- a/doc/schemas/reserveinputs.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["psbt"], - "properties": { - "psbt": { - "type": "string", - "description": "the PSBT to reserve inputs from" - }, - "exclusive": { - "type": "boolean", - "description": "If set to *False*, existing reservations are simply extended, rather than causing failure" - }, - "reserve": { - "type": "integer", - "description": "the number of blocks to reserve. By default, reservations are for the next 72 blocks (approximately 6 hours)" - } - } -} \ No newline at end of file diff --git a/doc/schemas/reserveinputs.schema.json b/doc/schemas/reserveinputs.schema.json deleted file mode 100644 index b0803854ace0..000000000000 --- a/doc/schemas/reserveinputs.schema.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "reservations" - ], - "properties": { - "reservations": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "txid", - "vout", - "was_reserved", - "reserved", - "reserved_to_block" - ], - "properties": { - "txid": { - "type": "txid", - "description": "the input transaction id" - }, - "vout": { - "type": "u32", - "description": "the input index output number which was reserved" - }, - "was_reserved": { - "type": "boolean", - "description": "whether the input was already reserved" - }, - "reserved": { - "type": "boolean", - "enum": [ - true - ], - "description": "whether the input is now reserved" - }, - "reserved_to_block": { - "type": "u32", - "description": "what blockheight the reservation will expire" - } - } - } - } - } -} diff --git a/doc/schemas/sendcustommsg.request.json b/doc/schemas/sendcustommsg.request.json deleted file mode 100644 index 6a3787debc0c..000000000000 --- a/doc/schemas/sendcustommsg.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "node_id", - "msg" - ], - "added": "v0.10.1", - "additionalProperties": false, - "properties": { - "node_id": { - "type": "pubkey", - "description": "the node specified by `node_id` must be a peer, i.e., it must have a direct connection with the node receiving the RPC call, and the connection must be established. For a method to send arbitrary messages over multiple hops, including hops that do not understand the custom message, see the `createonion` and `sendonion` RPC methods. Messages can only be injected if the connection is handled by `openingd` or `channeld`. Messages cannot be injected when the peer is handled by `onchaind` or `closingd` since these do not have a connection, or are synchronous daemons that do not handle spontaneous messages" - }, - "msg": { - "type": "hex", - "description": "must be a hex encoded well-formed message, including the 2-byte type prefix, but excluding the length prefix which will be added by the RPC method. The message types may not be one of the internally handled types, since that may cause issues with the internal state tracking of Core Lightning. We do (as of *v23.11*) allow sending of even types, but note that peers (as per the spec) will disconnect on receiving unknown even types" - } - } -} diff --git a/doc/schemas/sendcustommsg.schema.json b/doc/schemas/sendcustommsg.schema.json deleted file mode 100644 index 3c9db46a3ceb..000000000000 --- a/doc/schemas/sendcustommsg.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "status" - ], - "properties": { - "status": { - "type": "string", - "description": "Information about where message was queued" - } - } -} diff --git a/doc/schemas/sendinvoice.request.json b/doc/schemas/sendinvoice.request.json deleted file mode 100644 index f8f5f6aa0199..000000000000 --- a/doc/schemas/sendinvoice.request.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["invreq", "label"], - "properties": { - "invreq": { - "type": "string", - "description": "the bolt12 invoice_request string beginning with `lnr1`" - }, - "label": { - "type": "string", - "description": "the unique label to use for this invoice" - }, - "amount_msat": { - "type": "msat", - "description": "required if the *offer* does not specify an amount at all, or specifies it in a different currency. Otherwise you may set it (e.g. to provide a tip), and if not it defaults to the amount contained in the offer (multiplied by *quantity* if any)" - }, - "timeout": { - "type": "u32", - "description": "seconds to wait for the offering node to pay the invoice or return an error, default 90 seconds. This will also be the timeout on the invoice that is sent" - }, - "quantity": { - "type": "u64", - "description": "quantity is is required if the offer specifies quantity_max, otherwise it is not allowed" - } - } -} \ No newline at end of file diff --git a/doc/schemas/sendinvoice.schema.json b/doc/schemas/sendinvoice.schema.json deleted file mode 100644 index e303bbc058b7..000000000000 --- a/doc/schemas/sendinvoice.schema.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "label", - "description", - "payment_hash", - "status", - "created_index", - "expires_at" - ], - "properties": { - "label": { - "type": "string", - "description": "unique label supplied at invoice creation" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "unpaid", - "paid", - "expired" - ], - "description": "Whether it's paid, unpaid or unpayable" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when it will become / became unpayable" - }, - "amount_msat": { - "type": "msat", - "description": "the amount required to pay this invoice" - }, - "bolt12": { - "type": "string", - "description": "the BOLT12 string" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "updated_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was changed (only present if it has changed since creation)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "paid" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "pay_index", - "amount_received_msat", - "paid_at", - "payment_preimage" - ], - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt12": {}, - "expires_at": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": { - "type": "u64", - "description": "Unique incrementing index for this payment" - }, - "amount_received_msat": { - "type": "msat", - "description": "the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when it was paid" - }, - "payment_preimage": { - "type": "secret", - "description": "proof of payment" - } - } - } - } - ] -} diff --git a/doc/schemas/sendonion.request.json b/doc/schemas/sendonion.request.json deleted file mode 100644 index a4ab01ae0ecc..000000000000 --- a/doc/schemas/sendonion.request.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "onion", - "first_hop", - "payment_hash" - ], - "properties": { - "onion": { - "type": "hex", - "description": "hex-encoded 1366 bytes long blob that was returned by either of the tools that can generate onions. It contains the payloads destined for each hop and some metadata. Please refer to [BOLT 04][bolt04] for further details. If is specific to the route that is being used and the *payment_hash* used to construct, and therefore cannot be reused for other payments or to attempt a separate route. The custom onion can generally be created using the `devtools/onion` CLI tool, or the **createonion** RPC command" - }, - "first_hop": { - "type": "object", - "description": "instructs Core Lightning which peer to send the onion to. It is a JSON dictionary that corresponds to the first element of the route array returned by *getroute*", - "required": [ - "id", - "amount_msat", - "delay" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "node id for the peer. Use any available channel available to this peer" - }, - "amount_msat": { - "type": "msat", - "description": "the amount to add an HTLC for millisatoshis" - }, - "delay": { - "type": "u16", - "description": "the number of blocks delay of blocks on top of the current blockheight" - } - } - }, - "payment_hash": { - "type": "hash", - "description": "specifies the 32 byte hex-encoded hash to use as a challenge to the HTLC that we are sending. It is specific to the onion and has to match the one the onion was created with" - }, - "label": { - "type": "string", - "description": "can be used to provide a human readable reference to retrieve the payment at a later time" - }, - "shared_secrets": { - "type": "array", - "description": "a JSON list of 32 byte hex-encoded secrets that were used when creating the onion. Core Lightning can send a payment with a custom onion without the knowledge of these secrets, however it will not be able to parse an eventual error message since that is encrypted with the shared secrets used in the onion. If *shared_secrets* is provided Core Lightning will decrypt the error, act accordingly, e.g., add a `channel_update` included in the error to its network view, and set the details in *listsendpays* correctly. If it is not provided Core Lightning will store the encrypted onion, and expose it in *listsendpays* allowing the caller to decrypt it externally. If it is not provided the Core Lightning node does not know how long the route is, which channels or nodes are involved, and what an eventual error could have been. It can therefore be used for oblivious payments", - "items": { - "type": "secret" - } - }, - "partid": { - "type": "u16", - "description": "if provided and non-zero, allows for multiple parallel partial payments with the same *payment_hash*" - }, - "bolt11": { - "type": "string", - "description": "if provided, it will be returned in *waitsendpay* and *listsendpays* results" - }, - "amount_msat": { - "type": "msat", - "description": "used to annotate the payment, and is returned by *waitsendpay* and *listsendpays*" - }, - "destination": { - "type": "pubkey", - "description": "if provided, it will be returned in **listpays** result" - }, - "localinvreqid": { - "type": "hex", - "description": "`localinvreqid` is used by offers to link a payment attempt to a local `invoice_request` offer created by lightningd-invoicerequest(7)" - }, - "groupid": { - "type": "u64", - "description": "grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "description": { - "type": "string", - "description": "if provided, it will be returned in *waitsendpay* and *listsendpays* results" - } - } -} diff --git a/doc/schemas/sendonion.schema.json b/doc/schemas/sendonion.schema.json deleted file mode 100644 index 1963a45e5fc8..000000000000 --- a/doc/schemas/sendonion.schema.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "created_index", - "id", - "payment_hash", - "status", - "created_at", - "amount_sent_msat" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was created in" - }, - "id": { - "type": "u64", - "description": "old synonym for created_index" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "complete" - ], - "description": "status of the payment (could be complete if already sent previously)" - }, - "amount_msat": { - "type": "msat", - "description": "The amount delivered to destination (if known)" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "amount_sent_msat": { - "type": "msat", - "description": "The amount sent" - }, - "label": { - "type": "string", - "description": "the label, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if supplied)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied: **experimental-offers** only)." - }, - "partid": { - "type": "u64", - "description": "the partid (if supplied) to sendonion/sendpay" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "complete" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "payment_preimage" - ], - "properties": { - "created_index": {}, - "id": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "groupid": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "bolt11": {}, - "bolt12": {}, - "partid": {}, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was changed" - }, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - } - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "pending" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [], - "properties": { - "created_index": {}, - "id": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "groupid": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "bolt11": {}, - "bolt12": {}, - "partid": {}, - "message": { - "type": "string", - "description": "Monitor status with listpays or waitsendpay" - } - } - } - } - ] -} diff --git a/doc/schemas/sendonionmessage.request.json b/doc/schemas/sendonionmessage.request.json deleted file mode 100644 index e202f5402b63..000000000000 --- a/doc/schemas/sendonionmessage.request.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["first_id", "blinding", "hops"], - "properties": { - "first_id": { - "type": "pubkey", - "description": "the (presumably well-known) public key of the start of the path" - }, - "blinding": { - "type": "pubkey", - "description": "blinding factor for this path" - }, - "hops": { - "type": "array", - "description": "", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "node", - "tlv" - ], - "properties": { - "node": { - "type": "pubkey", - "description": "public key of the node" - }, - "tlv": { - "type": "u8", - "description": "contains a hexidecimal TLV to include" - } - } - } - } - } -} \ No newline at end of file diff --git a/doc/schemas/sendonionmessage.schema.json b/doc/schemas/sendonionmessage.schema.json deleted file mode 100644 index 65571ad4c703..000000000000 --- a/doc/schemas/sendonionmessage.schema.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": {} -} diff --git a/doc/schemas/sendpay.request.json b/doc/schemas/sendpay.request.json deleted file mode 100644 index b18b5389fd49..000000000000 --- a/doc/schemas/sendpay.request.json +++ /dev/null @@ -1,81 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "route", - "payment_hash" - ], - "properties": { - "route": { - "type": "array", - "items": { - "type": "object", - "required": [ - "amount_msat", - "id", - "delay", - "channel" - ], - "properties": { - "id": { - "type": "pubkey", - "description": "The node at the end of this hop" - }, - "channel": { - "type": "short_channel_id", - "description": "The channel joining these nodes" - }, - "delay": { - "type": "u32", - "description": "The total CLTV expected by the node at the end of this hop" - }, - "amount_msat": { - "type": "msat", - "description": "The amount expected by the node at the end of this hop" - } - } - } - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the payment_preimage" - }, - "label": { - "type": "string", - "description": "the label provided when creating the invoice_request" - }, - "amount_msat": { - "type": "msat", - "description": "amount must be provided if *partid* is non-zero, or the payment is to-self, otherwise it must be equal to the final amount to the destination. By default it is in millisatoshi precision; it can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*" - }, - "bolt11": { - "type": "string", - "description": "bolt11 invoice to pay. If provided, will be returned in *waitsendpay* and *listsendpays* results" - }, - "payment_secret": { - "type": "secret", - "description": "value that the final recipient requires to accept the payment, as defined by the `payment_data` field in BOLT 4 and the `s` field in the BOLT 11 invoice format. It is required if *partid* is non-zero" - }, - "partid": { - "type": "u64", - "description": "must not be provided for self-payments. If provided and non-zero, allows for multiple parallel partial payments with the same *payment_hash*. The *amount_msat* amount (which must be provided) for each **sendpay** with matching *payment_hash* must be equal, and **sendpay** will fail if there are differing values given" - }, - "localinvreqid": { - "type": "hex", - "description": "indicates that this payment is being made for a local invoice_request. This ensures that we only send a payment for a single-use invoice_request once" - }, - "groupid": { - "type": "u64", - "description": "allows you to attach a number which appears in **listsendpays** so payments can be identified as part of a logical group. The *pay* plugin uses this to identify one attempt at a MPP payment, for example" - }, - "payment_metadata": { - "type": "hex", - "description": "placed in the final onion hop TLV" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - } - } -} diff --git a/doc/schemas/sendpay.schema.json b/doc/schemas/sendpay.schema.json deleted file mode 100644 index f1030c2aa38b..000000000000 --- a/doc/schemas/sendpay.schema.json +++ /dev/null @@ -1,165 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "id", - "created_index", - "payment_hash", - "status", - "created_at", - "amount_sent_msat" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was created in" - }, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was changed (only present if it has changed since creation)" - }, - "id": { - "type": "u64", - "description": "old synonym for created_index" - }, - "groupid": { - "type": "u64", - "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "pending", - "complete" - ], - "description": "status of the payment (could be complete if already sent previously)" - }, - "amount_msat": { - "type": "msat", - "description": "The amount delivered to destination (if known)" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "completed_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was completed" - }, - "amount_sent_msat": { - "type": "msat", - "description": "The amount sent" - }, - "label": { - "type": "string", - "description": "the *label*, if given to sendpay" - }, - "partid": { - "type": "u64", - "description": "the *partid*, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if supplied)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied: **experimental-offers** only)." - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "complete" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "payment_preimage" - ], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "partid": {}, - "bolt11": {}, - "bolt12": {}, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - } - } - } - }, - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "pending" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "message" - ], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "partid": {}, - "bolt11": {}, - "bolt12": {}, - "message": { - "type": "string", - "description": "Monitor status with listpays or waitsendpay" - } - } - } - } - ] -} diff --git a/doc/schemas/sendpsbt.request.json b/doc/schemas/sendpsbt.request.json deleted file mode 100644 index e8e2f9e8d5a0..000000000000 --- a/doc/schemas/sendpsbt.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt" - ], - "properties": { - "psbt": { - "type": "string", - "description": "the fully signed psbt to be sent" - }, - "reserve": { - "type": "u32", - "description": "number of blocks to increase reservation of any of our inputs by. Default is 72" - } - } -} diff --git a/doc/schemas/sendpsbt.schema.json b/doc/schemas/sendpsbt.schema.json deleted file mode 100644 index d3c831d17544..000000000000 --- a/doc/schemas/sendpsbt.schema.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "tx", - "txid" - ], - "properties": { - "tx": { - "type": "hex", - "description": "The raw transaction which was sent" - }, - "txid": { - "type": "txid", - "description": "The txid of the **tx**" - } - } -} diff --git a/doc/schemas/setchannel.request.json b/doc/schemas/setchannel.request.json deleted file mode 100644 index c0eaad9dc50c..000000000000 --- a/doc/schemas/setchannel.request.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "should contain a scid (short channel ID), channel id or peerid (pubkey) of the channel to be modified. If *id* is set to `all`, the updates are applied to all channels in states CHANNELD_NORMAL CHANNELD_AWAITING_LOCKIN or DUALOPEND_AWAITING_LOCKIN. If *id* is a peerid, all channels with the +peer in those states are changed" - }, - "feebase": { - "type": "msat", - "description": "value in millisatoshi that is added as base fee to any routed payment: if omitted, it is unchanged. It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*" - }, - "feeppm": { - "type": "u32", - "description": "value that is added proportionally per-millionths to any routed payment volume in satoshi. For example, if ppm is 1,000 and 1,000,000 satoshi is being routed through the channel, an proportional fee of 1,000 satoshi is added, resulting in a 0.1% fee" - }, - "htlcmin": { - "type": "msat", - "description": "value that limits how small an HTLC we will forward: if omitted, it is unchanged (the default is no lower limit). It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*. Note that the peer also enforces a minimum for the channel: setting it below that will simply set it to that value with a warning. Also note that *htlcmin* only applies to forwarded HTLCs: we can still send smaller payments ourselves" - }, - "htlcmax": { - "type": "msat", - "description": "value that limits how large an HTLC we will forward: if omitted, it is unchanged (the default is no effective limit). It can be a whole number, or a whole number ending in *msat* or *sat*, or a number with three decimal places ending in *sat*, or a number with 1 to 11 decimal places ending in *btc*. Note that *htlcmax* only applies to forwarded HTLCs: we can still send larger payments ourselves" - }, - "enforcedelay": { - "type": "u32", - "description": "number of seconds to delay before enforcing the new fees/htlc max (default 600, which is ten minutes). This gives the network a chance to catch up with the new rates and avoids rejecting HTLCs before they do. This only has an effect if rates are increased (we always allow users to overpay fees) or *htlcmax* is decreased, and only applied to a single rate increase per channel (we don't remember an arbitrary number of prior feerates) and if the node is restarted the updated configuration is enforced immediately" - }, - "ignorefeelimits": { - "added": "v23.08", - "type": "boolean", - "description": "if set to True means to allow the peer to set the commitment transaction fees (or closing transaction fees) to any value they want. This is dangerous: they could set an exorbitant fee (so HTLCs are unenforcable), or a tiny fee (so that commitment transactions cannot be relayed), but avoids channel breakage in case of feerate disagreements. (Note: the global `ignore_fee_limits` setting overrides this)" - } - } -} diff --git a/doc/schemas/setchannel.schema.json b/doc/schemas/setchannel.schema.json deleted file mode 100644 index d4dd33cff990..000000000000 --- a/doc/schemas/setchannel.schema.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channels" - ], - "properties": { - "channels": { - "type": "array", - "description": "channel(s) set, and their resulting configuration", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "peer_id", - "channel_id", - "fee_base_msat", - "fee_proportional_millionths", - "minimum_htlc_out_msat", - "maximum_htlc_out_msat", - "ignore_fee_limits" - ], - "properties": { - "peer_id": { - "type": "pubkey", - "description": "The node_id of the peer" - }, - "channel_id": { - "type": "hex", - "description": "The channel_id of the channel", - "minLength": 64, - "maxLength": 64 - }, - "short_channel_id": { - "type": "short_channel_id", - "description": "the short_channel_id (if locked in)" - }, - "fee_base_msat": { - "type": "msat", - "description": "The resulting feebase (this is the BOLT #7 name)" - }, - "fee_proportional_millionths": { - "type": "u32", - "description": "The resulting feeppm (this is the BOLT #7 name)" - }, - "ignore_fee_limits": { - "type": "boolean", - "added": "v23.08", - "description": "If we are now allowing peer to set feerate on commitment transaction without restriction" - }, - "minimum_htlc_out_msat": { - "type": "msat", - "description": "The resulting htlcmin we will advertize (the BOLT #7 name is htlc_minimum_msat)" - }, - "warning_htlcmin_too_low": { - "type": "string", - "description": "The requested htlcmin was too low for this peer, so we set it to the minimum they will allow" - }, - "maximum_htlc_out_msat": { - "type": "msat", - "description": "The resulting htlcmax we will advertize (the BOLT #7 name is htlc_maximum_msat)" - }, - "warning_htlcmax_too_high": { - "type": "string", - "description": "The requested htlcmax was greater than the channel capacity, so we set it to the channel capacity" - } - } - } - } - } -} diff --git a/doc/schemas/setconfig.request.json b/doc/schemas/setconfig.request.json deleted file mode 100644 index 6331bdddf6b9..000000000000 --- a/doc/schemas/setconfig.request.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "config" - ], - "added": "v23.08", - "properties": { - "config": { - "type": "string", - "description": "name of the config variable which should be set to the value of the variable" - }, - "val": { - "type": "string or msat or int or boolean", - "description": "value of the config variable to be set or updated" - } - } -} diff --git a/doc/schemas/setconfig.schema.json b/doc/schemas/setconfig.schema.json deleted file mode 100644 index a4c09e32cb61..000000000000 --- a/doc/schemas/setconfig.schema.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.08", - "required": [ - "config" - ], - "properties": { - "config": { - "type": "object", - "description": "config settings after completion", - "additionalProperties": false, - "required": [ - "config", - "source", - "dynamic" - ], - "properties": { - "config": { - "type": "string", - "description": "name of the config variable which was set" - }, - "source": { - "type": "string", - "description": "source of configuration setting (`file`:`linenum`)" - }, - "plugin": { - "type": "string", - "description": "the plugin this configuration setting is for" - }, - "dynamic": { - "type": "boolean", - "enum": [ - true - ], - "description": "whether this option is settable via setconfig" - }, - "set": { - "type": "boolean", - "description": "for simple flag options" - }, - "value_str": { - "type": "string", - "description": "for string options" - }, - "value_msat": { - "type": "msat", - "description": "for msat options" - }, - "value_int": { - "type": "integer", - "description": "for integer options" - }, - "value_bool": { - "type": "boolean", - "description": "for boolean options" - } - } - } - } -} diff --git a/doc/schemas/setpsbtversion.request.json b/doc/schemas/setpsbtversion.request.json deleted file mode 100644 index aac57525487e..000000000000 --- a/doc/schemas/setpsbtversion.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["psbt", "version"], - "properties": { - "psbt": { - "type": "string", - "description": "the PSBT to change versions" - }, - "version": { - "type": "integer", - "description": "the version to set" - } - } -} diff --git a/doc/schemas/setpsbtversion.schema.json b/doc/schemas/setpsbtversion.schema.json deleted file mode 100644 index ac11f52e773b..000000000000 --- a/doc/schemas/setpsbtversion.schema.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["psbt"], - "properties": { - "psbt": { - "type": "string", - "description": "a converted PSBT of the requested version" - } - } -} diff --git a/doc/schemas/showrunes.request.json b/doc/schemas/showrunes.request.json deleted file mode 100644 index da2831ff7379..000000000000 --- a/doc/schemas/showrunes.request.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "added": "v23.08", - "properties": { - "rune": { - "type": "string", - "description": "if specified, only details of that rune will be returned" - } - } -} diff --git a/doc/schemas/showrunes.schema.json b/doc/schemas/showrunes.schema.json deleted file mode 100644 index 0fa759100f1f..000000000000 --- a/doc/schemas/showrunes.schema.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "runes" - ], - "properties": { - "runes": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "rune", - "unique_id", - "restrictions", - "restrictions_as_english" - ], - "properties": { - "rune": { - "type": "string", - "description": "Base64 encoded rune" - }, - "unique_id": { - "type": "string", - "description": "Unique id assigned when the rune was generated; this is always a u64 for commando runes" - }, - "restrictions": { - "type": "array", - "description": "The restrictions on what commands this rune can authorize", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "alternatives", - "english" - ], - "properties": { - "alternatives": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false, - "required": [ - "fieldname", - "value", - "condition", - "english" - ], - "properties": { - "fieldname": { - "type": "string", - "description": "The field this restriction applies to; see commando-rune(7)" - }, - "value": { - "type": "string", - "description": "The value accepted for this field" - }, - "condition": { - "type": "string", - "description": "The way to compare fieldname and value" - }, - "english": { - "type": "string", - "description": "English readable description of this alternative" - } - } - } - }, - "english": { - "type": "string", - "description": "English readable summary of alternatives above" - } - } - } - }, - "restrictions_as_english": { - "type": "string", - "description": "English readable description of the restrictions array above" - }, - "stored": { - "type": "boolean", - "enum": [ - false - ], - "description": "This is false if the rune does not appear in our datastore (only possible when `rune` is specified)" - }, - "blacklisted": { - "type": "boolean", - "enum": [ - true - ], - "description": "The rune has been blacklisted; see commando-blacklist(7)" - }, - "last_used": { - "type": "number", - "description": "The last time this rune was successfully used", - "added": "23.11" - }, - "our_rune": { - "type": "boolean", - "enum": [ - false - ], - "description": "This is not a rune for this node (only possible when `rune` is specified)" - } - } - } - } - } -} diff --git a/doc/schemas/signinvoice.request.json b/doc/schemas/signinvoice.request.json deleted file mode 100644 index 7e13e49effea..000000000000 --- a/doc/schemas/signinvoice.request.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "added": "v23.02", - "required": [ - "invstring" - ], - "properties": { - "invstring": { - "type": "bolt11", - "description": "bolt11 form, but the final signature is ignored. Minimal sanity checks are done" - } - } -} diff --git a/doc/schemas/signinvoice.schema.json b/doc/schemas/signinvoice.schema.json deleted file mode 100644 index bf9be4741211..000000000000 --- a/doc/schemas/signinvoice.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "bolt11" - ], - "properties": { - "bolt11": { - "type": "string", - "description": "the bolt11 string" - } - } -} diff --git a/doc/schemas/signmessage.request.json b/doc/schemas/signmessage.request.json deleted file mode 100644 index 9ff224c7f339..000000000000 --- a/doc/schemas/signmessage.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "message" - ], - "additionalProperties": false, - "properties": { - "message": { - "type": "string", - "description": "less that 65536 characters long message to be signed by the node" - } - } -} diff --git a/doc/schemas/signmessage.schema.json b/doc/schemas/signmessage.schema.json deleted file mode 100644 index 42eea4e774f4..000000000000 --- a/doc/schemas/signmessage.schema.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "signature", - "recid", - "zbase" - ], - "properties": { - "signature": { - "type": "hex", - "description": "The signature", - "minLength": 128, - "maxLength": 128 - }, - "recid": { - "type": "hex", - "description": "The recovery id (0, 1, 2 or 3)", - "minLength": 2, - "maxLength": 2 - }, - "zbase": { - "type": "string", - "description": "*signature* and *recid* encoded in a style compatible with **lnd**'s [SignMessageRequest](https://api.lightning.community/#grpc-request-signmessagerequest)" - } - } -} diff --git a/doc/schemas/signpsbt.request.json b/doc/schemas/signpsbt.request.json deleted file mode 100644 index 11cbe05e1778..000000000000 --- a/doc/schemas/signpsbt.request.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt" - ], - "properties": { - "psbt": { - "type": "string", - "description": "the psbt to be signed" - }, - "signonly": { - "type": "array", - "description": "input numbers to sign", - "items": { - "type": "u32" - } - } - } -} diff --git a/doc/schemas/signpsbt.schema.json b/doc/schemas/signpsbt.schema.json deleted file mode 100644 index 271f58c9bd78..000000000000 --- a/doc/schemas/signpsbt.schema.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "signed_psbt" - ], - "properties": { - "signed_psbt": { - "type": "string", - "description": "The fully signed PSBT" - } - } -} diff --git a/doc/schemas/splice_init.request.json b/doc/schemas/splice_init.request.json deleted file mode 100644 index 01573ac1090a..000000000000 --- a/doc/schemas/splice_init.request.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "relative_amount" - ], - "added": "v23.08", - "properties": { - "channel_id": { - "type": "string", - "description": "the channel id of the channel to be spliced" - }, - "relative_amount": { - "type": "integer", - "description": "a positive or negative amount of satoshis to add or subtract from the channel" - }, - "initialpsbt": { - "type": "string", - "description": "the (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically" - }, - "feerate_per_kw": { - "type": "u32", - "description": "the miner fee we promise our peer to pay for our side of the splice transaction. It is calculated by `feerate_per_kw` * our_bytes_in_splice_tx / 1000" - }, - "force_feerate": { - "type": "boolean", - "description": "by default splices will fail if the fee provided looks too high. This is to protect against accidentally setting your fee higher than intended. Set `force_feerate` to true to skip this saftey check" - } - } -} diff --git a/doc/schemas/splice_init.schema.json b/doc/schemas/splice_init.schema.json deleted file mode 100644 index 0551f7e8180b..000000000000 --- a/doc/schemas/splice_init.schema.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt" - ], - "added": "v23.08", - "properties": { - "psbt": { - "type": "string", - "description": "the (incomplete) PSBT of the splice transaction" - } - } -} diff --git a/doc/schemas/splice_signed.request.json b/doc/schemas/splice_signed.request.json deleted file mode 100644 index 8e6b8dec2515..000000000000 --- a/doc/schemas/splice_signed.request.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "psbt" - ], - "added": "v23.08", - "properties": { - "channel_id": { - "type": "string", - "description": "the channel id of the channel to be spliced" - }, - "psbt": { - "type": "string", - "description": "the final version of the psbt to complete the splice with" - }, - "sign_first": { - "type": "boolean", - "description": "a flag that makes our node offer the final splice signature first (defaults to false). When false, the node will calculate who should sign first based off who is adding inputting the least sats to the splice as per spec" - } - } -} diff --git a/doc/schemas/splice_signed.schema.json b/doc/schemas/splice_signed.schema.json deleted file mode 100644 index 0457c2d346d4..000000000000 --- a/doc/schemas/splice_signed.schema.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "tx", - "txid" - ], - "added": "v23.08", - "properties": { - "tx": { - "type": "hex", - "description": "The hex representation of the final transaction that is published" - }, - "txid": { - "type": "txid", - "description": "The txid is of the final transaction" - } - } -} diff --git a/doc/schemas/splice_update.request.json b/doc/schemas/splice_update.request.json deleted file mode 100644 index 1cdac8e25e39..000000000000 --- a/doc/schemas/splice_update.request.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "channel_id", - "psbt" - ], - "added": "v23.08", - "properties": { - "channel_id": { - "type": "string", - "description": "the channel id of the channel to be spliced" - }, - "psbt": { - "type": "string", - "description": "the base 64 encoded PSBT returned from `splice_init` with any changes added by the user" - } - } -} diff --git a/doc/schemas/splice_update.schema.json b/doc/schemas/splice_update.schema.json deleted file mode 100644 index 96e04edac6d1..000000000000 --- a/doc/schemas/splice_update.schema.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt", - "commitments_secured" - ], - "added": "v23.08", - "properties": { - "psbt": { - "type": "string", - "description": "the (incomplete) PSBT of the splice transaction" - }, - "commitments_secured": { - "type": "boolean", - "description": "whether or not the commitments were secured" - } - } -} diff --git a/doc/schemas/staticbackup.request.json b/doc/schemas/staticbackup.request.json deleted file mode 100644 index f99496c5ac84..000000000000 --- a/doc/schemas/staticbackup.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": {} -} diff --git a/doc/schemas/staticbackup.schema.json b/doc/schemas/staticbackup.schema.json deleted file mode 100644 index bc9daeb2e136..000000000000 --- a/doc/schemas/staticbackup.schema.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "scb" - ], - "properties": { - "scb": { - "type": "array", - "items": { - "type": "hex", - "description": "SCB of a channel in TLV format" - } - } - } -} diff --git a/doc/schemas/stop.request.json b/doc/schemas/stop.request.json deleted file mode 100644 index 65571ad4c703..000000000000 --- a/doc/schemas/stop.request.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": {} -} diff --git a/doc/schemas/stop.schema.json b/doc/schemas/stop.schema.json deleted file mode 100644 index 00105c74383b..000000000000 --- a/doc/schemas/stop.schema.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "string", - "enum": [ - "Shutdown complete" - ] -} diff --git a/doc/schemas/txdiscard.request.json b/doc/schemas/txdiscard.request.json deleted file mode 100644 index 7a9e87538208..000000000000 --- a/doc/schemas/txdiscard.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "txid" - ], - "properties": { - "txid": { - "type": "txid", - "description": "the transaction id, inputs should be unreseverd from" - } - } -} diff --git a/doc/schemas/txdiscard.schema.json b/doc/schemas/txdiscard.schema.json deleted file mode 100644 index 956380618c6d..000000000000 --- a/doc/schemas/txdiscard.schema.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "unsigned_tx", - "txid" - ], - "properties": { - "unsigned_tx": { - "type": "hex", - "description": "the unsigned transaction" - }, - "txid": { - "type": "txid", - "description": "the transaction id of *unsigned_tx*" - } - } -} diff --git a/doc/schemas/txprepare.request.json b/doc/schemas/txprepare.request.json deleted file mode 100644 index 91d3484b00ff..000000000000 --- a/doc/schemas/txprepare.request.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "outputs" - ], - "properties": { - "outputs": { - "type": "array", - "description": "format is like: [{destination1: amount1}, {destination2: amount2}] or [{destination: *all*}]. It supports any number of **confirmed** outputs", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "destination", - "amount" - ], - "properties": { - "destination": { - "type": "string", - "description": "the address which can be of any Bitcoin accepted type, including bech32" - }, - "amount": { - "type": "msat", - "description": "the amount to be sent from the internal wallet (expressed, as name suggests, in amount). The string *all* can be used to specify all available funds. Otherwise, it is in amount precision; it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - } - } - } - }, - "feerate": { - "type": "feerate", - "description": "used for the transaction as initial feerate. The default is *normal*" - }, - "minconf": { - "type": "u32", - "description": "the minimum number of confirmations that used outputs should have. Default is 1" - }, - "utxos": { - "type": "array", - "description": "to be used to fund the transaction, as an array of `txid:vout`. These must be drawn from the node's available UTXO set", - "items": { - "type": "outpoint" - } - } - } -} diff --git a/doc/schemas/txprepare.schema.json b/doc/schemas/txprepare.schema.json deleted file mode 100644 index 2377c322c123..000000000000 --- a/doc/schemas/txprepare.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "psbt", - "unsigned_tx", - "txid" - ], - "properties": { - "psbt": { - "type": "string", - "description": "the PSBT representing the unsigned transaction" - }, - "unsigned_tx": { - "type": "hex", - "description": "the unsigned transaction" - }, - "txid": { - "type": "txid", - "description": "the transaction id of *unsigned_tx*; you hand this to lightning-txsend(7) or lightning-txdiscard(7), as the inputs of this transaction are reserved." - } - } -} diff --git a/doc/schemas/txsend.request.json b/doc/schemas/txsend.request.json deleted file mode 100644 index 18ef78478ffa..000000000000 --- a/doc/schemas/txsend.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "txid" - ], - "properties": { - "txid": { - "type": "txid", - "description": "The transaction id of the transaction created by **txprepare**" - } - } -} diff --git a/doc/schemas/txsend.schema.json b/doc/schemas/txsend.schema.json deleted file mode 100644 index e7a47f1ca164..000000000000 --- a/doc/schemas/txsend.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "psbt", - "tx", - "txid" - ], - "properties": { - "psbt": { - "type": "string", - "description": "the completed PSBT representing the signed transaction" - }, - "tx": { - "type": "hex", - "description": "the fully signed transaction" - }, - "txid": { - "type": "txid", - "description": "the transaction id of *tx*" - } - } -} diff --git a/doc/schemas/unreserveinputs.request.json b/doc/schemas/unreserveinputs.request.json deleted file mode 100644 index 084c62eb0cfa..000000000000 --- a/doc/schemas/unreserveinputs.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": ["psbt"], - "properties": { - "psbt": { - "type": "string", - "description": "inputs to unreserve are the inputs specified in the passed-in *psbt*" - }, - "reserve": { - "type": "integer", - "description": "the number of blocks to decrease reservation by; default is 72" - } - } -} \ No newline at end of file diff --git a/doc/schemas/unreserveinputs.schema.json b/doc/schemas/unreserveinputs.schema.json deleted file mode 100644 index 264f603a26cf..000000000000 --- a/doc/schemas/unreserveinputs.schema.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "reservations" - ], - "properties": { - "reservations": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true, - "required": [ - "txid", - "vout", - "was_reserved", - "reserved" - ], - "properties": { - "txid": { - "type": "txid", - "description": "the transaction id" - }, - "vout": { - "type": "u32", - "description": "the output number which was reserved" - }, - "was_reserved": { - "type": "boolean", - "description": "whether the input was already reserved (usually `true`)" - }, - "reserved": { - "type": "boolean", - "description": "whether the input is now reserved (may still be `true` if it was reserved for a long time)" - } - }, - "allOf": [ - { - "if": { - "additionalProperties": true, - "properties": { - "reserved": { - "enum": [ - true - ] - } - } - }, - "then": { - "required": [ - "reserved_to_block" - ], - "properties": { - "txid": {}, - "vout": {}, - "was_reserved": {}, - "reserved": {}, - "reserved_to_block": { - "type": "u32", - "description": "what blockheight the reservation will expire" - } - } - } - } - ] - } - } - } -} diff --git a/doc/schemas/upgradewallet.request.json b/doc/schemas/upgradewallet.request.json deleted file mode 100644 index 60f58ec1763b..000000000000 --- a/doc/schemas/upgradewallet.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [], - "additionalProperties": false, - "properties": { - "feerate": { - "type": "feerate", - "description": "Feerate for the upgrade transaction", - "added": "v23.02" - }, - "reservedok": { - "type": "boolean", - "description": "Include already reserved funds or not", - "added": "v23.02" - } - } -} diff --git a/doc/schemas/upgradewallet.schema.json b/doc/schemas/upgradewallet.schema.json deleted file mode 100644 index cd4a5c957c44..000000000000 --- a/doc/schemas/upgradewallet.schema.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "upgraded_outs" - ], - "properties": { - "upgraded_outs": { - "type": "u64", - "description": "Count of spent/upgraded UTXOs", - "added": "v23.02" - }, - "psbt": { - "type": "string", - "description": "The PSBT that was finalized and sent", - "added": "v23.02" - }, - "tx": { - "type": "hex", - "description": "The raw transaction which was sent", - "added": "v23.02" - }, - "txid": { - "type": "txid", - "description": "The txid of the **tx**", - "added": "v23.02" - } - } -} diff --git a/doc/schemas/utxopsbt.request.json b/doc/schemas/utxopsbt.request.json deleted file mode 100644 index db6f3d98c663..000000000000 --- a/doc/schemas/utxopsbt.request.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "satoshi", - "feerate", - "startweight", - "utxos" - ], - "properties": { - "satoshi": { - "type": "msat_or_all", - "description": "the minimum satoshi value of the output(s) needed (or the string `all` meaning use all unreserved inputs). If a value, it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - }, - "feerate": { - "type": "feerate", - "description": "used for the transaction as initial feerate. The default is *normal*" - }, - "startweight": { - "type": "u32", - "description": "the weight of the transaction before *fundpsbt* has added any inputs" - }, - "utxos": { - "type": "array", - "description": "an array of `txid:vout`, each of which must be reserved or available", - "items": { - "type": "outpoint" - } - }, - "reserve": { - "type": "u32", - "description": "if not zero, then *reserveinputs* is called (successfully, with *exclusive* true) on the returned PSBT for this number of blocks. Defaults to 72 blocks if unspecified" - }, - "reservedok": { - "type": "boolean", - "description": "if set to true, it will also fail if any of the *utxos* are already reserved. Default is false" - }, - "locktime": { - "type": "u32", - "description": "if not set, it is set to a recent block height" - }, - "min_witness_weight": { - "type": "u32", - "description": "minimum weight to use for a UTXO's witness. If the actual witness weight is greater than the provided minimum, the actual witness weight will be used" - }, - "excess_as_change": { - "type": "boolean", - "description": "flag to add a change output for the excess sats" - }, - "opening_anchor_channel": { - "added": "v23.08", - "type": "boolean", - "description": "to signel that it needs emergency reserve for anchors so that we can lowball our commitment tx fees, and min-emergency-msat for reserving some sats for closing anchor channels" - } - } -} diff --git a/doc/schemas/utxopsbt.schema.json b/doc/schemas/utxopsbt.schema.json deleted file mode 100644 index d24ad03488f7..000000000000 --- a/doc/schemas/utxopsbt.schema.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "psbt", - "feerate_per_kw", - "estimated_final_weight", - "excess_msat" - ], - "properties": { - "psbt": { - "type": "string", - "description": "Unsigned PSBT which fulfills the parameters given" - }, - "feerate_per_kw": { - "type": "u32", - "description": "The feerate used to create the PSBT, in satoshis-per-kiloweight" - }, - "estimated_final_weight": { - "type": "u32", - "description": "The estimated weight of the transaction once fully signed" - }, - "excess_msat": { - "type": "msat", - "description": "The amount above *satoshi* which is available. This could be zero, or dust; it will be zero if *change_outnum* is also returned" - }, - "change_outnum": { - "type": "u32", - "description": "The 0-based output number where change was placed (only if parameter *excess_as_change* was true and there was sufficient funds)" - }, - "reservations": { - "type": "array", - "description": "If *reserve* was true or a non-zero number, just as per lightning-reserveinputs(7)", - "items": { - "type": "object", - "required": [ - "txid", - "vout", - "was_reserved", - "reserved", - "reserved_to_block" - ], - "additionalProperties": false, - "properties": { - "txid": { - "type": "txid", - "description": "The txid of the transaction" - }, - "vout": { - "type": "u32", - "description": "The 0-based output number" - }, - "was_reserved": { - "type": "boolean", - "description": "Whether this output was previously reserved" - }, - "reserved": { - "type": "boolean", - "enum": [ - true - ], - "description": "Whether this output is now reserved" - }, - "reserved_to_block": { - "type": "u32", - "description": "The blockheight the reservation will expire" - } - } - } - } - } -} diff --git a/doc/schemas/wait.request.json b/doc/schemas/wait.request.json deleted file mode 100644 index e21c13d6095a..000000000000 --- a/doc/schemas/wait.request.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "added": "v23.08", - "additionalProperties": false, - "required": [ - "subsystem", - "indexname", - "nextvalue" - ], - "properties": { - "subsystem": { - "type": "string", - "description": "the subsystem to get the next index value from", - "enum": [ - "invoices", - "forwards", - "sendpays" - ] - }, - "indexname": { - "type": "string", - "description": "the name of the index to get the next value for", - "enum": [ - "created", - "updated", - "deleted" - ] - }, - "nextvalue": { - "type": "u64", - "description": "the next value of the index" - } - } -} diff --git a/doc/schemas/wait.schema.json b/doc/schemas/wait.schema.json deleted file mode 100644 index ce3238d0f941..000000000000 --- a/doc/schemas/wait.schema.json +++ /dev/null @@ -1,189 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "subsystem" - ], - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "invoices", - "forwards", - "sendpays" - ] - }, - "created": { - "type": "u64", - "description": "1-based index indicating order entry was created" - }, - "updated": { - "type": "u64", - "description": "1-based index indicating order entry was updated" - }, - "deleted": { - "type": "u64", - "description": "1-based index indicating order entry was deleted" - }, - "details": {} - }, - "allOf": [ - { - "if": { - "additionalProperties": true, - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "invoices" - ] - } - } - }, - "then": { - "additionalProperties": false, - "properties": { - "subsystem": {}, - "created": {}, - "updated": {}, - "deleted": {}, - "details": { - "type": "object", - "additionalProperties": false, - "properties": { - "status": { - "type": "string", - "enum": [ - "unpaid", - "paid", - "expired" - ], - "description": "Whether it's paid, unpaid or unpayable" - }, - "label": { - "type": "string", - "description": "unique label supplied at invoice creation" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "bolt11": { - "type": "string", - "description": "the BOLT11 string" - }, - "bolt12": { - "type": "string", - "description": "the BOLT12 string" - } - } - } - } - } - }, - { - "if": { - "additionalProperties": true, - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "forwards" - ] - } - } - }, - "then": { - "additionalProperties": false, - "properties": { - "subsystem": {}, - "created": {}, - "updated": {}, - "deleted": {}, - "details": { - "type": "object", - "additionalProperties": false, - "properties": { - "status": { - "type": "string", - "enum": [ - "offered", - "settled", - "failed", - "local_failed" - ], - "description": "still ongoing, completed, failed locally, or failed after forwarding" - }, - "in_channel": { - "type": "short_channel_id", - "description": "unique label supplied at invoice creation" - }, - "in_htlc_id": { - "type": "u64", - "description": "the unique HTLC id the sender gave this (not present if incoming channel was closed before ugprade to v22.11)" - }, - "in_msat": { - "type": "msat", - "description": "the value of the incoming HTLC" - }, - "out_channel": { - "type": "short_channel_id", - "description": "the channel that the HTLC (trying to) forward to" - } - } - } - } - } - }, - { - "if": { - "additionalProperties": true, - "properties": { - "subsystem": { - "type": "string", - "enum": [ - "sendpays" - ] - } - } - }, - "then": { - "additionalProperties": false, - "properties": { - "subsystem": {}, - "created": {}, - "updated": {}, - "deleted": {}, - "details": { - "type": "object", - "additionalProperties": false, - "properties": { - "status": { - "type": "string", - "enum": [ - "pending", - "failed", - "complete" - ], - "description": "status of the payment" - }, - "partid": { - "type": "u64", - "description": "Part number (for multiple parts to a single payment)" - }, - "groupid": { - "type": "u64", - "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - } - } - } - } - } - } - ] -} diff --git a/doc/schemas/waitanyinvoice.request.json b/doc/schemas/waitanyinvoice.request.json deleted file mode 100644 index f39c0b8f3077..000000000000 --- a/doc/schemas/waitanyinvoice.request.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [], - "properties": { - "lastpay_index": { - "type": "u64", - "description": "ignores any invoices paid prior to or including this index. 0 is equivalent to not specifying and negative value is invalid" - }, - "timeout": { - "type": "u64", - "description": "if specified, wait at most that number of seconds, which must be an integer. If the specified *timeout* is reached, this command will return with an error. You can specify this to 0 so that **waitanyinvoice** will return immediately with an error if no pending invoice is available yet. If unspecified, this command will wait indefinitely" - } - } -} diff --git a/doc/schemas/waitanyinvoice.schema.json b/doc/schemas/waitanyinvoice.schema.json deleted file mode 100644 index 89e7eb70b443..000000000000 --- a/doc/schemas/waitanyinvoice.schema.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "label", - "description", - "payment_hash", - "status", - "created_index", - "expires_at" - ], - "properties": { - "label": { - "type": "string", - "description": "unique label supplied at invoice creation" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "paid", - "expired" - ], - "description": "Whether it's paid or expired" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when it will become / became unpayable" - }, - "amount_msat": { - "type": "msat", - "description": "the amount required to pay this invoice" - }, - "bolt11": { - "type": "string", - "description": "the BOLT11 string (always present unless *bolt12* is)" - }, - "bolt12": { - "type": "string", - "description": "the BOLT12 string (always present unless *bolt11* is)" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "updated_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was changed (only present if it has changed since creation)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "paid" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "pay_index", - "amount_received_msat", - "paid_at", - "payment_preimage" - ], - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "expires_at": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": { - "type": "u64", - "description": "Unique incrementing index for this payment" - }, - "amount_received_msat": { - "type": "msat", - "description": "the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when it was paid" - }, - "paid_outpoint": { - "type": "object", - "description": "Outpoint this invoice was paid with", - "added": "v23.11", - "additionalProperties": false, - "required": [ - "txid", - "outnum" - ], - "properties": { - "txid": { - "added": "v23.11", - "type": "txid", - "description": "ID of the transaction that paid the invoice" - }, - "outnum": { - "added": "v23.11", - "type": "u32", - "description": "The 0-based output number of the transaction that paid the invoice" - } - } - }, - "payment_preimage": { - "type": "secret", - "description": "proof of payment" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "created_index": {}, - "updated_index": {}, - "expires_at": {} - } - } - } - ] -} diff --git a/doc/schemas/waitblockheight.request.json b/doc/schemas/waitblockheight.request.json deleted file mode 100644 index 3e2a1b091643..000000000000 --- a/doc/schemas/waitblockheight.request.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "blockheight" - ], - "properties": { - "blockheight": { - "type": "u32", - "description": "current blockheight of the blockchain if the value is greater than this number. If it is a present or past block height, then the command returns immediately" - }, - "timeout": { - "type": "u32", - "description": "only wait up to specified seconds. Defaults to 60 seconds" - } - } -} diff --git a/doc/schemas/waitblockheight.schema.json b/doc/schemas/waitblockheight.schema.json deleted file mode 100644 index 71fd35ca3897..000000000000 --- a/doc/schemas/waitblockheight.schema.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "blockheight" - ], - "properties": { - "blockheight": { - "type": "u32", - "description": "The current block height (>= *blockheight* parameter)" - } - } -} diff --git a/doc/schemas/waitinvoice.request.json b/doc/schemas/waitinvoice.request.json deleted file mode 100644 index dea8da0f5fd9..000000000000 --- a/doc/schemas/waitinvoice.request.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "label" - ], - "properties": { - "label": { - "type": "string", - "description": "unique label of the invoice waiting to be paid" - } - } -} diff --git a/doc/schemas/waitinvoice.schema.json b/doc/schemas/waitinvoice.schema.json deleted file mode 100644 index 89e7eb70b443..000000000000 --- a/doc/schemas/waitinvoice.schema.json +++ /dev/null @@ -1,151 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "label", - "description", - "payment_hash", - "status", - "created_index", - "expires_at" - ], - "properties": { - "label": { - "type": "string", - "description": "unique label supplied at invoice creation" - }, - "description": { - "type": "string", - "description": "description used in the invoice" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "paid", - "expired" - ], - "description": "Whether it's paid or expired" - }, - "expires_at": { - "type": "u64", - "description": "UNIX timestamp of when it will become / became unpayable" - }, - "amount_msat": { - "type": "msat", - "description": "the amount required to pay this invoice" - }, - "bolt11": { - "type": "string", - "description": "the BOLT11 string (always present unless *bolt12* is)" - }, - "bolt12": { - "type": "string", - "description": "the BOLT12 string (always present unless *bolt11* is)" - }, - "created_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was created in" - }, - "updated_index": { - "type": "u64", - "added": "v23.08", - "description": "1-based index indicating order this invoice was changed (only present if it has changed since creation)" - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "paid" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "pay_index", - "amount_received_msat", - "paid_at", - "payment_preimage" - ], - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "expires_at": {}, - "created_index": {}, - "updated_index": {}, - "pay_index": { - "type": "u64", - "description": "Unique incrementing index for this payment" - }, - "amount_received_msat": { - "type": "msat", - "description": "the amount actually received (could be slightly greater than *amount_msat*, since clients may overpay)" - }, - "paid_at": { - "type": "u64", - "description": "UNIX timestamp of when it was paid" - }, - "paid_outpoint": { - "type": "object", - "description": "Outpoint this invoice was paid with", - "added": "v23.11", - "additionalProperties": false, - "required": [ - "txid", - "outnum" - ], - "properties": { - "txid": { - "added": "v23.11", - "type": "txid", - "description": "ID of the transaction that paid the invoice" - }, - "outnum": { - "added": "v23.11", - "type": "u32", - "description": "The 0-based output number of the transaction that paid the invoice" - } - } - }, - "payment_preimage": { - "type": "secret", - "description": "proof of payment" - } - } - }, - "else": { - "additionalProperties": false, - "properties": { - "label": {}, - "description": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "bolt11": {}, - "bolt12": {}, - "created_index": {}, - "updated_index": {}, - "expires_at": {} - } - } - } - ] -} diff --git a/doc/schemas/waitsendpay.request.json b/doc/schemas/waitsendpay.request.json deleted file mode 100644 index 8add51b93046..000000000000 --- a/doc/schemas/waitsendpay.request.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "payment_hash" - ], - "properties": { - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage*" - }, - "timeout": { - "type": "u32", - "description": "a timeout in seconds, for this RPC command to return. If the *timeout* is provided and the given amount of time passes without the payment definitely succeeding or definitely failing, this command returns with a 200 error code (payment still in progress). If *timeout* is not provided this call will wait indefinitely. Indicating a *timeout* of 0 effectively makes this call a pollable query of the status of the payment" - }, - "partid": { - "type": "u64", - "description": "unique ID within this (multi-part) payment. It must match that of the **sendpay** command" - }, - "groupid": { - "type": "u64", - "description": "grouping key to disambiguate multiple attempts to pay the same payment_hash" - } - } -} diff --git a/doc/schemas/waitsendpay.schema.json b/doc/schemas/waitsendpay.schema.json deleted file mode 100644 index 1bf4f08caf7f..000000000000 --- a/doc/schemas/waitsendpay.schema.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": true, - "required": [ - "id", - "created_index", - "payment_hash", - "status", - "created_at", - "amount_sent_msat" - ], - "properties": { - "created_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was created in" - }, - "id": { - "type": "u64", - "description": "old synonym for created_index" - }, - "groupid": { - "type": "u64", - "description": "Grouping key to disambiguate multiple attempts to pay an invoice or the same payment_hash" - }, - "payment_hash": { - "type": "hash", - "description": "the hash of the *payment_preimage* which will prove payment" - }, - "status": { - "type": "string", - "enum": [ - "complete" - ], - "description": "status of the payment" - }, - "amount_msat": { - "type": "msat", - "description": "The amount delivered to destination (if known)" - }, - "destination": { - "type": "pubkey", - "description": "the final destination of the payment if known" - }, - "created_at": { - "type": "u64", - "description": "the UNIX timestamp showing when this payment was initiated" - }, - "updated_index": { - "added": "v23.11", - "type": "u64", - "description": "1-based index indicating order this payment was changed (only present if it has changed since creation)" - }, - "completed_at": { - "type": "number", - "description": "the UNIX timestamp showing when this payment was completed" - }, - "amount_sent_msat": { - "type": "msat", - "description": "The amount sent" - }, - "label": { - "type": "string", - "description": "the label, if given to sendpay" - }, - "partid": { - "type": "u64", - "description": "the *partid*, if given to sendpay" - }, - "bolt11": { - "type": "string", - "description": "the bolt11 string (if pay supplied one)" - }, - "bolt12": { - "type": "string", - "description": "the bolt12 string (if supplied for pay: **experimental-offers** only)." - } - }, - "allOf": [ - { - "if": { - "properties": { - "status": { - "type": "string", - "enum": [ - "complete" - ] - } - } - }, - "then": { - "additionalProperties": false, - "required": [ - "payment_preimage" - ], - "properties": { - "id": {}, - "created_index": {}, - "updated_index": {}, - "groupid": {}, - "payment_hash": {}, - "status": {}, - "msatoshi": {}, - "amount_msat": {}, - "destination": {}, - "created_at": {}, - "completed_at": {}, - "msatoshi_sent": {}, - "amount_sent_msat": {}, - "label": {}, - "partid": {}, - "bolt11": {}, - "bolt12": {}, - "payment_preimage": { - "type": "secret", - "description": "the proof of payment: SHA256 of this **payment_hash**" - } - } - } - } - ] -} diff --git a/doc/schemas/withdraw.request.json b/doc/schemas/withdraw.request.json deleted file mode 100644 index 41311d7517f8..000000000000 --- a/doc/schemas/withdraw.request.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "additionalProperties": false, - "required": [ - "destination", - "satoshi" - ], - "properties": { - "destination": { - "type": "string", - "description": "any Bitcoin accepted type, including bech32" - }, - "satoshi": { - "type": "msat_or_all", - "description": "the amount to be withdrawn from the internal wallet (expressed, as name suggests, in satoshi). The string *all* can be used to specify withdrawal of all available funds (but if we have any anchor channels, this will always leave at least `min-emergency-msat` as change). Otherwise, it is in satoshi precision; it can be a whole number, a whole number ending in *sat*, a whole number ending in *000msat*, or a number with 1 to 8 decimal places ending in *btc*" - }, - "feerate": { - "type": "feerate", - "description": "used for the withdrawal as initial feerate. The default is *normal*" - }, - "minconf": { - "type": "u16", - "description": "minimum number of confirmations that used outputs should have. Default is 1" - }, - "utxos": { - "type": "array", - "description": "specifies the utxos to be used to be withdrawn from, as an array of `txid:vout`. These must be drawn from the node's available UTXO set", - "items": { - "type": "outpoint" - } - } - } -} diff --git a/doc/schemas/withdraw.schema.json b/doc/schemas/withdraw.schema.json deleted file mode 100644 index 3249ccf042c2..000000000000 --- a/doc/schemas/withdraw.schema.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "$schema": "http://json-schema.org/draft-07/schema#", - "type": "object", - "required": [ - "psbt", - "tx", - "txid" - ], - "properties": { - "tx": { - "type": "hex", - "description": "the fully signed bitcoin transaction" - }, - "txid": { - "type": "txid", - "description": "the transaction id of *tx*" - }, - "psbt": { - "type": "string", - "description": "the PSBT representing the unsigned transaction" - } - } -}