mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 14:24:09 +01:00
d7cc1e4a17
Added descriptions for rpc command parameters This also performs the following fixes: 1. delforward parameters are compulsory (required). 2. disableinvoicerequest request added `added` field. 3. invoice request order fixed (label then description, not vice-versa!). 4. listpeers log levels are a proper enum 5. description parameter documented for sendonion requests. 6. deprecatred amount_msat removed from sendpay request. 7. sendpay request partid type fixed to u64 (was u16!) 8. sendpay request localinvreqid type tightened to hash (was hex) 9. sendpay request payment_metadata and description fields documented. 10. sendpsbt request reserve type fixed to u32 (was boolean) 11. utxopsbt request satoshi type fixed to msat_or_all (was msat) 12. withdraw request parameter satoshi is compulsory (required) 13. fundchannel_start request amount is sat, not msat_or_all. 14. openchannel_init request amount is sat, not msat 15. openchannel_init close_to is a string, not hex. 16: invoice labels can be strings OR numbers. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
42 lines
1.7 KiB
JSON
42 lines
1.7 KiB
JSON
{
|
|
"$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"
|
|
}
|
|
}
|
|
}
|