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>
51 lines
1.9 KiB
JSON
51 lines
1.9 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"type": "object",
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"id",
|
|
"amount"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "pubkey",
|
|
"description": "node id of the remote peer"
|
|
},
|
|
"amount": {
|
|
"type": "sat",
|
|
"description": "satoshi value that the channel will be funded at. This value MUST be accurate, otherwise the negotiated commitment transactions will not encompass the correct channel value"
|
|
},
|
|
"feerate": {
|
|
"type": "feerate",
|
|
"description": "feerate for subsequent commitment transactions: see **fundchannel**. Note that this is ignored for channels with *option_anchors_zero_fee_htlc_tx* (we always use a low commitment fee for these)"
|
|
},
|
|
"announce": {
|
|
"type": "boolean",
|
|
"description": "whether or not to announce this channel"
|
|
},
|
|
"close_to": {
|
|
"type": "string",
|
|
"description": "bitcoin address to which the channel funds should be sent to on close. Only valid if both peers have negotiated `option_upfront_shutdown_script`. Returns `close_to` set to closing script iff is negotiated"
|
|
},
|
|
"push_msat": {
|
|
"type": "msat",
|
|
"description": "amount of millisatoshis to push to the channel peer at open. Note that this is a gift to the peer -- these satoshis are added to the initial balance of the peer at channel start and are largely unrecoverable once pushed"
|
|
},
|
|
"mindepth": {
|
|
"type": "u32",
|
|
"description": "Number of confirmations required before we consider the channel active"
|
|
},
|
|
"reserve": {
|
|
"type": "msat",
|
|
"description": "The amount we want the peer to maintain on its side"
|
|
},
|
|
"channel_type": {
|
|
"type": "array",
|
|
"description": "Each bit set in this channel_type",
|
|
"items": {
|
|
"type": "u32",
|
|
"description": "Bit number"
|
|
}
|
|
}
|
|
}
|
|
}
|