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>
34 lines
1.4 KiB
JSON
34 lines
1.4 KiB
JSON
{
|
|
"$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"
|
|
}
|
|
}
|
|
}
|
|
}
|