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>
32 lines
1.1 KiB
JSON
32 lines
1.1 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"channel_id",
|
|
"relative_amount"
|
|
],
|
|
"added": "v23.08",
|
|
"properties": {
|
|
"channel_id": {
|
|
"type": "string",
|
|
"description": "the channel id of the channel to be spliced"
|
|
},
|
|
"relative_amount": {
|
|
"type": "integer",
|
|
"description": "a positive or negative amount of satoshis to add or subtract from the channel"
|
|
},
|
|
"initialpsbt": {
|
|
"type": "string",
|
|
"description": "the (optional) base 64 encoded PSBT to begin with. If not specified, one will be generated automatically"
|
|
},
|
|
"feerate_per_kw": {
|
|
"type": "u32",
|
|
"description": "the miner fee we promise our peer to pay for our side of the splice transaction. It is calculated by `feerate_per_kw` * our_bytes_in_splice_tx / 1000"
|
|
},
|
|
"force_feerate": {
|
|
"type": "boolean",
|
|
"description": "by default splices will fail if the fee provided looks too high. This is to protect against accidentally setting your fee higher than intended. Set `force_feerate` to true to skip this saftey check"
|
|
}
|
|
}
|
|
}
|