mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-02-21 22:31:48 +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>
79 lines
2.6 KiB
JSON
79 lines
2.6 KiB
JSON
{
|
|
"$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'"
|
|
}
|
|
}
|
|
}
|