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>
57 lines
2.1 KiB
JSON
57 lines
2.1 KiB
JSON
{
|
|
"$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"
|
|
}
|
|
}
|
|
}
|