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>
45 lines
1.5 KiB
JSON
45 lines
1.5 KiB
JSON
{
|
|
"$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"
|
|
}
|
|
}
|
|
}
|