core-lightning/doc/schemas/lightning-askrene-update-channel.json
Rusty Russell c307b77d2f askrene: split askrene-create-channel into create-channel and update-channel.
This allows for explicit partial updates to channels (e.g. just change
fees, or just disable) without haveing to set the other fields.

This generalizes askrene-disable-channel, which is removed.

We also take the chance to use the proper BOLT 7 terms in the API:

- htlc_minimum_msat
- htlc_maximum_msat
- cltv_expiry_delta
- fee_base_msat
- fee_proportional_millionths

Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-10-04 11:27:53 +09:30

77 lines
1.9 KiB
JSON

{
"$schema": "../rpc-schema-draft.json",
"type": "object",
"additionalProperties": false,
"rpc": "askrene-update-channel",
"title": "Command to manipulate channel in a layer (EXPERIMENTAL)",
"description": [
"WARNING: experimental, so API may change.",
"",
"The **askrene-update-channel** RPC command overrides updates for an existing channel when the layer is applied."
],
"request": {
"required": [
"layer",
"short_channel_id_dir"
],
"properties": {
"layer": {
"type": "string",
"description": [
"The name of the layer to apply this change to."
]
},
"short_channel_id_dir": {
"type": "short_channel_id_dir",
"description": [
"The channel and direction to apply the change to."
]
},
"htlc_min": {
"type": "msat",
"description": [
"The minimum value allowed in this direction."
]
},
"htlc_max": {
"type": "msat",
"description": [
"The maximum value allowed in this direction."
]
},
"base_fee": {
"type": "msat",
"description": [
"The base fee to apply to use the channel in this direction."
]
},
"proportional_fee": {
"type": "u32",
"description": [
"The proportional fee (in parts per million) to apply to use the channel in this direction."
]
},
"cltv_expiry_delta": {
"type": "u16",
"description": [
"The CLTV delay required for this direction."
]
}
}
},
"response": {
"required": [],
"properties": {}
},
"see_also": [
"lightning-getroutes(7)",
"lightning-askrene-create-channel(7)"
],
"author": [
"Rusty Russell <<rusty@rustcorp.com.au>> is mainly responsible."
],
"resources": [
"Main web site: <https://github.com/ElementsProject/lightning>"
]
}